Installing Evolve Call Intercept¶

Download CIN¶

1. Access the Customer Portal.

2. Log in with your User Name and Password.

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

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

5. Click the link to download the file.

Pre-Installation Checklist¶

• The xpressworkx-platform and audio files have been installed on each machine.

• Application Manager 1.4 or greater has been installed on both NIUs.

• The NIU hostname needs to be resolvable on the machines within the cluster.

• Ensure that the password-less SSH works from the NIUs to all AS machines.

• Ensure Ansible (any version 2.4 through 2.8) is installed on each NIU. Once Ansible is installed, you will want to “pin” the version.

Install CIN Using the Application Manager¶

1. Log in as root on the primary NIU.

2. Copy the downloaded file to the primary NIU.

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

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

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

   xpressworkx_app_manager install cin x.x-x

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

Installing CIN with no Internet Access¶

The Ansible tasks will try to go out to the Internet to find and install the necessary RPM dependencies and Python dependencies. The Python dependencies need to be installed using PIP.

1. Log in as root on the primary NIU.

2. Copy the downloaded RPM to the primary NIU.

3. Since application installation procedures run over SSH, configure the SSH daemon with the required PIP environment variables. To do this, run the following commands on each machine in the cluster.

echo AcceptEnv PIP_FIND_LINKS >> /etc/ssh/sshd_config
echo AcceptEnv PIP_NO_INDEX >> /etc/ssh/sshd_config
service sshd restart

4. Configure Ansible to install dependencies from the disk instead of the Internet using environment variables. To do this, run the following commands on each machine in the cluster.

export PIP_FIND_LINKS=/root/python_dependencies
export PIP_NO_INDEX=true
export ANSIBLE_SSH_ARGS="-C -o ControlMaster=auto -o ControlPersist=60s -o SendEnv=PIP_FIND_LINKS -o SendEnv=PIP_NO_INDEX"
source ~/.bashrc

5. Optional. This step will change the overall behavior of Python and may help improve the speed of the installation. Add the following to /etc/hosts on each machine in the cluster in order to block (with immediate errors) unreachable repositories:

127.0.1.1   yum.postgresql.org pypi.python.org

6. Optional. This step will change the overall behavior of Python and may help improve the speed of the installation. Add the disabled repository setting to /etc/yum.conf on each machine in the cluster:

[postgres]
enabled=0

7. Ensure all dependencies are installed on each NIU and AS. See the Knowledge Base for the full list of dependencies.

8. Python dependencies can be downloaded from the Python Package Index. When downloading the dependencies, be sure to download the exact version specified if a version is provided. Otherwise, download the latest version supporting Python 2.7 for CentOS/RHEL 7 machines. To easily gather the dependencies, create a text file with a list of the following Python dependencies and name it requirements.txt.

   • MarkupSafe

   • Jinja2

   • psycopg2

   • importlib

   • Django==1.6

   • WebOb

   • chardet

9. Place all of the downloaded Python dependencies in the following directory on the primary NIU using the requirements.txt file that you created.

`/root/python_dependencies`
pip download -r requirements.txt

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

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

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

   xpressworkx_app_manager install cin x.x-x

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

Network Interface Unit (NIU) Configuration¶

Upon installation, the following jobs are added to the crontab:

• xpressworkx-cdr-partition cin

• xpressworkx-cdr-synchronize cin

• xpressworkx-cdr-cleanup-database cin

• restworkx-cin clean

• cin-clear-expired-jobs

<process name="xpressworkx_web_services"
        run-offline="1"
        stop-script="/usr/sipxpress/bin/stop_web_services" />

<process name="xpressworkx_data_services"
        run-offline="1"
        run-as="postgres"
        wait-to-start="120"
        stop-script="/usr/sipxpress/bin/stop_data_services"
        offline-script="/usr/sipxpress/bin/offline_data_services"
        online-script="/usr/sipxpress/bin/online_data_services"
        notify-cluster-changes="1" />

xpressworkx-cdr-partition cin

