TrueCall Server

Installation and Upgrade Guide

T r u e C a lIn s ta la tio n a n d Up g r a d e Gu id e

Software Version 6.3.0

Rev. 001 / 2020-03-31

Mobile Access

© NETSCOUT CONFIDENTIAL & PROPRIETARY

 Use of this product is subject to the End User License Agreement available at http://www.NetScout.com/legal/terms-and-
conditions or which accompanies the product at the time of shipment or, if applicable, the legal agreement executed by and
between NetScout Systems, Inc. or one of its wholly-owned subsidiaries ("NETSCOUT") and the purchaser of this product
("Agreement").

Government Use and Notice of Restricted Rights: In U.S. government ("Government") contracts or subcontracts, Customer will
provide that the Products and Documentation, including any technical data (collectively "Materials"), sold or delivered pursuant
to this Agreement for Government use are commercial as defined in Federal Acquisition Regulation ("FAR") 2.101and any
supplement and further are provided with RESTRICTED RIGHTS. All Materials were fully developed at private expense. Use,
duplication, release, modification, transfer, or disclosure ("Use") of the Materials is restricted by the terms of this Agreement and
further restricted in accordance with FAR 52.227-14 for civilian Government agency purposes and 252.227-7015 of the Defense
Federal Acquisition Regulations Supplement ("DFARS") for military Government agency purposes, or the similar acquisition
regulations of other applicable Government organizations, as applicable and amended. The Use of Materials is restricted by the
terms of this Agreement, and, in accordance with DFARS Section 227.7202 and FAR Section 12.212, is further restricted in
accordance with the terms of NETSCOUT'S commercial End User License Agreement. All other Use is prohibited, except as
described herein.

