Installing IMSWorkX Intelligent Call Routing

This section explains how to install IMSWorkX Intelligent Call Routing (ICR) using the XpressWorkX TM Application Manager.

Before installing ICR you will need the following:

Download ICR

  1. Access the Customer Portal.

  2. Log in with your Username and Password.

  3. Click Software Downloads on the portal’s main menu.

  4. Locate the application package imsworkx-icr-installer-x.x-x.noarch.rpm in the software list.

  5. Click the link to download the file.

Install ICR Using the Application Manager

  1. Log in as root on the primary NIU.

  2. Copy the downloaded RPM to the primary NIU.

  3. Run the following command to install the ICR installer.

    yum install imsworkx-icr-x.x-x.noarch.rpm

  4. Use the following command to install the ICR application.

    xpressworkx_app_manager install icr x.x-x

Where x.x-x is the version of ICR to be installed. There will be output showing on the screen as ICR is installed, and any errors will be clearly indicated.

Configuration

On each AS, update the JVM server classpath in ps_master_config under /usr/sipxpress/config to include all of the ICR Java dependencies.

<ps-jvm>
        <ps-jvm
class-path="/usr/sipxpress/jars/pt-mutables.jar:/usr/sipxpress/jars/icr/gson-2.3.1.jar:/usr/sipxpress/jars/icr/icr-core.jar:/usr/sipxpress/jars/icr/icr-xtml.jar:/usr/sipxpress/jars/icr/libphonenumber-6.2.jar:/usr/sipxpress/jars/icr/postgresql-9.3-1102.jdbc4.jar:/usr/sipxpress/config"
        jvm-start-size="-Xms16m"
        jvm-max-size="-Xmx32m"
        num-threads="9" />
</ps-jvm>

Additional Configuration

In addition to the basic configuration above, the following can be configured for more customized offerings.

Email Configuration

The following properties when appropriately configured on both NIU in a network cluster will allow ICR to automatically send email messages for the following:

  • Password Recovery

  • Error Reports

ADMIN_EMAIL is the email address that email messages are sent from. It is also the email address that receives error reports when they are generated.

EMAIL_HOST is the SMTP host to send through.

EMAIL_HOST_USER and EMAIL_HOST_PASSWORD are the user name and password used to authenticate the SMTP server.

EMAIL_PORT is the port to use. This can be specific to a host.

EMAIL_USE_TLS is a true or false flag to use TLS encryption. Generally, this should always be true.

com.imsworkx.icr.web.ADMIN_EMAIL=webmaster@example.com
com.imsworkx.icr.web.EMAIL_HOST=smtp.example.com
com.imsworkx.icr.web.EMAIL_HOST_USER=webmaster@example.com
com.imsworkx.icr.web.EMAIL_HOST_PASSWORD=%change-me%
com.imsworkx.icr.web.EMAIL_PORT=587
com.imsworkx.icr.web.EMAIL_USE_TLS=True

CDR Configuration

ICR uses the DROP_CDRs property to indicate how often to clear out Call Detail Records (CDRs). The default is to keep CDRs for 7 days. This value can be changed on both NIU in a network cluster to hold these records longer so they can be archived or shorter to keep more space available.

com.imsworkx.ecf.DROP_CDRS_AFTER_DAYS=7

Call Routing Prefix

Especially useful for billing purposes, ICR has the ability to specify the routing prefix in the CALL_FLOW.ROUTING_PREFIX property. To use this property, the property will need to be uncommented on each AS.

For example, if 8005441234 routes to 5854555512 and there is a routing prefix of 1123, then the returned number will be 11235854555512.

com.imsworkx.icr.CALL_FLOW.ROUTING_PREFIX=1123

Starting ICR

To launch ICR automatically on startup, add the following to the <ps-appexec> section of the ps_master_config on each AS:

<application sessions="nnn" iterations="0">icr.xml</application>
<application sessions="nnn" iterations="0">icr_in.xml</application>

Where nnn is the number of simultaneous sessions of ICR to launch.

Now, you can start provisioning routing rules and call plans.

If ICR is not configured to automatically launch on startup, follow these steps to launch ICR using the Console:

  1. Launch Console.

  2. Add Platform Services Host.

  3. Right-click Applications in the Object panel.

  4. Select Start Application from the menu.

  5. Select the required application from the Application Name list.

  6. Enter the number of sessions that you want to run.

  7. Click OK.

For more information on starting and stopping an application through the Console, see Working with Applications.