xpressworkx-cdr-synchronize cin

Application Processing Server (AS) Configuration¶

<process name="xpressworkx_cdr_services"
        control-queue="xpressworkx_cdr_services" />

<ps-jvm>
        <ps-jvm
class-path="/usr/sipxpress/jars/pt-mutables.jar::/usr/sipxpress/jars/cin-interface.jar"
        jvm-start-size="-Xms16m"
        jvm-max-size="-Xmx32m"
        num-threads="9" />
</ps-jvm>

Configuring Syslog¶

It is recommended to complete this procedure to configure syslog to listen for both Transmission Control Protocol (TCP) and User Datagram Protocol (UDP) messages. These steps should be performed on every NIU and AS.

1. Uncomment the following lines in the /etc/rsyslog.conf file. By default, these lines are typically found under the MODULES section of the file. If the lines are not already present, they will need to be added.

# Provides UDP syslog reception
$ModLoad imudp
$UDPServerRun 514

# Provides TCP syslog reception
$ModLoad imtcp
$InputTCPServerRun 514

2. Run the service rsyslog restart command to restart rsyslog and apply the changes.

Configuring SSL¶

These steps are required to use secure communications via the web UI and/or API with the application. Our SSL implementation uses TLS with certificate exchange.

1. Add the private key to the configuration on both NIUs. Edit the /root/xpressworkx-ssl-vars and add the following:

CERTIFICATE_FILE=/root/easy-rsa/pki/issued/<hostname>.crt
KEY_FILE=/root/easy-rsa/pki/private/<hostname>.key
CA_FILE=/root/easy-rsa/pki/ca.crt
HOSTNAME=<hostname>

2. Run the configure-ssl command on both NIUs.

Running this command will stop and restart the HTTP server (httpd), which will briefly affect any system traffic. Also, this command will start a test process (test-httpd) which will check that the configured certificates are working at a basic level.

After running this command, further modifications to HTTP configuration should be made only if instructed to do so by Customer Support.

Starting CIN¶

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

<ps-appexec>
<application sessions="nnn" iterations="0">cin.xml</application>
</ps-appexec>

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

Now, you can start provisioning screening rules.

If CIN is not configured to automatically launch on startup, follow these steps to launch CIN 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.

Uninstalling CIN¶

When uninstalling CIN, you can either maintain or purge the database.

To uninstall and maintain the CIN database:

1. Log in as root on the primary NIU.

2. Run the following command to uninstall the CIN application.

   xpressworkx_app_manager uninstall cin

To uninstall and purge the CIN database:

1. Log in as root on the primary NIU.

2. Run the following command to uninstall the CIN application.

   xpressworkx_app_manager purge cin

Updating CIN¶

Updating CIN is as simple as installing CIN with the new version. This update should be performed at a time when call traffic is minimal or during a maintenance window.

Restarting CIN¶

To gracefully restart CIN on an AS, complete the following steps:

Stop an Application

1. In Console, right-click the application in the Object panel and select Stop.

2. Select the Stop Application Gracefully check box to allow each running session to complete its current iteration.

3. Click Yes.

Start an Application

1. Right-click Applications in the Object panel.

2. Select Start Application from the menu.

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

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

5. If you want to generate a trace file, select the associated check box. The trace file is logged to the /usr/sipxpress/logs directory.

6. In the Stopping Instructions section, specify whether the application should run until it is manually stopped or for a specified number of iterations.

7. Click OK.

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

SELinux¶

Security-Enhanced Linux (SELinux) is a security architecture for Linux systems that defines access controls for applications, processes, and files.

For this application, SELinux uses the default targeted policy installed by enterprise Linux packages. The policy is a set of rules that enforces what can or cannot be accessed.

SELinux is supported in enforcing, permissive, or disabled mode, and the current mode is checked during an install.

Contact Customer Support if you want to change the SELinux mode after an application has been installed. The installer may need to be run again to ensure permissions and contexts are correct.

For more configuration information, see the SELinux User’s and Administrator’s Guide.