This Product may contain third-party technology. NETSCOUT may license such third-party technology and documentation ("Third-
Party Materials") for use with the Product only. In the event the Product contains Third-Party Materials, or in the event you have
the option to use the Product in conjunction with Third-Party Materials (as identified by NETSCOUT in the Documentation
provided with this Product), then such third-party materials are provided or accessible subject to the applicable third-party terms
and conditions contained either in the "Read Me" or "About" file located in the Software or on an Application CD provided with
this Product, or in an appendix located in the documentation provided with this Product. To the extent the Product includes
Third-Party Materials licensed to NETSCOUT by third parties, those third parties are third-party beneficiaries of, and may enforce,
the applicable provisions of such third-party terms and conditions.

Open-Source Software Acknowledgement: This product may incorporate open-source components that are governed by the GNU
General Public License ("GPL") or licenses that are compatible with the GPL license ("GPL Compatible License"). In accordance
with the terms of the GNU GPL, NETSCOUT will make available a complete, machine-readable copy of the source code
components of this product covered by the GPL or applicable GPL Compatible License, if any, upon receipt of a written request.
Please identify the product and send a request to:

NETSCOUT SYSTEMS, INC

GNU GPL Source Code Request

310 Littleton Road
Westford, MA 01886
Attn: Legal Department

TrueCall Installation and Upgrade Guide 2

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31
992-0638-08 Rev. 001

To the extent applicable, the following information is provided for FCC compliance of Class A devices:

This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15 of the
FCC rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is
operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy and, if not
installed and used in accordance with the instruction manual, may cause harmful interference to radio communications.
Operation of this equipment in a residential area is likely to cause harmful interference, in which case users will be required
to correct the interference at their own expense.

Modifications to this product not authorized by NETSCOUT could void the FCC approval and terminate your authority to
operate the product. Please also see NETSCOUT's Compliance and Safety Warnings for NetScout Hardware Products
document, which can be found in the documents accompanying the equipment, or in the event such document is not
included with the product, please see the compliance and safety warning section of the user guides and installation
manuals.

No portion of this document may be copied, photocopied, reproduced, translated, or reduced to any electronic medium or
machine form without prior consent in writing from NETSCOUT. The information in this document is subject to change without
notice and does not represent a commitment on the part of NETSCOUT.

The products and specifications, configurations, and other technical information regarding the products described or referenced
in this document are subject to change without notice and NETSCOUT reserves the right, at its sole discretion, to make changes at
any time in its technical information, specifications, service, and support programs. All statements, technical information, and
recommendations contained in this document are believed to be accurate and reliable but are presented "as is" without
warranty of any kind, express or implied. You must take full responsibility for their application of any products specified in this
document. NETSCOUT makes no implied warranties of merchantability or fitness for a purpose as a result of this document or
the information described or referenced within, and all other warranties, express or implied, are excluded.

Except where otherwise indicated, the information contained in this document represents the planned capabilities and intended
functionality offered by the product and version number identified on the front of this document. Screen images depicted in this
document are representative and intended to serve as example images only.

Copyright NETSCOUT 2009-2020. All rights reserved.

992-0638-08-001

200331

TrueCall Installation and Upgrade Guide 3

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 Table of Contents
T r u e C a lIn s ta la tio n a n d Up g r a d e Gu id e 1

T a b le o fC o n te n ts 4

What’s New 7
Revision History 8
1 Purpose 9
2 Installation Prerequisites 11
2.1 Linux Operating System and Software Packages 11
2.2 Administrative Privileges 11
2.3 Upgrade Prerequisites 11
3 Preparing to Install or Upgrade 12
3.1 TrueCall Software Packages 12
3.2 Intended TrueCall Use 12
4 Installing TrueCall (New Installation) 13
4.1 TrueCall Server Installation 13
4.2 GSR Services Installation 13
4.3 Run the Post-Installation Configuration Script 14
4.4 Configuration 14
4.4.1 TrueCall Server Component Configuration 14
4.4.2 TrueCall COMMON Vendor List Configuration 17
4.4.3 TrueCall PLMNID Configuration for LTE 18
4.4.4 TrueCall Server Administration Installation 19
4.4.5 TrueCall Cylinder Cleanup 21
4.4.6 Enabling the cylinder-optimize.sh Script 21
4.4.7 Configure Cron Jobs 21
4.4.8 Enable TrueCall Service to Start on Boot 22
4.5 Next Steps 22
5 Upgrading TrueCall from the Previous Version 23
5.1 Known Changes When Upgrading from a Previous Version 23
5.1.1 Installation Changes 23

TrueCall Installation and Upgrade Guide 4

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31
992-0638-08 Rev. 001

5.1.2 Changes to Geolocation Algorithms 24

5.1.3 Changes for Cylinder Performance Improvements 24
5.1.4 Changes to Required Libraries 25
5.1.5 LSR Changes 25
5.1.6 Change to Overshooting Cells 25
5.1.7 S6A/Diameter End of Support 26
5.1.8 Changes to MDT 26
5.1.9 Changes to Log File Rotation 26
5.1.10 Verify Crontab Entries for Daily Bookmarks 27
5.1.11 Reset WebClient Password 27
5.1.12 Changes to PLP 27
5.1.13 Changes to the Upgrade Procedure 27
5.1.14 Changes Related to nGenius Configuration Manager Integration 28
5.2 Backup Existing Configuration Files and TrueCall PostgreSQL Database 29
5.2.1 TrueCall crontab 29
5.2.2 TrueCall Configuration Files 29
5.2.3 TrueCall PostgreSQL Database 30
5.3 Upgrade TrueCall and GSRservices 30
5.4 Update Geolocation Configuration for Common LTE 31
5.5 Update Configuration Files After Upgrade 31
5.6 Next Steps 31
6 TrueCall Process and Log File Verification 32
6.1 TrueCall PID Stability Verification 32
6.2 TrueCall Log File Verification 32
6.3 Accessing the TrueCall Task Help Content 33
6.4 TrueCall Web Admin Console Verification 33
7 Appendix A: Default Port Information 34
8 Appendix B: Additional Documentation 36
9 Appendix C: Network Element Table Naming Conventions 37
9.1 Considerations 37
9.2 Input Format 37
9.3 Input Filename 37
10 Appendix D: Handset Database Naming Convention 39
10.1 Input Format 39
10.2 Input Filename 39
11 Appendix E: Migrating to the COMMON Vendor Technology 40
11.1 Migration to COMMON Caveats 40

TrueCall Installation and Upgrade Guide 5

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31
992-0638-08 Rev. 001

11.2 Migration to COMMON Process 41

12 Appendix F: Configuring a Multi Instance Query Server (MIQS) 43
12.1 Configuring Two Databases 44
12.2 Accessing the TrueCall Client and Web Admin Interfaces 44
12.3 Configuring MIQS Cron Jobs 44
12.4 Using Daily Reports 45
12.5 Ports 45
13 Configuring nGenius Configuration Manager 46
13.1 Architecture 46
13.2 System Prerequisites 46
13.3 Customer Prerequisites 47
13.4 LDAP Prerequisites (Optional) 47
13.5 Install nGeniusONE and TrueCall 48
13.6 Configuring the nGenius Configuration Manager Upload Server 48
13.7 Converting a Standby to a Primary Server 51
13.8 Configuring Users in nGenius Configuration Manager 51
13.8.1 Configure Users in nGenius Configuration Manager Manually 51
13.8.2 Transition Users to nGenius Configuration Manager 52
13.8.3 Transitioning LDAP Users 58
13.9 Configure TrueCall Components 61
13.9.1 Configure the Daily Report Email 64
13.9.2 Configuration for Dual Stack Networks 65
13.10 Register User Groups with the Query Server 66
13.11 Configuring Subscription Delivery Services 67

TrueCall Installation and Upgrade Guide 6

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 What’s New
TrueCall Server 6.3.0 enhancements include the following features.

Feature Description Section

ID/JIRA
F-10316 OI: TrueCall Change Default Configurations Changes to Geolocation
This feature enables RSM as the default geolocation algorithm for Algorithms
LTE and 5G implementations.
F-10357 OI: Add licensing ability to TrueCall
This feature adds cell-based license options for ISNG RAN enabled
TrueCall when implemented with nGenius Configuration Manager.
Refer to the Radio Access System Compliance Document for more
information.
F-10376 OI: Performance Improvements Changes for Cylinder
This feature adds performance improvements to the Cylinder and the Performance
Query Server Improvements

TrueCall Installation and Upgrade Guide 7

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 Revision History
The revision history shows the documentation updates for this release. These updates include new
features and changes to existing features. They also include changes resulting from documentation
requests and issues.

Date Revision Reference Summary

20/03/31 001 Initial version.

TrueCall Installation and Upgrade Guide 8

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 1 Purpose
The purpose of this document is to provide installation instructions or upgrade instructions for the
common core features required for a TrueCall server to display call records in the TrueCall client
application.

The common core components required for a TrueCall system to be able to visualize the customer’s
network are TrueCall Web Admin Console, ETL, Cylinder, TcsTcpServer, Handset Database Auto-
Upload, and Network Element Table Auto-Upload.

Refer to the TrueCall Configuration Guide, Version 6.3.0 for procedures for configuring optional
features.

l Location Session Record (LSR)

l Precision Location Platform (PLP)
l RAN AI Network Auditor
l LDAP
l Market QAMS (Multi-Server Query)
l Road Aware
l Overshooting Cells
l Handset Downloader
l Iris Session Analyzer (ISA) Drilldown
l nGenius Session Analyzer Drilldown
l Call Stitching
l Call Event Geolocation (Breadcrumbing)
l Filtered Geolocation
l Ring Search Method (RSM) Geolocation
l Minimization of Drive Test (MDT)
l IPv6
l Emailed KPI Reports
l TrueCall Server Emails
l SSL TLS
l Emergency Service Indicator (Emergency ARP)
l Pilot Pollution
l Dropped Connection Rate

TrueCall Installation and Upgrade Guide 9

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 1  Purpose
992-0638-08 Rev. 001

l NB-IoT Calls
l 5G Calls

Refer to the Radio Access System Compliance Document for information on which data versions
are supported per vendor technology.

TrueCall Installation and Upgrade Guide 10

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 2 Installation Prerequisites
The following prerequisites must be met prior to installing or upgrading the TrueCall application.
Refer to the section that applies to the task being performed.

2.1 Linux Operating System and Software Packages

The supported Linux operating system is installed with all required software packages and the
storage device for the TrueCall file system is mounted and formatted with the correct file system.
Reference the TrueCall Linux OS Installation Guide 6.3.0 for specific details.

2.2 Administrative Privileges

The user performing the TrueCall installation can log in as the user “root” or be granted “sudo”
permissions to access root privileges.

2.3 Upgrade Prerequisites

In order to upgrade to 6.3.0, the existing TrueCall version must be at 17.3 or higher.

Note: If the current version is earlier than 17.3, upgrade the software to 17.3 using the TrueCall
Installation and Upgrade Guide, Version 17.3 before proceeding with the upgrade instructions
outlined in this document.

Run the following command to determine the version of the existing TrueCall installation:
rpm -q truecall-server

The output should include one of the following version numbers:

truecall-server-17.3.0.X-X.x86_64
truecall-server-17.4.0.X-X.x86_64
truecall-server-17.6.2.0.X-X.86_64
truecall-server-17.6.2.1.X-X.86_64
truecall-server-17.6.2.2.X-X.86_64

TrueCall Installation and Upgrade Guide 11

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 3 Preparing to Install or Upgrade
3.1 TrueCall Software Packages
The user performing the TrueCall installation has downloaded the software packages required to
install the TrueCall application. NETSCOUT employees will download the software packages from the
internal repository. Customers will be provided the software packages by their NETSCOUT
representative. The packages listed below are required for the TrueCall installation.

The software package for TrueCall 6.3.0 begins with TrueCall-Server-6.3.0.

l GSRservices-V17.6.3.0.XX-0_el7.x86_64.rpm
l TrueCall-Server-6.3.0.X-X-gef929c5-el7-x86_64.rpm

Note: Replace XX and X-X with the correct version required for the deployment.

3.2 Intended TrueCall Use

The user performing the TrueCall installation will configure the TrueCall application after it is
installed. To configure the application correctly, the user must already know which TrueCall
components will reside on each TrueCall application server being deployed. The distribution of
TrueCall components should have been documented in the pre-deployment phase and the project
manager should have provided the information to the user performing the TrueCall installation.

TrueCall Installation and Upgrade Guide 12

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 4 Installing TrueCall (New Installation)
This section only applies if a new installation of TrueCall is being performed, i.e. installing the TrueCall
software on server that has never had the TrueCall software installed. If a TrueCall upgrade is being
performed, refer to Upgrading TrueCall from the Previous Version.

The instructions below assume the current working directory is the directory where the software
packages were placed on the TrueCall server.

It is important to install TrueCall and GSR in the order presented in this section. Install the TrueCall
server first, then install GSR services.

4.1 TrueCall Server Installation

Install the TrueCall Server package by running the command below.

Note: Replace x-x with the correct version required for the deployment.

As user “root”:
rpm -ivh TrueCall-Server-6.3.0.X-X-gef929c5-el7-x86_64.rpm

Using sudo permissions:

sudo rpm -ivh TrueCall-Server-6.3.0.X-X-gef929c5-el7-x86_64.rpm

4.2 GSR Services Installation

Note: If the TrueCall components are to be installed on separate servers, GSR Services should
only be installed on the TrueCall server where the TcsTcpServer component will reside.

Install the GSR Services package by running the command below.

As user “root”:
rpm -ivh GSRservices-V17.6.3.0.XX-0_el7.x86_64.rpm

Using sudo permissions:

sudo rpm -ivh GSRservices-V17.6.3.0.XX-0_el7.x86_64.rpm

Where XX is the version for the deployment.

TrueCall Installation and Upgrade Guide 13

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 4  Installing TrueCall (New Installation)
992-0638-08 Rev. 001

4.3 Run the Post-Installation Configuration Script

Run the post-installation configuration script.

As user “root”:
/opt/tc3/bin/conf-truecall.sh

Using sudo permissions:

sudo /opt/tc3/bin/conf-truecall.sh

4.4 Configuration
The TrueCall server will need to be configured for the intended use. This install guide only covers the
configuration of the common core components that are required for the TrueCall application to
display call records in the TrueCall client application.

The common core components required for a TrueCall system to be able to visualize the customer’s
network are TrueCall Web Admin Console, ETL, Cylinder, TcsTcpServer, Handset Database Auto-
Upload, and Network Element Table Auto-Upload.

Note: Refer to the TrueCall Configuration Guide for install or upgrade instructions for the
optional TrueCall features.

4.4.1 TrueCall Server Component Configuration

Note: If configuring a Multi Instance Query Server, refer to Appendix F: Configuring a Multi Instance
Query Server (MIQS).

The TrueCall server configuration parameters must be entered into the TrueCall configuration file
named /opt/tc3/etc/config.ini. The common core components can reside on one TrueCall server, or
can reside on multiple TrueCall servers.

When TrueCall is installed, the configuration file, /opt/tc3/etc/config.ini, has every TrueCall task
enabled. Modify the configuration file to only start the TrueCall components required for the current
deployment and restart TrueCall services for the changes to be applied.

Templates do exist which can be used to configure the TrueCall configuration file for a particular
vendor technology. The template files are in the /opt/tc3/etc directory and are named config_VDR_
TECH.ini, where VDR_TECH is replaced with COMMON_LTE, HUA_UMTS, etc.

For example, /opt/tc3/etc/config_COMMON_GSM.ini would be used to enable all the components

needed for COMMON_GSM. Use the following command to replace the config.ini with a template
file:
cp /opt/tc3/etc/config_{VENDOR}_{TECH}.ini /opt/tc3/etc/config.ini

Note: TrueCall services must be restarted after the TrueCall configuration file has been modified
on a TrueCall server.

4.4.1.1 TrueCall ETL Component Configuration

Add the following task to the TrueCall server configuration file where the ETL process will reside.

TrueCall Installation and Upgrade Guide 14

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 4  Installing TrueCall (New Installation)
992-0638-08 Rev. 001

N/label=processor-vendor-tech
N/fullpath=/opt/tc3/bin/processor-vendor-tech
N/workingdir=/opt/tc3
N/args=--input-stream-port=NNNN

Note:

l Replace N with the actual number used for that TrueCall component.
l Replace vendor-tech with the actual vendor technology in use; i.e., common-lte, hua-umts,
etc.
l Replace NNNN with the actual port number used for that TrueCall component.
l Add any additional arguments required in the “args=” line.

Note:

If the ETL component is not running on the same machine as the query server, disable the
crontab entry for /opt/tc3/update-bookmarks.sh (for the daemon user) on this machine.
Otherwise, it can delete daily updated bookmarks.

4.4.1.1.1 Multiple Cylinder Configuration

The ETL can be configured in Common LTE to send to multiple cylinders to increase performance. To
use this feature, more than one cylinder must be provisioned. To enable the feature, add the
following arguments to processor-COMMON-LTE:
--cylinderd-address=IP1:PORT1,IP2:PORT2,IP3:PORT3,IP4:PORT4

Where IP(1-4) are the IP addresses of the cylinders and PORT(1-4) are the ports. Separate each
IP:PORT pair with a comma.

4.4.1.2 TrueCall Cylinder Component

Add the following task to the TrueCall server configuration file where the Cylinder process will reside.
N/label=cylinderd_VDR_TECH
N/fullpath=/opt/tc3/bin/cylinderd
N/workingdir=/opt/tc3
N/args=VDR_TECH|--port=NNNN

Note:

l Replace N with the actual number used for that TrueCall component.
l Replace VDR_TECH with the actual vendor technology in use; i.e., COMMON_LTE, HUA_
UMTS, etc.
l Replace NNNN with the actual port number used for the cylinder.
l Add any additional arguments required in the “args=” line.

Note:

If the Cylinder component is not running on the same machine as the query server, disable the
crontab entry for /opt/tc3/update-bookmarks.sh (for the daemon user) on this machine.

TrueCall Installation and Upgrade Guide 15

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 4  Installing TrueCall (New Installation)
992-0638-08 Rev. 001

Otherwise, it can delete daily updated bookmarks.

4.4.1.3 TrueCall TcsTcpServer Component

Add the following tasks to the TrueCall server configuration file where the TcsTcpServer process will
reside.
N/label=TcsTcpServer_VDR_TECH
N/fullpath=/opt/tc3/bin/TcsTcpServer_VDR_TECH
N/workingdir=/opt/tc3
N/args=--port=NNNN

N/label=prdd
N/fullpath=/usr/share/GSRservices/runprdd
N/workingdir=/opt/tc3
N/args=

Note:

l Replace N with the actual number used for that TrueCall component.
l Replace VDR_TECH with the actual vendor technology in use; i.e., COMMON_LTE, HUA_
UMTS, etc.
l Replace NNNN with the actual port number used for that TrueCall component.
l Add any additional arguments required in the “args=” line.

4.4.1.4 TrueCall Handset Database Auto-Upload Component

Add the following task to the TrueCall server configuration file where the TcsTcpServer process will
reside.
N/label=handset_upload_watcher
N/fullpath=/opt/tc3/bin/handset_upload_watcher
N/workingdir=/opt/tc3
N/args=

Note:

l Replace N with the actual number used for that TrueCall component.
l Add any additional arguments required in the “args=” line.

Refer to Appendix D: Handset Database Naming Convention to view the naming requirements for
the handset database.

Refer to the TrueCall Automatic Handset Ingest MOP for specific instructions on configuring this
feature.

4.4.1.5 TrueCall Network Element Table Auto-Upload Component

The configuration varies depending on whether the deployment uses Web Admin or nGenius
Configuration Manager.

TrueCall Installation and Upgrade Guide 16

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 4  Installing TrueCall (New Installation)
992-0638-08 Rev. 001

Add the following task to the TrueCall server configuration file where the TcsTcpServer process will
reside.
N/label=ne_watcher
N/fullpath=/opt/tc3/bin/NE_Watcher.py
N/workingdir=/opt/tc3/bin
N/args=

Note:

l Replace N with the actual number used for that TrueCall component.
l Add any additional arguments required in the “args=” line.

Refer to Appendix C: Network Element Table Naming Conventions to view naming requirements.

Refer to the TrueCall Automatic Upload of NE Tables MOP for specific upload guidelines.

4.4.1.6 Restart the TrueCall Server

After you have completed changes to /opt/tc3/etc/config.ini restart the TrueCall server:

As user "root:"
service truecall-server restart

Using sudo permissions:

sudo service truecall-server restart

4.4.2 TrueCall COMMON Vendor List Configuration

Note: The vendor list configuration file will be created when a COMMON vendor tech is
configured in the TrueCall configuration file and the TrueCall services are restarted.

Note: The vendor list configuration should be performed on the server where the TcsTcpServer
process will reside.

When the TrueCall server is configured to use one of the COMMON vendor technologies, the vendor
list will need to be modified for the TrueCall client to only display KPIs for the vendors that are in use.
Based on the COMMON technology chosen, the vendor list will reside in one of the files listed below:

l /opt/tc3/etc/TcsServerSettings_COMMON_GSM/NewfieldWireless/TcsServerSettings_
COMMON_GSM.ini
l /opt/tc3/etc/TcsServerSettings_COMMON_LTE/NewfieldWireless/TcsServerSettings_
COMMON_LTE.ini
l /opt/tc3/etc/TcsServerSettings_COMMON_UMTS/NewfieldWireless/TcsServerSettings_
COMMON_UMTS.ini

In the files above, there is a line that contains “VendorList=”. Edit that line to only include the
vendors the TrueCall server will process.

You can have more than one vendor enabled. Separate each vendor with a comma (,).

The available vendors for each technology are as follows:

TrueCall Installation and Upgrade Guide 17

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 4  Installing TrueCall (New Installation)
992-0638-08 Rev. 001

l COMMON_GSM = Huawei, Ericsson, ZTE

l COMMON_LTE = Nokia, Huawei, Samsung, Ericsson, Alcatel-Lucent, ZTE, Altiostar
l COMMON_UMTS = Nokia, Huawei, ZTE, Alcatel-Lucent, ERC

Example of setting the vendor list to process vendors Ericsson and Huawei on COMMON_LTE:
VendorList=Ericsson,Huawei

After the vendor list has been modified, restart TrueCall services to apply the changes using one of
the following commands:

As user "root:"
service truecall-server restart

Using sudo permissions:

sudo service truecall-server restart

After restarting the TrueCall server, run the following command to verify that the processes have
started:
ps -flwwu daemon

4.4.3 TrueCall PLMNID Configuration for LTE

Note: The PLMNID configuration should be performed on the server where the ETL process and
Query server reside. If the ETL and Query server reside on different machines, perform this
configuration on BOTH machines.

Customers may use ECI in their cell IDs on their network. For TrueCall to be able to geolocate the call
records, the cell IDs must be converted to ECGI.

Modify the file below to include the PLMNID of the customer so that TrueCall can convert the ECI to
ECGI to geolocate the call records. By default, the PLMNID is set to zero (0).

l /opt/tc3/etc/ne-table-config.ini

Modify the line below to include the correct PLMNID for the customer, i.e., replace zero (0) with the
6 digit PLMNID of the customer.
plmn_id=0

After the PLMNID has been modified, restart TrueCall services to apply the changes using one of the
following commands:

l As user "root:"
service truecall-server restart
l Using sudo permissions:
sudo service truecall-server restart

After restarting the TrueCall server, run the following command to verify that the processes have
started:
ps -flwwu daemon

TrueCall Installation and Upgrade Guide 18

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 4  Installing TrueCall (New Installation)
992-0638-08 Rev. 001

4.4.4 TrueCall Server Administration Installation

You can choose to use either Web Admin or nGenius Configuration Manager to support
administration functions.

If the TrueCall components will be installed on separate servers, the TrueCall Web Admin Console
should only be configured on the TrueCall server where the TcsTcpServer component resides.

4.4.4.1 Preparing the Server for Admin Functions

Applies to: nCM and Web Admin installations.

Perform the following procedure to prepare the server for either Web Admin installation or nCM
support.

1. If the operating system was not installed by NETSCOUT, verify that the umask value for root is
set to either 022 or 0022.
umask
If the value is anything other than 022 or 0022, set it for the current session.
As root:
umask 022
Setting the umask is not persistent and only applies to the current session.
2. Configure Ruby on Rails for the TrueCall Web Admin Console by running the commands
below.
cd /opt/tc3/share/WebClient5/config
As user “root”:
cp local_settings.rb.sample local_settings.rb
vi local_settings.rb
Using sudo permissions:
sudo cp local_settings.rb.sample local_settings.rb
sudo vi local_settings.rb
3. Edit the /opt/tc3/share/WebClient5/config/local_settings.rb file and set all enabled vendor
technologies to “true”.
In the example below, the enabled vendor technology is COMMON_GSM, therefore “GSM” is
set to “true”.
--- SNIPPET ---
ENABLED_TECHNOLOGIES = {
"ALU_CDMA" => false,
"NOR_CDMA" => false,
"HUA_CDMA" => false,
"ALU_EVDO" => false,
"NOR_EVDO" => false,
"ERC_UMTS" => false,# Use this one for ERC_UMTS with GSR
"ERC_UMTS_LEGACY" => false,# Use this one for ERC_UMTS without
GSR
"HUA_UMTS" => false,
"UMTS" => false,# Use this one for COMMON_UMTS

TrueCall Installation and Upgrade Guide 19

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 4  Installing TrueCall (New Installation)
992-0638-08 Rev. 001

"LTE" => false,# Use this one for COMMON_LTE

"ALU_LTE" => false,
"SAM_LTE" => false,
"NSN_LTE" => false,
"NSN_UMTS" => false,
"HUA_LTE" => false,
"GSM" => true,# Use this one for COMMON_GSM
"ERC_LTE" => false,
}
---SNIPPET ---
4. Save the changes and close the local_settings.rb file.
5. The following script creates the database and users.
As user “root:”
/opt/tc3/share/WebClient5/conf-database.sh
Using sudo permissions:
sudo /opt/tc3/share/WebClient5/conf-database.sh
6. The following script configures the Web Admin tool, but is also required for nGenius
Configuration Manager implementations to create tables and populate them with default
values.
As user "root:"
/opt/tc3/share/WebClient5/conf-webclient.sh
Using sudo permissions:
sudo /opt/tc3/share/WebClient5/conf-webclient.sh

Continue with either Integrating with nCM for Administrative Functions or Configure the Web Admin
Console.

4.4.4.2 Configure the Web Admin Console

Perform these steps to complete the Web Admin console installation after you've completed the
steps in TrueCall Server Administration Installation.

1. Log into the TrueCall Web Admin Console and upload the Network Element Table, upload the
Handset Database Table, configure the time zone, create user groups, and create user
accounts. Use a web browser and navigate to the IP or hostname of the TrueCall server where
the TcsTcpServer component resides. For the hostname to resolve, the TrueCall server must
have an entry in the DNS table.
Possible TrueCall Web Admin Console URLs (dummy IP and hostnames used below, replace
with real values):
IP - http://10.0.2.2
Hostname - http://tctest03
FQDN - http://tctest03.example.com

TrueCall Installation and Upgrade Guide 20

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 4  Installing TrueCall (New Installation)
992-0638-08 Rev. 001

4.4.4.3 Configure the nGenius Configuration Manager

Refer to Configuring nGenius Configuration Manager for detailed procedures on how to set up
nGenius Configuration Manager to act as the administration tool for TrueCall.

4.4.5 TrueCall Cylinder Cleanup

Note: The Cylinder cleanup configuration should be performed on the server where the Cylinder
process will reside.

TrueCall cylinder servers are designed to hold a certain amount of historical data. This is directly
related to the number of days you can go back in time within the TrueCall client.

The number of days of historical data to keep is maintained by cylinder-cleanup-all program that is
installed but not started by default when you load the TrueCall software package. The cylinder-
cleanup script is not started by default because its parameters need to be set according to the
specific customer.

In config.ini, the cylinder-cleanup-all program entry looks like the following:

#N/label= cylinder-cleanup-all _<Vendor Tech>
#N/fullpath=/opt/tc3/bin/cylinder-cleanup-all
#N/workingdir=/opt/tc3
#N/args=--tech=<Vendor Tech>|--min-filled-days=30|--schedule-time-
local=0200

To enable cylinder-cleanup-all, uncomment the above section, replace 'N' with an appropriate
number and change the value of 'size' on top to an appropriate number.

Where:

l --schedule-time-local is the time of day (in 24-hour format HHMM) when the program removes
data.
l --min-filled-days is the minimum number of populated days. This value should be > 0.

4.4.6 Enabling the cylinder-optimize.sh Script

By default, the cylinder-optimize.sh script contains an “exit 0” statement, which needs to be
commented out to enable the script.

Additionally, the crontab entry for the script is commented out. Remove the comment statement to
enable the crontab entry in /opt/tc3/etc/crontab.

4.4.7 Configure Cron Jobs

TrueCall includes several support scripts, which are run as cron jobs. These are commented out by
default in the cron tab.

4.4.7.1 Clean Archives

The clean-archives script compresses and prunes old archived data.

TrueCall Installation and Upgrade Guide 21

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 4  Installing TrueCall (New Installation)
992-0638-08 Rev. 001

This script should be configured and enabled on the server where the LSR process resides.

Update the CSV_DELETE_AGE parameter in /opt/tc3/bin/clean-archives to the number of days to

retain csv files. Uncomment out the crontab entry in /opt/tc3/etc/crontab to enable it.

4.4.7.2 Disk Cleanup

The disk-cleanup.sh script performs periodic cleanup of call records and reports.

Enable this script on the server where the Cylinder process resides. Uncomment out the entry for
disk-cleanup.sh in/opt/tc3/etc/crontab to enable it.

4.4.7.3 Update Bookmarks

The crontab entry that updates bookmarks (/opt/tc3/bin/update-bookmarks.sh) should ONLY be
enabled on the machine where the query server resides. Ensure that if the ETL and Cylinder reside on
separate machines that the update-bookmarks.sh entry in the crontab (for the user daemon) is
disabled on those machines. These cron jobs, if running, can delete users’ daily-updated bookmarks.

4.4.8 Enable TrueCall Service to Start on Boot

The TrueCall server is not set to start automatically after a new installation, you must activate
manually:

As user “root”
systemctl enable truecall-server

Using sudo:
sudo systemctl enable truecall-server

4.5 Next Steps

After the TrueCall software has been installed and configured, refer to TrueCall Process and Log File
Verification to ensure that the TrueCall software is operating without any issues.

TrueCall Installation and Upgrade Guide 22

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 5 Upgrading TrueCall from the Previous
Version
In order to upgrade to 6.3.0, the existing TrueCall version must be at 17.3 or higher.

Note: If the current version is earlier than 17.3, upgrade the software to 17.3 using the TrueCall
Installation and Upgrade Guide, Version 17.3 before proceeding with the upgrade instructions
outlined in this document.

This section only applies if an upgrade of an existing TrueCall installation is being performed, i.e.
upgrading the TrueCall software on server that currently has the TrueCall software installed. If a new
TrueCall installation is being performed, refer to Installing TrueCall (New Installation).

Before beginning, ensure that the prerequisites for upgrading are met and preparation has been
completed as outlined in the following sections:

l TrueCall Software Packages

5.1 Known Changes When Upgrading from a Previous Version

If any of the known changes documented in this section are in use in previous versions, modify them
accordingly to prevent any issues post upgrade to version 6.3.0. For any changes that require
modification of the TrueCall configuration file, these changes can be performed after the existing
software is removed and before the new software is installed.

Each section is marked with the applicable release(s). Skip the sections that do not apply to the
release you are upgrading from.

5.1.1 Installation Changes

Applies to upgrade from:

l 17.6.2.2 and earlier

Because the numbering scheme changed in 6.3.0, the installer thinks you are trying to install an
older version of the software when upgrading from 17.6.2.2. You need to add the following flag
when installing to force the installer to upgrade:

l --oldpackage

Example: rpm -Uvh --oldpackage TrueCall-Server-6.3.0.x.rpm

TrueCall Installation and Upgrade Guide 23

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 5  Upgrading TrueCall from the Previous Version
992-0638-08 Rev. 001

5.1.2 Changes to Geolocation Algorithms

Applies to upgrade from:

l 17.6.2.2 and earlier.

As of 6.3.0, Ring Search Method (RSM) is now the default geolocation algorithm for LTE and 5G
implementations. Upon upgrade to 6.3.0, RSM will be set as the default, regardless of which
algorithm was in use before.

Extra configuration is required, which is outlined in the upgrade section of this document.

Refer to the Configuring Ring Search Method chapter in the TrueCall Configuration Guide, version
6.3.0 for more information.

5.1.3 Changes for Cylinder Performance Improvements

Applies to upgrade from:

l 17.6.2.2 and earlier.

This feature adds changes to improve performance when reading and writing from the database.
These changes remove the end time index from cylinder.

This feature is available for GSR-compatible processors for GSM, UMTS, or LTE and is enabled by
default upon new install or upgrade.

To disable the feature:

l In the processor section of opt/tc3/etc/config.ini, set --high-performance-cylinder=0.

l In the cylinder section of opt/tc3/etc/config.ini, set --high-performance=0.

Note: If you are disabling the feature, it is important to keep the options on the processor and
cylinder in sync or there could be irretrievable data loss.

Server restart is required after disabling/enabling this feature.

Tag names now contain the end time at the end of the filename.

Old cylinder tags and data are not updated to the new format. Cylinder is able to read both formats
and will continue to read the old tags and data until they age out.

5.1.3.1 New Cylinder Statistics

New cylinder statistics are available as a result of this feature. They are required when the high
performance options are enabled. These stats are enabled by default.

Note: To change any of the default cyl-stats options, you must add them to
/opt/tc3/etc/config.ini.

--cyl-stat-enabled (=1) Enables the use of cylinder statistics. Required when the
end time index is not used
--cyl-stat-output-console arg (=0) If true, cylinder statistics output is sent to console

TrueCall Installation and Upgrade Guide 24

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 5  Upgrading TrueCall from the Previous Version
992-0638-08 Rev. 001

--cyl-stat-output-logger arg (=1) If true, cylinder statistics output is sent to logger (which
may be to the console or a file). This option is specified in
the /etc/sysconfig/truecall-server settings file, so should
not be specified in a config.ini.
--cyl-stat-output-file arg If set, cylinder statistics output is sent to the specified file.
This option is specified in the /etc/sysconfig/truecall-server
settings file, so should not be specified in a config.ini.
--cyl-stat-output-final arg (=1) If true, cylinder statistics output one last set of statistics
when we shut down
--cyl-stat-output-verbose arg (=1) If true, Display cylinder statistics verbose messages, one
line per statistic.
--cyl-stat-output-taglist arg (=1) If true, Display all cylinder statistics on a single line as tag-
value pairs.
--cyl-stat_tag_inactive-interval arg (=900) Interval be used to detect tag become inactive, if tag over
more than this interval not receive data, tag be marked as
inactive. in seconds.

5.1.4 Changes to Required Libraries

Applies to upgrade from:

l 17.6.2.1 and earlier

Beginning in 6.3.0 the following libraries are required:

l bzip2-devel
l xz-devel
l libcurl-devel
l openssl-devel
l protobuf

5.1.5 LSR Changes

Applies to upgrade from:

l 17.6.2.0 and earlier

You should no longer use Carrier Aggregation Service Time [s] as a column name in the LSR
configuration file. The field name has changed to Carrier Aggregation Service Time [ms].

If the old name is used, an error is logged in the log and the column is treated as an unknown
column, which results in either no data for the column or complete removal depending on whether
the --allow-unknown-cols option is enabled.

5.1.6 Change to Overshooting Cells

Applies to upgrade from:

l 17.4 and earlier

TrueCall Installation and Upgrade Guide 25

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 5  Upgrading TrueCall from the Previous Version
992-0638-08 Rev. 001

Beginning in 17.6.2 the Overshooting Cells configuration has changed.

/opt/tc3/etc/TcsServerSettings_COMMON_LTE/NewfieldWireless/TcsServerSettings_COMMON_
LTE.ini now contains the parameterOvershootingEnabled=true.

Refer to the Overshooting Cells configuration section in the TrueCallConfiguration Guide for more
information.

5.1.7 S6A/Diameter End of Support

Applies to upgrade from:

l 17.4 and earlier

Beginning in 17.6.2, support for S6A/Diameter has ended. Diameter Parser, TCE, and TCM are no
longer supported.

The following arguments should be removed from the COMMON_LTE ETL task if present:
--tc-e-connect-string arg Diameter connection string for Tc-e.
--tc-e-worker-threads arg (=2) Number of Tc-e worker threads.
--nas-db-worker-threads arg (=1) Number of NAS DB worker threads.
--libtce-server-port arg The port for LibTce to run as a Server.
--libtce-row-logging arg If set, where to log query/response rowData
records.
--request-throttle-size arg (=100) Number of TCE requests before
throttling.
--drop-when-full If set, skip diameter lookup instead of waiting when
Tc-e is throttling.
--update-hybrid-key arg (=1) Send hybrid key in updates from NAS Engine
to Tc-E.
--block-list-rate arg (=30) Diameter block list rate (in minutes)

5.1.8 Changes to MDT

Applies to upgrade from:

l 17.4 and earlier

Beginning in 17.6.2 MDT configuration has changed.

Change the mdt parameter in /opt/tc3/etc/config.ini to --mdt=1. Additionally, set the

MdtEnabled=true parameter in /opt/tc3/etc/TcsServerSettings_COMMON_
LTE/NewfieldWireless/TcsServerSettings_COMMON_LTE.ini.

Refer to the Configuring MDT section in the TrueCall Configuration Guide, 17.6.2 for more
information.

5.1.9 Changes to Log File Rotation

Applies to upgrade from:

l 17.4 and earlier

TrueCall Installation and Upgrade Guide 26

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 5  Upgrading TrueCall from the Previous Version
992-0638-08 Rev. 001

Beginning in 17.6.2 several command line options related to log file rotation are removed. Presence
of these options causes TrueCall to fail on startup. The TrueCall RPM upgrade will detect these
options and attempt to fix the config.ini file automatically.

If these options are detected in the preConfig.json file, there will only be a warning and manual
modification is necessary.

The following options are no longer valid:

--log-rotation
--log-archive
--log-purge
--log-file

5.1.10 Verify Crontab Entries for Daily Bookmarks

The crontab entry that updates bookmarks (/opt/tc3/bin/update-bookmarks.sh) should ONLY be
enabled on the machine where the query server resides. Ensure that if the ETL and Cylinder reside on
separate machines that the update-bookmarks.sh entry in the crontab (for the user daemon) is
disabled on those machines. These cron jobs, if running, can delete users’ daily-updated bookmarks.

5.1.11 Reset WebClient Password

For users not using LDAP, you need to update your password if you receive the following message
when logging into the WebClient:

'Your password hash is insecure. Please change your password.’

5.1.12 Changes to PLP

Applies to upgrade from:

l 17.4 and earlier

Beginning in 17.6.2 two parameters have been added to plp.ini:

enable_plp_subscription=false
plp_awareness_update_min=120

Beginning in 6.2.1 two parameters have been added to plp.ini:

records_per_subs_packet=100
enable_plp_file_output=true

Refer to the PLP Configuration section in the TrueCall Configuration Guide for more information.

5.1.13 Changes to the Upgrade Procedure

Applies to upgrade from:

l 17.2 and earlier

Beginning in 17.3 you no longer need to remove the TrueCall server RPM then re-install.

TrueCall Installation and Upgrade Guide 27

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 5  Upgrading TrueCall from the Previous Version
992-0638-08 Rev. 001

Many configuration files are preserved across upgrades, please see any file named <file>.pkg as
these are the newer versions. You should check these files for new content that may need to be
manually incorporated into the active version or entirely replace the old file.

Specifically, /etc/sysconfig/truecall-server is used for service start-up settings as well as

environmental settings used in /opt/tc3/bin/tc3-env.sh. You must check for any changes in
/etc/sysconfig/truecall-server.new and either replace the existing /etc/sysconfig/truecall-server file or
incorporate the changes manually.

5.1.14 Changes Related to nGenius Configuration Manager Integration

Applies to upgrade from:

l 17.4 and earlier

Beginning in 17.6.2 you can optionally integrate with nGenius Configuration Manager for
administration functions. Performing this integration requires multiple changes to standard TrueCall
configuration. The following is an overview to changes required:

l Two new python libraries are required: python-requests and python-pandas

l Changes to handset database
Replace instances of handset_file_download.py in /opt/tc3/etc/config.ini with the handset_
upload_watcher task. There is a new parameter used to specify handset file types:
--reqd-handset-file-types
In previous TrueCall releases there was no verification performed in the uploaded raw handset
database files. This means that uploading an incorrect file could yield unexpected results. The
tc_configuration_uploader program will now perform a basic validation to ensure the file
contains the right format and it has no overlapping ID ranges or duplicated IDs. In order to do
this the file format requires the IDs stored in the first and second column to be ordered in a
monotically increasing manner. If verification fails please sort the input file numerically based
on the first column. If this behavior is not desired the previous behavior can be achieved by
disabling the handset database verification passing the following argument to tc_
configuration_uploader:
--disable-handset-db-validation
l There is a new IMSI whitelist watcher task added to the query server.
l The following are now set by parameter in /opt/tc3/etc/config.ini instead of in Web Admin:
o --timezone
o --nsa-server-address
o --isa-server-address
o --user-idle-time-min
o --sent-by-email-address
l Daily report email configuration has changed.
l Customers are required to update any scripts used for automatic upload.

For complete information about integrating with nGenius Configuration Manager, refer to

Configuring nGenius Configuration Manager.

TrueCall Installation and Upgrade Guide 28

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 5  Upgrading TrueCall from the Previous Version
992-0638-08 Rev. 001

5.2 Backup Existing Configuration Files and TrueCall PostgreSQL

Database
While the upgrade process from 6.3.0 preserves existing TrueCall configuration and any collected
and stored data, it is always recommended to back up all data before performing system changes.

This section outlines the recommended data to backup before upgrade.

5.2.1 TrueCall crontab

Make a copy of the crontab for the user “daemon” by running the following command:

As user “root”:
crontab -u daemon -l > /path/to/daemon_crontab_$(date +%d%b%y)

Using sudo permissions:

sudo crontab -u daemon -l > /path/to/daemon_crontab_$(date +%d%b%y)

Note: Replace /path/to/ with a valid directory on the TrueCall server, preferably a directory where
anyone can read and write.

5.2.2 TrueCall Configuration Files

Make a copy of the configuration files listed below.

Note: It is possible that some or all the TrueCall processes could exist on one node.

For all TrueCall nodes:

/opt/tc3/etc/config.ini

For all TrueCall nodes with Web Admin Console configured:

/opt/tc3/share/WebClient5/config/local_settings.rb

For the TrueCall TcsTcpServer Node:

/opt/tc3/etc/tcaccess.ini

Note: If secure LDAP is in use, make a copy of the certificate referenced in the tcaccess.ini file in
the setting labeled “TlsCaCertPath=”.

If COMMON_GSM is in use:
/opt/tc3/etc/TcsServerSettings_COMMON_
GSM/NewfieldWireless/TcsServerSettings_COMMON_GSM.ini

If COMMON_LTE is in use:
/opt/tc3/etc/TcsServerSettings_COMMON_
LTE/NewfieldWireless/TcsServerSettings_COMMON_LTE.ini

If COMMON_UMTS is in use:
/opt/tc3/etc/TcsServerSettings_COMMON_

TrueCall Installation and Upgrade Guide 29

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 5  Upgrading TrueCall from the Previous Version
992-0638-08 Rev. 001

UMTS/NewfieldWireless/TcsServerSettings_COMMON_UMTS.ini

For the TrueCall ETL Node:

/opt/tc3/etc/ne-table-config.ini

For the TrueCall Cylinder Node or TrueCall Stand-alone LSR Node:

If LSR is in use, make a copy of the following file:

/opt/tc3/etc/lsr_config_VDR_TECH.config

Note:

l Replace VDR_TECH with the vendor technology in use; i.e, COMMON_LTE, ALU_CDMA, etc.
l LSR is a licensed feature and may not be enabled in the customer’s environment.
l If LSR is licensed, the Cylinder node has the “LSR-server” TrueCall task enabled along with
the “cylinderd” task.
l The stand-alone LSR node would have the “LSR-standalone” TrueCall task enabled without
the “cylinderd” task.

5.2.3 TrueCall PostgreSQL Database

Backup the TrueCall PostgreSQL database on all nodes with Web Admin Console configured by
running the following command :
pg_dump -h localhost -U truecall tcadmin_production -C | gzip >
path/to/tcadmin_backup$(date +%d%b%y).sql.gz

Note: Replace /path/to/ with a valid directory on the server, preferably from where anyone can
read and write.

5.3 Upgrade TrueCall and GSRservices

To upgrade TrueCall and GSRservices:

1. Stop the TrueCall server:

service truecall-server stop
2. Upgrade the TrueCall and GSRservices RPMs using the following commands:
Note:
l Replace X-X or XX with the correct version required for the deployment.
l If you are upgrading from 17.x, you must use the --oldpackage option, because
the installer thinks you are trying to upgrade to an older package.
rpm -Uvh --oldpackage TrueCall-Server-6.3.0.X-X-gef929c5-el7-x86_
64.rpm
rpm -Uvh GSRservices-V17.6.3.0.XX-0_el7.x86_64.rpm
3. Run the configuration script:
/opt/tc3/bin/conf-truecall.sh --upgrade
4. Install either Web Admin or migrate to nGenius Configuration Manager. Refer to TrueCall

TrueCall Installation and Upgrade Guide 30

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 5  Upgrading TrueCall from the Previous Version
992-0638-08 Rev. 001

Server Administration Installation to get started with either option.

5. Start the TrueCall server:
service truecall-server start

5.4 Update Geolocation Configuration for Common LTE

As of 6.3.0, RSM is set as the default geolocation algorithm for Common LTE. However, you need to
perform the following steps to finalize the configuration when upgrading.

This process is only necessary for Common LTE implementations.

1. Copy the newly created /opt/tc3/etc/necal_config.ini.pkg over the old necal_config.ini file.
cp /opt/tc3/etc/necal_config.ini.pkg /opt/tc3/etc/necal_config.ini
2. Copy any parameters file with .pkg extensions over the existing copies. These files are in the
/opt/tc3/etc/ directory and begin with nle_parameters_*.
Example: cp /opt/tc3/etc/nle_parameters_common_lte.ini.pkg
/opt/tc3/etc/nle_parameters_common_lte.ini
3. Run the nle setup script.
/opt/tc3/bin/nle_setup.sh

5.5 Update Configuration Files After Upgrade

Many configuration files are preserved across upgrades, please see any file named <file>.pkg as
these are the newer versions. You should check these files for new content that may need to be
manually incorporated into the active version or entirely replace the old file.

Specifically, /etc/sysconfig/truecall-server is used for service start-up settings as well as

environmental settings used in /opt/tc3/bin/tc3-env.sh. If the installation process detects changes in
your existing truecall-server file, it creates a new version which is placed in the same folder. Check the
changes in /etc/sysconfig/truecall-server.new and either replace the existing /etc/sysconfig/truecall-
server file or incorporate the changes manually.

If using LSR, compare the modified lsr/tc3/etc/lsr_config_VDR_TECH.config files against the lsr_
config_VDR_TECH.config backup file created earlier to ensure that everything is as expected.

After configuration files have been modified, restart TrueCall services to apply the changes using one
of the following commands:

As user "root:"
service truecall-server restart

Using sudo permissions:

sudo service truecall-server restart

5.6 Next Steps

After the TrueCall software has been installed and configured, refer to TrueCall Process and Log File
Verification to ensure that the TrueCall software is operating without any issues.

TrueCall Installation and Upgrade Guide 31

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 6 TrueCall Process and Log File
Verification
After the TrueCall software has been installed on a new server or upgraded on an existing server,
verify the software stability by examining the process IDs and log files for all TrueCall processes on
each TrueCall server.

Note:TrueCall Log files are NETSCOUT internal access only. These are used by NETSCOUT
Service & Delivery teams for support purposes. TrueCall engineering reserves the right to
change any information as appropriate in the TrueCall log files. Changes to log files are not
documented.

Note: DO NOT SKIP THE PID AND LOG FILE VERIFICATION STEPS.

It is possible that certain arguments used in the previous version of TrueCall may not be valid in the
new version of TrueCall. The only way to verify this is by checking the stability of the TrueCall
processes and by inspecting the TrueCall log files.

6.1 TrueCall PID Stability Verification

Verify that the PIDs for the TrueCall processes are not changing by running the command below.
watch -n 1 "ps -flwwu daemon"

If the value in the “PID” column is changing for any of the TrueCall processes, inspect the log file for
the TrueCall process whose PID is changing to see what errors are being reported.

6.2 TrueCall Log File Verification

Inspect the log file for each TrueCall task enabled in the configuration file and verify that no errors
are reported after the TrueCall install or upgrade. If any of the existing arguments specified in the
configuration file are no longer valid post upgrade, an error will be reported in the log file for the
affected TrueCall task. All TrueCall task log files are stored in the /var/lib/truecall/log directory.

To access the log file for a given TrueCall task, you will need the label of the bin file used to run the
affected TrueCall task. Open the TrueCall configuration file (/opt/tc3/etc/config.ini) and find the
four-line stanza for the affected TrueCall task. Look at the value of the “label=” argument. The log file
will be accessed using that label value.

Run the command below to access the log file for a given TrueCall task.

TrueCall Installation and Upgrade Guide 32

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 6 TrueCall Process and Log File Verification
992-0638-08 Rev. 001

less /var/lib/truecall/log/label

Note: Replace label with the value of the “label=” argument in the TrueCall configuration file.

6.3 Accessing the TrueCall Task Help Content

To verify which arguments are valid for a given TrueCall task, look at the help contents for the
affected TrueCall task to see which arguments are valid for the new software version.

To access the help content for a given TrueCall task, you will need the fullpath of the bin file used to
run the affected TrueCall task. Open the TrueCall configuration file (/opt/tc3/etc/config.ini) and find
the four-line stanza for the affected TrueCall task. Look at the value of the “fullpath=” argument. The
help content will be accessed using that fullpath value.

Run the command below to access the help content for a given TrueCall task.
source /opt/tc3/bin/tc3-env.sh && /full/path/to/binfile -h | less

Note:Replace /full/path/to/binfile with the value of the "fullpath=" argument in the TrueCall
configuration file.

Modify the configuration file accordingly and then restart TrueCall services for the new configuration
file to take effect.

Run the command below to restart TrueCall services if the configuration file was changed:

As user “root”:
service truecall-server restart

Using sudo permissions:

sudo service truecall-server restart

After restarting the TrueCall services, run the following command to verify that the processes have
started:
ps -flwwu daemon

6.4 TrueCall Web Admin Console Verification

Note: If the TrueCall components will be installed on separate servers, the TrueCall Web Admin
Console should only be installed on the TrueCall server where the TcsTcpServer component will
reside.

For each TrueCall server that has the TrueCall Web Admin Console installed, verify that the TrueCall
Web Admin Console is accessible and that all previous settings still exist. Items that should still exist
and not have changed post upgrade are the users, user groups, NE tables, handset database, and
server settings such as the time zone and BING maps credentials.

TrueCall Installation and Upgrade Guide 33

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 7 Appendix A: Default Port Information
The port numbers listed in the chart below are the default TrueCall port numbers for each TrueCall
component.

Any port number above 1024 can be used for each TrueCall component if the port is not already in
use by another application. If a non-default port number will be used by a TrueCall component, the
port number will need to be specified in the TrueCall configuration file.

If the customer enables a firewall, TCP Ports 49152 - 49168 should be opened to allow for Cylinder
and Query Server communication.

Vendor_Tech Version Cylinder TcsTcpServer ETL Port

Port Port
ALU_CDMA All 19846 8891 /var/lib/truecall/ALU_
CDMA/raw
ALU_EVDO All 19844 8890 /var/lib/truecall/ALU_EVDO/raw
ALU_LTE All 19842 9892 /var/lib/truecall/ALU_LTE/raw
COMMON_GSM All 54111 54112 54110
COMMON_LTE All 54101 54102 54100
COMMON_UMTS All 19853 7893 7782
ERC_CDMA All 19845 8893 /var/lib/truecall/ERC_
CDMA/raw
ERC_EVDO All 19843 8892 /var/lib/truecall/ERC_EVDO/raw
ERC_LTE L13A 19840 9890 29316
L13B 29317
L14A 29318
L14B, L15A, 29319
L15B
L16A 29310
L17A 29311
HUA_ All 19848 8895 /var/lib/truecall/HUA_
CDMA/EVDO CDMA/raw
HUA_LTE All 19852 9894 7778
HUA_UMTS All 19849 7891 7780
NSN_LTE All 19850 9893 50004
NSN_UMTS All 19851 7892 7777
SAM_LTE All 19841 9891 7781

TrueCall Installation and Upgrade Guide 34

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 7 Appendix A: Default Port Information
992-0638-08 Rev. 001

Vendor_Tech Process Port

ERC_LTE CTUM from MME 29323
ERC_LTE CTUM Publisher 29333
COMMON_GSM Standalone LSR (Used without Cylinder) 54108
COMMON_LTE Standalone LSR (Used without Cylinder) 54106
COMMON_UMTS Standalone LSR (Used without Cylinder) 54107

TrueCall Installation and Upgrade Guide 35

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 8 Appendix B: Additional Documentation
The following supporting documentation is available:

Note: Customers should contact their NETSCOUT representative to obtain copies of any of
the following documents. NETSCOUT employees should use the internal documentation
portal to access documents.

l Vendor MOPs—Provide instructions for configuring vendor equipment to support TrueCall.

l Network Element table templates
l TrueCall Configuration Guide—Provides instructions for installing any of the optional TrueCall
features.
l Vendor Support Roadmap - Provides a cross reference for interface and vendor traceport
version support.

TrueCall Installation and Upgrade Guide 36

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 9 Appendix C: Network Element Table
Naming Conventions
9.1 Considerations
While configuring and distributing eNB feeds to NETSCOUT RAN probes, ensure that all eNBs feeding
to one probe entity belong to one coherent geographical cluster. All eNBs of such a cluster must
feed to a single probe entity. Refer to the Ran Flow Broker documentation for more information.

9.2 Input Format

The input format for the Network Element Table is described in the vendor- technology MOPs and in
the help tab of the associated vendor-technology NE Table template.

TrueCall provides templates in .txt and .xlsx format from the TrueCall Administrator WebClient in the
following location:

l Network Element Tables > <vendor><technology> Network Element Table > Upload >
Download Templates. The templates (.txt and .xlsx for GSM, LTE, and UMTS) are contained in a
zip file.

The NE table format can change between TrueCall releases. Please ensure that the latest NE table
format is being used for upload.

Note:NETSCOUT recommends that you use either the provided .txt or .xlsx templates for
your data. However, you may also create your own Excel spreadsheet.

If you decide to use your own spreadsheet:

l The file must have .xlsx as the file extension.

l The file must contain a sheet named "NE Table" that contains the NE Table columns and
values.
l Format all the cells in the NE Table sheet as "text" so that no automatic formatting occurs.

9.3 Input Filename

The TrueCall NE Watcher will deduce the vendor-technology from the NE Table file name
automatically.

TrueCall Installation and Upgrade Guide 37

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 9 Appendix C: Network Element Table Naming Conventions
992-0638-08 Rev. 001

l The following LTE vendors can use the naming convention COMMON_LTE_Timestamp.xxx
o Ericsson
o Huawei
o Nokia
o Alcatel-Lucent
o Samsung
o ZTE
l The following GSM vendors can use the naming convention COMMON_GSM_Timestamp.xxx
o Huawei
o Ericsson
o ZTE
l The following UMTS vendors can use the naming convention COMMON_UMTS_
Timestamp.xxx
o Nokia
o Huawei
o ZTE
o Alcatel-Lucent
l Other VTs should use the naming convention VENDOR_TECH_Timestamp.xxx
Example: ALU_CDMA_201402121757.txt

This is also the default naming convention of NE table output from the TrueCall WebClient.

The TrueCall NE Watcher assumes the time-stamp is in UTC. 

It will also support the addition of a comment string at the beginning of the file-name.
Example: dummy-table_ERC_CDMA_201402121757.txt

The NE Table file name shall consist of less than 255 characters.

TrueCall Installation and Upgrade Guide 38

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 10 Appendix D: Handset Database Naming
Convention
10.1 Input Format
The input format matches the input format required by the TrueCall WebClient. For a table of type -
with the valid types being MEID and MIN for 3GPP2 technologies and IMSI and TAC for 3GPP
technologies.

type_start type_end make model

Type_start and type_end can be used to create MEID/TAC ranges for certain make/model types. For
MIN and IMSI tables, type_start and type_end would be identical. The table is tab-separated. This is
an example for TAC:

12341234 12341234 Test_Make Test_Model

10.2 Input Filename

By convention, these files will have a name consisting of a prefix that describes the file content
concatenated with a sortable timestamp to make the name unique. The general form is:

PREFIX_YYYYMMDDHHMMSSddd.txt

Example:

l imsi_20140611191224339.txt
l imei_20140611171524339.txt
l meid_20140421203144321.txt
l tac_20140521113255222.txt

The prefix corresponds to the type of key used for lookup (MIN, IMSI, TAC, MEID).

The above naming conventions must be obeyed. (The milliseconds part of the name may be
omitted.) The purpose is that the handset tables sort properly so that if a table is bad the most
recent good table can be used in its place, and so that older tables can be archived.

Note: If multiple matching methods are being used (e.g. IMSI and TAC) then a file of each type will
need to be uploaded to the server before TrueCall will ingest the files.

TrueCall Installation and Upgrade Guide 39

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 11 Appendix E: Migrating to the COMMON
Vendor Technology
Some LTE and UMTS vendors can be migrated to the COMMON technology if that vendor is
supported in the COMMON technology in the version of TrueCall that is installed.

Migrating to COMMON requires the following actions:

l Rename the NE table to include the COMMON technology in the file name.
l Modify the TrueCall configuration file to reference the COMMON technology.
l Reconfigure the TrueCall Web Admin Console for the COMMON technology.
l Move the Cylinder (call records) from the non-COMMON technology to the COMMON
technology directory.
l Upload the renamed NE table for the COMMON technology.
l Configure the TcsTcpServer task to use the correct vendor for the COMMON technology.

The chart below shows which vendor technologies can be migrated to the corresponding COMMON
technology.

Vendor_Tech COMMON_Tech
ERC_LTE COMMON_LTE
HUA_LTE COMMON_LTE
NSN_LTE COMMON_LTE
SAM_LTE COMMON_LTE
ERC_UMTS COMMON_UMTS
NSN_UMTS COMMON_UMTS

11.1 Migration to COMMON Caveats

The following caveats apply when migrating from a non-COMMON technology to a COMMON
technology.

l TrueCall services will need to be stopped.

l The COMMON_TECH Cylinder folder must be empty prior to the migration.
o /var/lib/truecall/COMMON_LTE/data
o /var/lib/truecall/COMMON_UMTS/data

TrueCall Installation and Upgrade Guide 40

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 11 Appendix E: Migrating to the COMMON Vendor Technology
992-0638-08 Rev. 001

l Old ERC_LTE data will lose IMSI/IMEI because the old Cylinder (call records) data has encrypted
IMSI/IMEI, which cannot be decrypted after the migration to COMMON_LTE.*
l If the non-COMMON vendor technology supported Layer 3 messages and did not use GSR
prior to the COMMON migration, the Layer 3 messages for the old call records will no longer
work as the COMMON technology will try and retrieve the Layer 3 messages from a GSR node
post migration to COMMON.*
l For the old call records, any new columns that exist in the COMMON technology will not be
populated in the TrueCall client as those columns did not exist in the non-COMMON
technology.*

*Resolved after the old call records age out of the Cylinder.

*New call records received post migration to COMMON are not affected.

11.2 Migration to COMMON Process

The migration process for moving from a non-COMMON technology to a COMMON technology is
outlined below.

1. Perform the normal TrueCall upgrade with the non_COMMON vendor technology in place.
This includes re-running the “conf-database.sh” and “conf-webclient.sh” scripts.
2. Log into the TrueCall Web Admin Console and download the current NE table for the market.
3. Rename the file to include the new COMMON_TECH in the name.
Example of renaming the downloaded NE table to include COMMON_LTE in the name:
LTE_201705241003.txt -> COMMON_LTE_20170525.txt
4. After the TrueCall upgrade is complete and the NE table is downloaded, stop TrueCall services.
l As user “root”:
service truecall-server stop
l Using sudo permissions:
sudo service truecall-server stop
5. Modify the TrueCall configuration file (/opt/tc3/etc/config.ini) and change the TrueCall tasks
from the non-COMMON tasks to the COMMON tasks. This includes changing the names of
the labels and port numbers used.
Example of migrating the cylinderd task from ERC_LTE to COMMON_LTE:
2/label=cylinderd_ERC_LTE -> 2/label=cylinderd_COMMON_LTE
2/fullpath=/opt/tc3/bin/cylinderd -> 2/fullpath=/opt/tc3/bin/cylinderd
2/workingdir=/opt/tc3 -> 2/workingdir=/opt/tc3
2/args=ERC_LTE|--port=19840 -> 2/args=COMMON_LTE|--port=54101

Do this for all of the non-COMMON tasks in the configuration file.

Refer to Appendix A: Default Port Information for the new COMMON port numbers.
6. If the TrueCall components will be installed on separate servers, the TrueCall Web Admin
Console should only be configured on the TrueCall server where the TcsTcpServer component
will reside.

TrueCall Installation and Upgrade Guide 41

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 11 Appendix E: Migrating to the COMMON Vendor Technology
992-0638-08 Rev. 001

Configure the TrueCall Web Admin Console to use the COMMON_TECH by modifying the
“/opt/tc3/share/WebClient5/config/local_settings.rb” file and enabling the COMMON
technology.

Refer to the TrueCall COMMON Vendor List Configuration for specific details.

TrueCall Installation and Upgrade Guide 42

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 12 Appendix F: Configuring a Multi
Instance Query Server (MIQS)
If you are running the TrueCall query server on a large machine, it may be beneficial to run two (or
more) instances of the Query Server on the same machine (MIQS). Recommended procedure is to
use VMWare Virtual Machines and treat each instance as separate. If that isn’t an option, follow
these steps to install two instances of a query server on the same machine. This type of deployment
is only supported for HP ProLiant DL380 Gen 10 servers.

Important: Read this entire section before beginning the installation. This section outlines the
aspects of the standard installation that are different for a MIQS installation than a standard
installation.

1. In TrueCall Server Component Configuration:

a. Copy the appropriate config-Probe-Query-Server_COMMON_{TECH}.ini template to use as
the configuration file for TrueCall (config.ini)
Example: If you are installing a Multi Instance Query Server for COMMON GSM run:
cp /opt/tc3/etc/config-Probe-Query-Server_COMMON_GSM.ini
/opt/tc3/etc/config.ini
2. In Step 3 of TrueCall Server Administration Installation:
a. When editing local_settings.rb, uncomment and update the
$UserAuthenticationTcpServerHostname and $UserAuthenticaitionTcpServerPort
variables
b. There are 2 of each variable, one for each TcsTcpServer
c. The UserAuthenticationTcpServerHostname should be set to the hostname of the
machine on which the TcsTcpServer applications are located (likely this machine)
d. The UserAuthenticationTcpServerPort variables should be set to the port numbers for the
matching TcsTcpServer_COMMON_UMTS_# in /opt/tc3/etc/config.ini (from 1a of this
section)
3. In Step 6 of TrueCall Server Administration Installation TrueCall Web Admin Console
Configuration
Add --dual as a command line argument to the conf-webclient.sh script (NOT conf-
database.sh in step 5)
4. If two databases are being used, you may need to update the ETL Server to use the correct
database using the --ne-db-name command line parameter for the processor-{vendor}-
{tech} application:

