This section explains how to install Evolve ® TCAP Forwarding service. TCAP Forwarding can be installed online or offline.
If you have connectivity to the Internet or a Linux repository, follow the instructions in Install TCAP Forwarding Using the Application Manager.
Otherwise, follow the instructions in Install TCAP Forwarding with No Internet Access.
Access the Customer Portal.
Log in with your User Name and Password.
Click Software Downloads on the portal’s main menu.
Locate the application package imsworkx-tcap-forwarding-installer-x.x.x-x.noarch.rpm in the software list.
Click the link to download the file.
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.
Note
You may need to enable the centos-release-ansible repo to find a required version of Ansible.
Log in as root on the primary NIU.
Copy the downloaded RPM to the primary NIU.
Run the following command to install the TCAP Forwarding installer.
yum install imsworkx-tcap-forwarding-installer-x.x.x-x.noarch.rpm
Use the following command to install the TCAP Forwarding application.
xpressworkx_app_manager install tcap-forwarding x.x-x
Where x.x-x is the version of TCAP Forwarding to be installed. There will be output showing on the screen as TCAP Forwarding is installed, and any errors will be clearly indicated.
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.
Log in as root on the primary NIU.
Copy the downloaded RPM to the primary NIU.
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
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
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
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
Ensure all dependencies are installed on each NIU and AS. See the Knowledge Base for the full list of dependencies.
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
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
Run the following command to install the TCAP Forwarding installer.
yum install imsworkx-tcap-forwarding-installer-x.x.x-x.noarch.rpm
Use the following command to install the TCAP Forwarding application.
xpressworkx_app_manager install tcap-forwarding x.x-x
Where x.x-x is the version of TCAP Forwarding to be installed. There will be output showing on the screen as TCAP Forwarding is installed, and any errors will be clearly indicated.
The following configuration needs to be added to the JVM server classpath section of ps_master_config.
<ps-jvm>
<ps-jvm
class-path="/usr/sipxpress/jars/pt-mutables.jar::/usr/sipxpress/jars/tcap-forwarding.jar"
jvm-start-size="-Xms16m"
jvm-max-size="-Xmx32m"
num-threads="9" />
</ps-jvm>
To launch TCAP Forwarding 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">tcap_forwarding.xml</application>
</ps-appexec>
Where nnn is the number of simultaneous sessions of TCAP Forwarding to launch.
Now, you can start provisioning routing rules and calling plans.
If TCAP Forwarding is not configured to automatically launch on startup, follow these steps to launch TCAP Forwarding using the Console:
Launch Console.
Add Platform Services Host.
Right-click Applications in the Object panel.
Select Start Application from the menu.
Select the required application from the Application Name list.
Enter the number of sessions that you want to run.
Click OK.
For more information on starting and stopping an application through the Console, see Working with Applications.
When uninstalling TCAP Forwarding, you can either maintain or purge the database.
To uninstall and maintain the TCAP Forwarding database:
Log in as root on the primary NIU.
Run the following command to uninstall the TCAP Forwarding application.
xpressworkx_app_manager uninstall tcap-forwarding
To uninstall and purge the TCAP Forwarding database:
Log in as root on the primary NIU.
Run the following command to uninstall the TCAP Forwarding application.
xpressworkx_app_manager purge tcap-forwarding
Warning
Using the purge command will remove everything of TCAP Forwarding from the system, including the database.
Updating TCAP Forwarding is as simple as installing TCAP Forwarding with the new version. This update should be performed at a time when call traffic is minimal or during a maintenance window.
To gracefully restart TCAP Forwarding on an AS, complete the following steps:
Stop an Application
In Console, right-click the application Object panel and select Stop.
Select the Stop Application Gracefully check box to allow each running session to complete its current iteration.
Click Yes.
Start an Application
Right-click Applications in the Object panel.
Select Start Application from the menu.
Select the required application from the Application Name list.
Tip
The application must reside in the apps subdirectory of the /usr/sipxpress/apps directory or in one of the repositories specified in the Current Repositories window (see Setting Up Application Repositories).
Enter the number of sessions that you want to run.
If you want to generate a trace file, select the associated check box. The trace file is logged to the /usr/sipxpress/logs directory.
In the Stopping Instructions section, specify whether the application should run until it is manually stopped or for a specified number of iterations.
Click OK.
Tip
To verify that an application has started and successfully completed, select the service host on the Object panel, expand the Logs folder, and select PS_SysLog.txt.
For more information on starting and stopping an application through the Console, see Working with Applications.