TrueCall Installation and Upgrade Guide 43

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 12 Appendix F: Configuring a Multi Instance Query Server (MIQS)
992-0638-08 Rev. 001

N/label=processor-vendor-tech
N/fullpath=/opt/tc3/bin/processor-vendor-tech
N/workingdir=/opt/tc3
N/args=--input-stream-port=NNNN|--ne-db-connection=DB-IP-Address|--
ne-db-name=DB-Name

Where:

l DB-Name is the name of the database on the Query Server. If this argument is not specified,
the processor will default to use 'production' which is the current default database name.
During installation, determine which NE table this processor needs to access and supply that
name using this argument.

12.1 Configuring Two Databases

Following the above directions should be enough for setup with default database configurations.
Note that database configuration is stored in these files:

/opt/tc3/etc/tcaccess.ini
/opt/tc3/etc/tcaccess2.ini
/opt/tc3/share/WebClient5/config/database.yml

tcaccess.ini refers to the first database called 'production' in database.yml. tcaccess2.ini refers to the
second database called 'production2'.

These database configuration files are specified for the TcsTcpServer applications as command line
configuration items in /opt/tc3/etc/config.ini.

Both databases share the handset database, which can only be updated using the web interface for
'production'.

12.2 Accessing the TrueCall Client and Web Admin Interfaces

To access the TrueCall client, specify the port of the query server to connect to.

To access the Web Admin tool, the first server is accessed as it normally is at http//<server>/admin.
The second server is accessed at http://<server>/admin2.

12.3 Configuring MIQS Cron Jobs

TrueCall includes several support scripts which are run as cron jobs. These scripts are automatically
called by name from the operating system. As part of this feature, we have added slightly modified
scripts which will work with the multiple Query Servers and postgres databases.

The Clean Server Cache script helps prevent excessive disk space usage by the cache. To enable it on
the Multi Instance Query Server, go to /opt/tc3/bin and rename clean-server-cache-multi-query-
server.pkg to clean-server-cache. You can then edit this file to adjust the maximum and preferred
sizes of the cache.

TrueCall Installation and Upgrade Guide 44

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 12 Appendix F: Configuring a Multi Instance Query Server (MIQS)
992-0638-08 Rev. 001

The Update Bookmarks script runs periodic queries during off hours. To enable it, go to /opt/tc3/bin
and rename update-bookmarks-multi-query-server.sh.pkg to update-bookmarks.sh. You will then
need to make two edits to the script.

Uncomment the appropriate TOOL, LOG_FILE_1 and LOG_FILE2 lines for the appropriate tech. You
should ONLY uncomment 1 of each of these.

Near the bottom of the file, update the ARGS_1 and ARGS_2 lines by adding the correct cylinderd
addresses and pull hosts for the different query servers. These should match the arguments for the
TcsTcpServer applications in opt/tc3/etc/config.ini

12.4 Using Daily Reports

The daily reports application has been updated to accept the --disk-path argument. This will enable
the reports for the different Query Servers to be placed in separate folders.

12.5 Ports
Using the UMTS or GSM installations will require the customer to open the default UMTS or GSM
ports in their firewall as opposed to LTE. Default ports are listed in the table below.

Tech processor port Query Server 1 port Query Server 2 port

LTE 54100 61001 61002
UMTS 7782 61005 61006
GSM 54110 61003 61004

Note: These are default values and can be changed during configuration.

TrueCall Installation and Upgrade Guide 45

© NETSCOUT CONFIDENTIAL & PROPRIETARY
 13 Configuring nGenius
Configuration Manager
Beginning in 17.6.2, customers have the option of using the existing Web Admin tool or moving to
the server management tool used in nGenius TrueCall, nGenius Configuration Manager. Note that
NE table uploads require a NETSCOUT cell-based license.

This section outlines how to migrate configuration functions to nGenius Configuration Manager.

13.1 Architecture
The following diagram illustrates the differences between TrueCall deployed with Web Admin and
TrueCall deployed with nGenius Configuration Manager.

13.2 System Prerequisites

You must have the following in place before proceeding with the migration:

TrueCall Installation and Upgrade Guide 46

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

l One nGenius Configuration Manager server (version 6.2 or higher)

o The VM must follow the minimum requirements necessary for nGenius TrueCall.
o Enable SMTP service
o The nGenius Configuration Manager installation should follow the guidelines outlined in the
following section.
l One upload server:
o Single server that will run the different watchers for the different input files and upload
them to the nGenius Configuration Manager server.
o This server should be at least a 2 core machine with 16 Gb RAM.
l Functional TrueCall Server installation with nGenius Configuration Manager supported version
(17.6.2 or higher). This can be one or more servers.
l Install the two required python libraries: python-requests and python-pandas.
1. yum info python-requests
2. yum install python-requests
3. wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-
7.noarch.rpm
4. yum install -y epel-release-latest-7.noarch.rpm
5. yum search python-pandas
6. yum install python-pandas
7. yum remove

13.3 Customer Prerequisites

If using rsync to upload input files, update scripts to point to the new upload server and specified
input directory.

Set up the upload server VM with the required specifications.

Determine which type of setup you will use for NE Tables:

l Single market (global market)—A single NE Table is uploaded to the nGenius

Configuration Manager server and used by all Query Servers.
l Multi market—A different NE Table is used for each market. Each Query Server will download
its NE table from a single configured market.

13.4 LDAP Prerequisites (Optional)

If using LDAP, perform the following:

l Obtain a copy of the LDAP TrueCall configuration file: /opt/tc3/etc/tcaccess.ini

l Obtain a copy of CA certificate if SSL encryption is required
l Obtain the Excel survey file from the customer (this document includes LDAP connection
information and a list of groups with privileges)
l Create a user in LDAP that will work as a nGenius Configuration Manager administrator

TrueCall Installation and Upgrade Guide 47

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

<ncmadmin> and give it its own group property cn=ncmadmin

l Obtain the nG1 database password
l Read the LDAP documentation in the nGenius Configuration Manager online help. Access the
help from the Settings menu in the upper right corner of the console. Refer to CONFIGURING
AND MANAGING nGenius ONE > MANAGING SERVERS AND USERS > Settings Tab >
Authentication > LDAP

13.5 Install nGeniusONE and TrueCall

Perform the following installation steps:

1. On a dedicated nCM server, install nGeniusONE 6.3.0 following the documented installation

procedures.
Download software and documentation from
https://my.netscout.com/mcp/Pages/default.aspx.
2. Install or upgrade TrueCall servers following the procedures in this document with the
following changes:
a. When upgrading, the installation process, by default, does not overwrite the
/etc/sysconfig/truecall-server file. After upgrade, open the file and check to see if the
following lines are present. If not, either manually add or retrieve them from the .pkg file
installed by the installation process.
# Following fields are required for applications that require access to non-local
python files.
# These include NE_Watcher, imsi_whitelist_watcher, application framework and the nCM
python library
# By default PYTHONPATH is empty, adding the required locations.
PYTHONPATH="/opt/tc3/lib/python/site-
packages/appFrameworkPython/Application:/opt/tc3/lib/python/site-
packages/ncmpylib:/opt/tc3/bin"
# Env-variables required by applications using the applicationFrameworkPython
PI_APP_FRAMEWORK_PATH="/opt/tc3/lib/python/site-packages/appFrameworkPython"

b. Refer to TrueCall Server Administration Installation to install the portion of the Server
Administration necessary for nGenius Configuration Manager.
c. After TrueCall is installed or upgraded, run the following command:
service httpd stop

13.6 Configuring the nGenius Configuration Manager Upload Server

Perform the following to configure the upload server:

TrueCall Installation and Upgrade Guide 48

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

1. Start the nGenius Configuration Manager server.

2. Install the TrueCall rpm on the upload server using the instructions in this document.
3. Edit the [NCM] section in /opt/tc3/etc/tcaccess.ini:
You do not need to enter the Username and Password. You will be registering this server as a
trusted server in the next step.
[NCM]
Scheme=https
Hostname=ncm.hostname.com
Port=8443
TrustedServerKey=

Note:
l Hostname should not include https:// or http://
l If using an IPv6 address, enclose it in square brackets.
4. Register the server as a trusted server.
source /opt/tc3/bin/tc3-env.sh
python /opt/tc3/bin/tc_ncm_trusted_server.py --ncm-username={username} --ncm-password=
{password} --enable-stdout-log

Where username and password are the nCM administrator username and password.
5. Create the directory structure for the uploaded files, where each directory owner is
daemon:daemon. These directories are the defaults that the uploader watches.
a. NE Table:
l For a single global setup:
/var/lib/truecall/ne_tables/uploads/
l For a multi-market setup one directory per market is required
/var/lib/truecall/ne_tables/uploads/market1/
/var/lib/truecall/ne_tables/uploads/market2/
/var/lib/truecall/ne_tables/uploads/market3/
/var/lib/truecall/ne_tables/uploads/market4/
b. IMSI whitelist:
/var/lib/truecall/cpni_imsi_whitelist/uploads/
c. handset database
/var/lib/truecall/handset_database/uploads/
d. validation files
/var/lib/truecall/log/ncmvalidations/
6. All TrueCall instances use the same set of handset files. From the upload server, upload
generated files using tc_configuration_uploader to the nCM server, where they can be
downloaded by TcsAdminServer to all TrueCall servers.
Configure /opt/tc3/etc/config.ini to run tc_configuration_uploader and handset_upload_
watcher. The tc_configuration_uploader program uploads the required input files (NE table
and IMSI whitelist) and output files (handset DB):
[TcsTasks]
size=1

TrueCall Installation and Upgrade Guide 49

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

1/label=tc_configuration_uploader
1/fullpath=/opt/tc3/bin/tc_configuration_uploader.py
1/workingdir=/opt/tc3/bin
1/args=--cleanup-retention-days=0

2/label=handset_upload_watcher
2/fullpath=/opt/tc3/bin/handset_upload_watcher
2/workingdir=/opt/tc3/bin
2/args=--reqd-handset-file-types=LTE:imsi,LTE:tac
Where cleanup-retention-days determines the cleanup policy of both the local watched
directories and the files stored on the nCM server (=0 means cleanup is disabled). If cleanup is
enabled, cleanup is performed one time per day at midnight. The script retains the newest
three files regardless of file age. Omit the argument if cleanup is not required or will be
manual.
The handset files for the tc_configuration_uploader are generated by the handset_upload_
watcher. The handset_upload_watcher creates output files at two locations.
l <parent-handset-database-dir>/<tech-family>/active
l <parent-handset-database-dir>/<tech-family>/ncmUploads
The files meant for nCM are prefixed with 3gpp/3gpp2.
If, for testing purposes, you manually put generated handset files in the directories specified
by --source-handset-database-3GPP-output-directory and --source-handset-
database-3GPP2-output-directory, ensure that you prefix the file names with 3gpp or
3gpp2.
tc_configuration_uploader performs a check in each watched input directory and uploads any
new files to the nGenius Configuration Manager server. It also downloads any validation files
stored on the nGenius Configuration Manager server to the target directory.
The handset_upload_watcher can be configured to watch for one or more file types. Following
are the valid values:
--reqd-handset-file-types=LTE:imsi,LTE:tac
--reqd-handset-file-types=LTE:imsi
--reqd-handset-file-types=LTE:imsi,LTE:tac,CDMA/EVDO:min,CDMA/EVDO:meid

7. Run the following scripts to setup and initialize the postgreSQL database file structure:
/opt/tc3/share/WebClient5/conf-database.sh
/opt/tc3/share/WebClient5/conf-webclient.sh
8. Customer scripts to upload files to the new upload server need to be modified. Move all input
files to the watched directory.
9. Restart TrueCall services:
As user "root:"
service truecall-server restart
Using sudo permissions:
sudo service truecall-server restart

TrueCall Installation and Upgrade Guide 50

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

13.7 Converting a Standby to a Primary Server

If the primary server becomes unavailable, you can convert the Standby Server to be the primary
server and continue with normal nGenius TrueCall operations as long as the servers' licenses are
compatible.

Refer to the Converting a Standby to a Primary Server topic in the nGenius TrueCall online help when
the primary server no longer functions properly and needs to be replaced. 

If you are converting the Standby Server only as a test procedure, refer to the Testing the Standby
Server topic.

13.8 Configuring Users in nGenius Configuration Manager

Users can be managed locally with nGenius Configuration Manager or using LDAP, but both
management systems cannot be used at the same time. Before proceeding, decide which method to
use.

13.8.1 Configure Users in nGenius Configuration Manager Manually

Skip this section when transitioning existing users. This section is for adding users manually using
nGenius Configuration Manager. Refer to the online help in the nCM GUI for more assistance with
manually creating roles, groups, and users.

To configure a user in nGenius Configuration Manager:

1. Login into the nGenius Configuration Manager GUI using the administrator account.
2. Open the User Management module.
3. In the Roles tab create any desired roles, assign each role the required TrueCall privileges.
4. In the User Groups tab create as many groups as desired, to each user group assign the
desired roles depending on the required privileges. (The created user group name must
correspond to a group stored in the query server postgres database).
5. In the Users tab create as many users as required. Make sure to:
a. Assign each user to at least one group.
b. Add the configuration manager (nCM/nG1) server in the Server Access section for

TrueCall Installation and Upgrade Guide 51

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

authentication.
c. Add any TrueCall servers that this user will connect to in the Server Access section.

13.8.2 Transition Users to nGenius Configuration Manager

Use this set of procedures to automatically transition users (both those managed currently with Web
Admin and those managed with LDAP) to nGenius Configuration Manager.

Note: All migration scripts discussed in this section are installed by the TrueCall-Server-XXX.rpm.

13.8.2.1 Manually Create Roles in nGenius Configuration Manager

1. Login to nCM using the administrator account.
2. Open the User Management module and click on the Roles tab.
3. Add the following roles and assign the described privileges:

Role Privilege
TCLOGINC TrueCall Client Login
TCCPNI TrueCall Display CPNI Information
TCEMAILD TrueCall Enable Daily E-Mails
TCEMAILS TrueCall Enable Server E-Mails
TCSELFSERVICE Configure User Account Self-Service

13.8.2.2 Run 01UserMigrationExport.py

This program fetches user/group information from PostgreSQL, writes it to files, and sends it to a
central server, where the same information is collected from other TrueCall servers. This program
would need to run only one time from all the TrueCall servers being migrated to nGenius
Configuration Manager.

l The central server can be any TrueCall server but the best choice would be to use the Upload
server as the central server.

TrueCall Installation and Upgrade Guide 52

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

l Make sure --destination-directory exists on the central server.

l This program assumes that ssh key is setup and user can send file to the central server using
scp without entering password. If ssh key is not setup, it asks the user to enter password.
l The local directory specified by --local-directory would be created by the program itself.

Note: To avoid conflict between the nGenius Configuration Manager system administrator user
"administrator" and the TrueCall group name "administrator," the TrueCall group name is
replaced with "tcadministrator."

Command line options:

Option Description
--enable- print the log to standard out (default: False)
stdout-log
--tcaccess- TCACCESS_CONFIG specifies whether a non-default tcaccess file should be used
config (default: /opt/tc3/etc/tcaccess.ini)
--send-file Turn on this option to send the user information file to --destination-hostname.
(default: False)
-- DESTINATION_HOSTNAME Hostname of the computer to which the user information
destination- file will be copied. (default: None)
hostname
-- DESTINATION_DIRECTORY Name of the directory on the destination hostname to
destination- which the user information file will be copied. (default: /var/lib/truecall/user_
directory migration/remote_profiles)
--username USERNAME Name of the account on the destination computer. (default: None)
--local- LOCAL_DIRECTORY Name of the directory on the local computer in which the user
directory information file will be written. (default: /var/lib/truecall/user_migration/local_profiles)

This program takes TrueCall PostgreSQL as input and writes the following files as output:
<hostname>-TcUserInfo.txt
<hostname>-TcGroupInfo.txt

It sends the two files over scp to a central server to a location specified by the --destination-
directory.

13.8.2.3 Run 02GroupsGenerator.py

This program is used to create groups either as part of the fresh installation or migration from
PostgreSQL to nCM. In the first case, the user needs to manually create the input file at the location
specified by --input-directory. In the second case, this program read group information files (coming
from different PostgreSQL machines) at the location specified by --input-directory, combine them by
removing conflicting/duplicate entries and generates the output. In both cases, individual groups are
written in XML format in add_group_<Group Name>.txt files at --output-directory.

It also generates two bookkeeping .txt files:

l all_groups.txt: It has all the groups.

l conflicting_groups.txt: It has only conflicting groups.

TrueCall Installation and Upgrade Guide 53

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

Run this program only on the central server where all the <host>-TcUsersInfo.txt <host>-
TcGroupInfo.txt files are collected. The add_group_<group name>.txt file is used to create groups.

The output directory specified by --output-directory is created when the program is run.

Command line options:

Option Description
--input-directory INPUT_DIRECTORY Input directory where to look for group information
files. (default: /var/lib/truecall/user_migration/remote_profiles)
--output-directory OUTPUT_DIRECTORY Output directory where to put output files. (default:
/var/lib/truecall/user_migration/groups)
--enable-stdout-log Print the log to standard out (default: False)
--server-access SERVER_ACCESS Name of the nCM server, defined as "Server Name" in
the nCM interface in the Server Management Module. Provides nCM
server access to group members so that they can be authenticated.

The program takes its input from <hostname>-TcGroupInfo.txt located at --input-directory.

The program creates the following output:

l add_group_<group name>.txt: It has groups along with their respective permissions in the
following format:
<userGroups>
<userGroup>
<name>nCMadmin</name>
<description>Test user group for nCM testing</description>
<digitsToMask>14</digitsToMask>
<isSliceSize>true</isSliceSize>
<sliceSize>14</sliceSize>
<isDataCaptureOverride>false</isDataCaptureOverride>
<servers>
<server>Configuration Manager</server>
</servers>
<roles>
<role>
<roleCode>TCCPNI</roleCode>
</role>
<role>
<roleCode>TCLOGINC</roleCode>
</role>
</roles>
</userGroup>
</userGroups>

This file does not contain conflicting groups. A conflicting group is defined as a group which is
present in more than one PostgreSQL database and has different set of permissions. This
program writes conflicting groups to the conflicting_groups.txt file.

TrueCall Installation and Upgrade Guide 54

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

This program does not resolve any conflicting group. You can resolve a conflicting group by
looking in the conflicting_groups.txt file and moving it to the add_groups.dat file after making
appropriate adjustments to the permission set.
l all_groups.txt: It has all the groups.
l conflicting_groups.txt: It only has conflicting groups.

13.8.2.4 Run 03UsersGenerator.py

This program is used to create users either as part of the fresh installation or migration from
PostgreSQL to nCM. In the first case, the user needs to manually create the input file at the location
specified by --input-directory. In the second case, this program read user information files (coming
from different PostgreSQL machines) at the location specified by --input-directory, combine them by
removing conflicting/duplicate entries and generates the output.

In both cases, individual users are written in XML format in add_user_<User Name>.txt files at --
output-directory.

It also writes users_info.txt file which contain users information (in the format: e-
mail:username:password) to be used by 05EmailSender.py program to send new nCM passwords to
respective users.

In addition, it generate two bookkeeping .txt files:

l all_users.txt: It has all the users.

l conflicting_users.txt: It has the conflicting users.

The program creates the --output-directory.

Command line options:

Options Description
--input-directory INPUT_DIRECTORY Input directory where to look for group information
files. (default: /var/lib/truecall/user_migration/remote_profiles)
--output-directory OUTPUT_DIRECTORY Output directory where to put output files. (default:
/var/lib/truecall/user_migration/users)
--add-groups- ADD_GROUPS_DIRECTORY Filepath to where add_group_<group name>.txt
directory being generated by 02GroupsGenerator.py is located. (default:
/var/lib/truecall/user_migration/groups)
--enable-stdout-log print the log to standard out (default: False)
--server-access SERVER_ACCESS Name of the nCM server (defined as "Server Name" in
the nCM Server Management module). Provides nCM server access to
users so that they can be authenticated.

The program takes user information from <hostname>-TcUserInfo.txt in the --input-directory. The
group information is located in the directory specified by –add-groups-directory.

The program creates the following output:

l users_info.txt: It has user information in the format email:username:pwd.

The information in this file is used by 05EmailSender.py to send new nCM passwords to uesrs.

TrueCall Installation and Upgrade Guide 55

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

l all_users.txt: It has all the users.

l conflicting_users.txt: It only has conflicting users.
l add_user_<user name>.txt: This file contains information about an individual user. The
following shows a sample user file:
<users>
<user>
<lastName></lastName>
<firstName></firstName>
<name>test1</name>
<email>[email protected]</email>
<password>MDs7tDhM68</password>
<isLocked>false</isLocked>
<isEnabled>true</isEnabled>
<digitsToMask>14</digitsToMask>
<isSliceSize>true</isSliceSize>
<type>Normal</type>
<servers>
<server>Standalone Server</server>
</servers>
<roles>
<role>
<roleCode>TCCPNI</roleCode>
</role>
<role>
<roleCode>TCLOGINC</roleCode>
</role>
</roles>
<userGroups>
<userGroup>nCMadmin</userGroup>
<userGroup>G_TCSELFSERVICE</userGroup>
</userGroups>
</user>
</users>

13.8.2.5 Run 04CreateUsersAndGroups.sh

This program is used to create groups/users using the REST API on the nGenius
Configuration Manager server. It uses the following files:

l add_group_<group name>.txt generated by 02GroupsGenerator.py

l add_user_<user name>.txt generated by 03UserGenerator.py

Note:

l If using an IPv6 address for -ncm_host, enclose it in square brackets.

l Create groups first, then users.
l The nCM server accepts secure http connections, so use https when specifying the ncm
host address.
l This program does not use the trusted key for nCM authentication. Providing the

TrueCall Installation and Upgrade Guide 56

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

username and password is mandatory.

l Directory is the directory in which user/group files are located.

Command line options:

Options Description
--ncm_host nGenius Configuration Manager server host. The nGenius
Configuration Manager only accepts secure http connections, so specify
https in the host address.
--ncm_port nGenius Configuration Manager server port.
--ncm_username nGenius Configuration Manager user name and password. If the
--ncm_pwd underlying server is registered as a trusted server, the username and
password are not required.
--directory Directory where user/group files are located.
--file_type group|user

Sample commands:
./04CreateUsersAndGroups.sh -ncm_host nfw-qencm-01.newwireless.com -ncm_port 8443 -ncm_username
administrator -ncm_pwd netscout -file_type group -directory /var/lib/truecall/user_
migration/groups
/04CreateUsersAndGroups.sh -ncm_host nfw-qencm-01.newwireless.com -ncm_port 8443 -ncm_username
administrator -ncm_pwd netscout -file_type user -directory /var/lib/truecall/user_
migration/users

13.8.2.6 Run 05EmailSender.py

This program notify users of their new TrueCall passwords. While migrating users from postgreSQL
to nCM, passwords can't be exported, so new passwords would be provided.

Users' information is read from users_info.txt generated by 03UsersGenerator.py.

Option Description
--users-info-file USERS_INFO_FILE Input file where to look for user information. The format
is: email:username:password. (default: /var/lib/truecall/user_
migration/users/users_info.txt)
--tcaccess-config TCACCESS_CONFIG Specify if a non default tcaccess file should be used.
The tcaccess.ini requires a [Email] section. The section shall contain
MailServer and EmailAddress options. (default: /opt/tc3/etc/tcaccess.ini)
--email-content-file EMAIL_CONTENT_FILE Specify email content in the file specified by this
option. (default: /var/lib/truecall/user_migration/users/email_content.txt)
--enable-stdout-log print the log to standard out

This program takes the following input:

TrueCall Installation and Upgrade Guide 57

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

users_info.txt: This file takes its input from users_info.txt file specified by the command line option
--users-info-file. This file is generated by 03UserMigrationUsersGen.py program. The users_info.txt
file has one row per each user and its format is:

email:username:pwd

email_content.txt: This file contain subject and content for outgoing mails. There should be two
lines one per subject/content. The format must be following:

subject: <subject>

content: <content>

This program sends email to all the users specified in users_info.txt. The outgoing email format is:

Hi <username>,

<content>

Username: <username>

Password: <pwd>

Thanks,

TrueCall team

Where:

<username> is from users_info.txt

<content> is from the 'content' section in the file specified by the command-line option --email-
content file

<pwd> is from users_info.txt

13.8.3 Transitioning LDAP Users

If TrueCall is already configured to use LDAP, the same configuration will continue working even
after making the switch to nGenius Configuration Manager. Using nGenius Configuration Manager
and LDAP in this fashion might cause some confusion since the users configured locally in the
nGenius Configuration Manager would take precedence over the ones in the LDAP. The nGenius
Configuration Manager can also be configured to authenticate users via LDAP. The following
procedure outlines the steps required to perform such transition.

13.8.3.1 LDAP Prerequisites

If using LDAP, locate the following:

l Copy of the LDAP TrueCall configuration file: /opt/tc3/etc/tcaccess.ini

l Copy of CA certificate if SSL encryption is required
l Obtain a copy of the excel survey file from the customer (this document includes LDAP
connection information and a list of groups with privileges)
l Create a user in LDAP that will work as a nGenius Configuration Manager administrator

TrueCall Installation and Upgrade Guide 58

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

<ncmadmin> you might want to give it its own group property cn=ncmadmin
l nG1 database password
l Get familiar with the LDAP documentation on the nGenius Configuration Manager by reading
the online help, accessed from the Settings menu in the upper right corner of the console.
Refer to CONFIGURING AND MANAGING nGenius ONE > MANAGING SERVERS AND USERS >
Settings Tab > Authentication > LDAP

13.8.3.2 Initial LDAP configuration

1. Login as administrator on your nGenius Configuration Manager server.
2. Open the Authentication Source module and then the LDAP tab.
3. Click on the RED circle right next to LDAP to enable it. Click Yes when prompted to change
authentication to LDAP.
4. Fill in the required connection information as shown in the following table:

nCM tcaccess.ini Parameter Notes

Parameter
DN Prefix cn
Enable SSL Enable this if you need SSL encryption.
connection Please refer to the users guide in how to
import CA certificates.
DN Style raw
Search SearchBase Use only the dc qualifiers from the
Base SearchBase. Omit any ou qualifiers.
Group  SearchBase Any ou qualifiers in SearchBase. Usually
ou=user
Server URI This is the hostname specified in the URI
IP/Host configuration option. Ommit the ldap:// and
any trailing port numbers
 Server Port  URI Any port defined after a colon in the URI
Alternate Alternate hostname or IP
server
IP/Host
Timeout Default value

5. For testing purposes select Use local PM settings.

6. Expand the System Administrator User Configuration panel.
7. In System Administrator Users click on the Add User button.

TrueCall Installation and Upgrade Guide 59

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

a. Type the username for the account <ncmadmin>.

b. Select the roles option button and give the user all of the admin roles.
c. Add any additional usernames you might want to assign an nGenius
Configuration Manager admin role.
8. [Optional] With this configuration any user in the LDAP will have access to the nGenius
Configuration Manager GUI. You can select default roles for all other users other than the
ones selected in the previous step.
9. Click the OK button at the bottom of the page and save the changes
10. Close the browser.
11. Open a terminal and ssh as root into the nGenius Configuration Manager server.
12. Edit the following file
/opt/NetScout/rtm/bin/serverprivate.properties
and add the following lines:
ldap.enable.samaccountname.attr.login=true
ldap.users.common.domain=<custdomain>
ldap.user.principalclass.name=sAMAccountName
replace <custdomain> with the actual ldap domain i.e. netscout
13. Restart the server
cd /opt/NetScout/rtm/bin/
./stop
./start

Login to nGenius Configuration Manager using the <ncmadmin> account. If the ldap configuration is
correct the <ncmadmin> will have access to the server configuration

Note: This <ncmadmin> account will be needed by TrueCall to perform upload/download of files
as well as user authentication

Note: nGenius Configuration Manager seems to reject short passwords even if the password is
valid in LDAP

If login for <ncmadmin> works configuration is correct you can skip to Assign the Correct Roles to
Each Group Configured in LDAP. If not, proceed to the next section.

Reverting to Native Mode Authentication

If the LDAP configuration is wrong you will no longer have access to the web GUI for nGenius
Configuration Manager since enabling LDAP disables nGenius Configuration Manager local users.

To revert the change perform the following steps:

1. Open a terminal to the nGenius Configuration Manager server.

2. Perform the following command to open a psql command line prompt.
cd /opt/NetScout/rtm/bin/ ./EA_set_default.sh
3. Restart the server.
4. Log in to the server web page using administrative account credentials. Following are the
NETSCOUT default values for the web administrative account:

TrueCall Installation and Upgrade Guide 60

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

User: administrator
Password: netscout1

13.8.3.3 Assign the Correct Roles to Each Group Configured in LDAP

1. Login as administrator on the nGenius Configuration Manager server.
2. User Roles and user groups should already be present since they will be created the user
migration tool described in Transition Users to nGenius Configuration Manager in this
document.
3. Open the User Management module and select the User Groups tab.
4. Review that all the groups defined in the LDAP server are present in the nGenius
Configuration Manager server.
5. Open the Authentication Source module and select the LDAP tab.
6. In the User Configuration section select Use LDAP server settings.
7. Select the groups option and add + the groups imported by the migration tool as well as the
ncm administrator group.
8. Click OK at the bottom of the page to save the changes.
9. Stop and restart the server
cd /opt/NetScout/rtm/bin/
./stop
./start
10. Finally disable the TrueCall LDAP authentication by setting Enable=false in the [LDAP]
section of /opt/tc3/etc/tcaccess.ini on the Query Server.

13.9 Configure TrueCall Components

Use these procedure to configure each query server to be configured or updated.

The TcsAdminServer downloads different configuration files depending on the underlying

configuration. For example, the standalone ETL requires only the handset database files from nCM,
so configure the TcsAdminServer to download only handset database files.

The following table explains which TrueCall components require which files from nCM.

Files

Programs Handset IMSI Whitelist NE Table

Database

Standalone Cylinder Yes N/A N/A

Standalone ETL Yes N/A N/A
Standalone QS Yes Yes Yes
QS + CYL + ETL Yes Yes Yes

Perform the following steps on each TcsAdminServer:

TrueCall Installation and Upgrade Guide 61

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

1. Stop the TrueCall services in each server to be updated.

service truecall-server stop
2. Update the tcaccess.ini file with relevant ncm configuration and Bing maps credentials.
You do not need to enter a Username and Password. You will be registering this server as a
trusted server in the next step.
[NCM]
Scheme=https
Hostname=ncm.hostname.com
Port=8443
TrustedServerKey=
3. Register the server as a trusted server.
source /opt/tc3/bin/tc3-env.sh
python /opt/tc3/bin/tc_ncm_trusted_server.py --ncm-username=
{username} --ncm-password={password} --enable-stdout-log
Where username and password are the nGenius Configuration Manager administrator
username and password.
This registers the server as a trusted server and returns an authentication key for TrueCall to
use. Edit /opt/tc3/etc/tcaccess.ini to include the generated key and ensure that the username
and password are left empty. The nCM section should look like this:
[NCM]
Scheme=https
Hostname=ncmserver.hostname.com
Port=8443
User=
Password=
TrustedServerKey=IGGsDcJnZ1AZasdidAasd+AsdaASDs3346ASDaFsfad==
Note: If the server had already been registered to the nCM as a trusted server, the
registration tool will not generate a new key. If so, use the nCM GUI to retrieve the key or
remove the server before trying the registration again.
4. Enable the nCM configuration so that the TcsAdminServer can download configuration files
from nCM:
OPTIONS="--stat-output-interval=5 --stat-output-logger=0 --stat-
output-file=/var/lib/truecall/log/TcsAdmin-init.d.stat --pre-config-
file=/opt/tc3/etc/preConfig.json --want-configuration-downloader=1
5. Add the following parameters to the TcsAdminServer command-line options in
/etc/sysconfig/truecall-server to tell the system where to look for the uploaded
files:
Important: The following TcsAdminServer parameters serve as a switch in addition to
defining directories. Leave the parameter blank if you do not want to use it. For example, if
you don't want to download handset files on a particular machine, don't specify a path using -
-destination-handset-output-directory.
--destination-handset-output-directory arg The parent directory to put the
handset related output files downloaded from the nCM server. Under the parent directory,
sub directories will be created for 3GPP/3GPP2.

TrueCall Installation and Upgrade Guide 62

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

--handset-output-files-type arg (=0) Use this option to specify whether to

download 3GPP or 3GPP2 files or both. 0 => Both, 1 => 3GPP, 2 => 3GPP2.
--destination-ne-directory arg The local directory to put the network elements table
file downloaded from the nCM server.
--source-markets arg (=global) A comma-separated list of markets on the nCM
server from where to download the latest network elements table files.
--destination-imsi-whitelist-directory arg The local directory to put the IMSI
whitelist file downloaded from the nCM server.
6. Configure handset database files:
The TcsAdminServer downloads ready-to-use handset files directly from nCM; there is no
need to run handset_upload_watcher on every server to generate handset files. The user can
specify whether to download 3GPP/3GPP2/Both files using the --handset-output-
files-type parameter.
Configure TcsAdminServer to download 3GPP files using the following command:
OPTIONS="--stat-output-interval=5 --stat-output-logger=0 --stat-output-
file=/var/lib/truecall/log/TcsAdmin-init.d.stat --pre-config-
file=/opt/tc3/etc/preConfig.json --want-configuration-downloader=1 --destination-handset-
output-directory=/var/lib/truecall/handset_database --handset-output-files-type=1

7. Configure TcsAdminServer to download NE tables:

For global markets:
OPTIONS="--stat-output-interval=5 --stat-output-logger=0 --stat-output-
file=/var/lib/truecall/log/TcsAdmin-init.d.stat --pre-config-
file=/opt/tc3/etc/preConfig.json --want-configuration-downloader=1 --destination-handset-
output-directory=/var/lib/truecall/handset_database --handset-output-files-type=1 --
destination-ne-directory=/var/lib/truecall/ne_tables # By default, the --source-markets is
global.

For multi-market or market-specific configuration (where market1 is the market name):

OPTIONS="--stat-output-interval=5 --stat-output-logger=0 --stat-output-
file=/var/lib/truecall/log/TcsAdmin-init.d.stat --pre-config-
file=/opt/tc3/etc/preConfig.json --want-configuration-downloader=1 --destination-handset-
output-directory=/var/lib/truecall/handset_database --handset-output-files-type=1 --
destination-ne-directory=/var/lib/truecall/ne_tables --source-markets=market1"

Add ne_watcher to config.ini:

N/label=ne_watcher
N/fullpath=/opt/tc3/bin/NE_Watcher.py
N/workingdir=/opt/tc3/bin
N/args=
8. Configure TcsAdminServer to download the IMSI whitelist:
OPTIONS="--stat-output-interval=5 --stat-output-logger=0 --stat-output-
file=/var/lib/truecall/log/TcsAdmin-init.d.stat --pre-config-
file=/opt/tc3/etc/preConfig.json --want-configuration-downloader=1 --destination-handset-
output-directory=/var/lib/truecall/handset_database --handset-output-files-type=1 --
destination-ne-directory=/var/lib/truecall/ne_tables --source-markets=market1" --
destination-imsi-whitelist-directory=/var/lib/truecall/cpni_imsi_whitelist

TrueCall Installation and Upgrade Guide 63

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

Add imsi_whitelist_watcher to config.ini:

N/label=imsi_whitelist_watcher
N/fullpath=/opt/tc3/bin/IMSI_Whitelist_watcher.py
N/workingdir=/opt/tc3/bin
N/args=
9. For the ETL, perform the handset database configuration step from above.
10. For Cylinder, perform the handset database configuration step from above.
11. For the Query Server, perform the handset database, NE table, and IMSI whitelist
configuration steps from above.
Ad the following parameter to the TcsTcpServer task in /opt/tc3/etc/config.ini.
If they have already been defined in Web Admin (if this is an upgrade), you can leave these
blank and use the values from the database if desired.
--timezone=timezone
--nsa-server-address=nsaserverhost:nsaport
--isa-server-address=isaserverhost:isaport
--user-idle-time-min=idletime
--sent-by-email-address=emailaddress
Where:
l timezone of the server using canonical geographic timezone identifiers. Example:
America/Los_Angeles
l nsaserverhost: IP address for the nGenius Session Analyzer server
l nsaport: port for the nGenius Session Analyzerserver
l isaserverhost: IP address for the ISA server
l isaport: port for the ISA server
l idletime: the number of minutes of idle time before a user is logged out of the client
l emailaddress: the email address that appears in the "from" field on system generated
emails
12. Restart TrueCall.
As user "root:"
service truecall-server restart
Using sudo permissions:
sudo service truecall-server restart

13.9.1 Configure the Daily Report Email

Daily report emails are enabled using crontab:
LD_LIBRARY_PATH=/opt/tc3/lib /opt/tc3/bin/daily-report --cylinderd-host
HOSTNAME --cylinderd-port PORT_NUMBER --vendortech COMMON_LTE COMMON_
UMTS HUA_CDMA >> /var/lib/truecall/log/daily-report-cron.log 2>&1

By default, the list of recipients is obtained from the local PostgreSQL database. After nGenius
Configuration Manager is enabled, the list of email recipients is obtained from nCM and are those
with EMAILD privilege granted.

TrueCall Installation and Upgrade Guide 64

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

Change all the configured cronjobs by passing the command line argument --want-ncm-
configuration:
LD_LIBRARY_PATH=/opt/tc3/lib PI_APP_FRAMEWORK_
PATH=/opt/tc3/lib/python/site-packages/appFrameworkPython/
PYTHONPATH=/opt/tc3/lib/python/site-
packages/appFrameworkPython/:/opt/tc3/lib/python/site-
packages:/opt/tc3/bin /opt/tc3/bin/daily-report --cylinderd-host
HOSTNAME --vendortech COMMON_LTE COMMON_UMTS HUA_CDMA --want-ncm-
configuration 1 >> /var/lib/truecall/log/daily-report-cron.log 2>&1

Replace HOSTNAME with the actual hostname where the cylinder is located. This generates the
report for each of the technologies specified in --vendortech, but only if the technologies are
using the default port. If using non-default ports, use --cylinderd-port to specify the port for
one vendor tech at a time.

13.9.2 Configuration for Dual Stack Networks

This section only applies to servers configured to use a dual stack interface to enable both IPv4 and
IPv6.

For these servers, the trusted registration tool detects the IPv6 interface and prioritizes it. Then the
nGenius Configuration Manager associates the trusted key with the IPv6 address not the IPv4
address. Requests using this key coming from the IPv4 address will be rejected by the nCM and, as a
result, a 401 or 403 error (unauthorized access) appears in the TrueCall logs. Connections made
using IPv6 will not have problems.

Check the route used between two servers by using either ping or traceroute as shown in the
following examples:
ping hostname-to-ncm-server
ping6 hostname-to-ncm-server
traceroute hostname-to-ncm-server

Note which of the two pings work (ping for IPv4 and ping6 for IPv6) or note the final hop of the
traceroute output. The traceroute determines the correct IP version to use. Compare that to the
address reported in the nCM GUI.

If the nCM GUI shows an IPv6 address, but the test result shows an IPv4, then the registration tool
needs to be forced to use the IPv4 address instead. Remove the IPv6 address from the nCM using
the GUI and register the server again using the following command on the server to register it as a
trusted server.
source /opt/tc3/bin/tc3-env.sh
python /opt/tc3/bin/tc_ncm_trusted_server.py --ncm-username={username} -
-ncm-password={password} --local-hostname={trusted server hostname} --
local-ipv4={trusted server ipv4 address}
--enable-stdout-log

Copy the new generated key to the /opt/tc3/etc/tcaccess.ini file.

TrueCall Installation and Upgrade Guide 65

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

13.10 Register User Groups with the Query Server

After you have created user groups, you need to register them with the nCM so that users belonging
to the groups on the server can log in.

Run registerGroupsWithHostname.py

Command line options:

Option Description
--enable- Print log messages to stdout. (default: False)
stdout-log
--tcaccess- TCACCESS_CONFIG Specify if a non default tcaccess file should be used. The
config tcaccess.ini requires a [Email] section. The section shall contain MailServer and
EmailAddress options. (default: /opt/tc3/etc/tcaccess.ini)
--ncm-scheme NCM_SCHEME Scheme or protocol used for communication with the nCM server.
Scheme will override the scheme provided in tcaccess.ini. If the scheme is provided as
a command-line argument, the hostname and port have to be provided as well. If the
hostname is provided but not scheme, the scheme will default to https. (default: None)
--ncm-hostname NCM_HOSTNAME Hostname will override the hostname provided in tcaccess.ini.
Enclose IPv6 addresses in square brackets. (default: None)
--ncm-port NCM_PORT Port will override the port provided in tcaccess.ini. (default: None)
--ncm-username NCM_USERNAME Provide an administrator username to authenticate with the nCM
server. (default: None)
--ncm-password NCM_PASSWORD Provide the administrator password to authenticate with the nCM
server. (default: None)
--local- LOCAL_HOSTNAME Hostname with which to register user groups available on the
hostname underlying QueryServer. The hostname will be automatically determined by the
program. Use this option to set --local-hostname manually. (default: None)

Sample command:
/opt/tc3/bin/registerGroupsWithHostname.py --enable-stdout-log

The user groups are fetched from the PostgreSQL database. If the fetched user group is present on
the nCM server, it gets registered with the Query Server hostname. To verify, log into the nCM GUI
and open the User Management module and the User Groups tab. Users should appear in the group
with access to the host (Server Access pane).

TrueCall Installation and Upgrade Guide 66

© NETSCOUT CONFIDENTIAL & PROPRIETARY
Ver. 6.3.0 | 2020-03-31 13  Configuring nGenius Configuration Manager
992-0638-08 Rev. 001

13.11 Configuring Subscription Delivery Services

Subscription endpoints can be registered to nGenius Configuration Manager to make some TrueCall
services available to external applications. This configuration is only required when using nCM and
the services described in the following table.

Service Exposed by Service Name Vendor Tech

Cylinder Query Server LSR All vendor technologies
PLP PLP PLP Common LTE
Export Location Record processor-common-lte ELR Common LTE

Refer to the appropriate section in the TrueCall Configuration Guide for configuration procedures
specific to each service.

TrueCall Installation and Upgrade Guide 67

© NETSCOUT CONFIDENTIAL & PROPRIETARY