TC1601en-Ed05 TSAPI Deployments For Voice Recorder

Technical Bulletin TSAPI Premium Server
TC1601 ed.05 Release 7.3.2 and above
TSAPI Premium Server: TSAPI Server

deployment in voice recorder context
This document gives the different ways to deploy the Alcatel-Lucent TSAPI Premium Server in Voice Recording System
(VRS) context.
Revision History
Edition 1: January 11, 2012 creation of the document

Edition 2: February 13, 2012 update of the document
Edition 3: February 20, 2013 update of the document
Edition 4: October 17, 2013 update of the document
Edition 5: May 26, 2021 update of the document
Legal notice:
www.al-enterprise.com The Alcatel-Lucent name and logo are trademarks of Nokia used under license by ALE. To view other
trademarks used by affiliated companies of ALE Holding, visit: www.al-enterprise.com/en/legal/trademarks-copyright. All
other trademarks are the property of their respective owners. The information presented is subject to change without notice.
Neither ALE Holding nor any of its affiliates assumes any responsibility for inaccuracies contained herein.
© Copyright 2021 ALE International, ALE USA Inc. All rights reserved in all countries.
Table of contents
1 Description ............................................................................................................................................. 4
2 Alcatel-Lucent TSAPI Premium release...................................................................................................... 4
3 Alcatel-Lucent TSAPI Premium components .............................................................................................. 4

3.1 Mandatory Alcatel-Lucent TSAPI components ..................................................................................... 4
3.2 Optional TSAPI Client used to check the TSAPI configuration ............................................................... 4
4 Stand-Alone deployment .......................................................................................................................... 5
4.1 Scheme of the architecture: 1 OXE and 1 TSAPI Server ....................................................................... 5
4.2 Alcatel-Lucent TSAPI Premium Server installation ................................................................................ 5
5 TSAPI deployment in OmniPCX Enterprise Network ................................................................................. 11
5.1 Scheme of the architecture: network of 2 OmniPCX Enterprise and 2 TSAPI Servers (2 instances) ....... 11
5.2 Alcatel-Lucent TSAPI Premium Servers installation ............................................................................ 12
5.2.1 TSAPI configuration in order to create the 1st TSAPI link ............................................................ 13
5.2.1.1 Installation of the 1st Alcatel Open Telephony Server service (linked to OXE 1 – port 3595) .....................13
5.2.1.2 Management of the TSAPI link concerning the OXE1 on the port 3595 ...................................................13
5.2.2 TSAPI configuration in order to create the 2nd TSAPI link ........................................................... 16
5.2.2.1 Installation of the 2nd Alcatel Open Telephony Server service (linked to OXE 2 - port 3596) ....................16
5.2.2.2 Management of the TSAPI link concerning the OXE2 on the port 3596 ...................................................17
6 TSAPI Backup deployment (one OXE) ..................................................................................................... 19

6.1 Scheme of the architecture: 1 OXE, 1 TSAPI Server Main / TSAPI server Backup ................................ 19
6.2.1 TSAPI Server “Main” ................................................................................................................. 20
6.2.2 TSAPI server “Backup” .............................................................................................................. 21
7 TSAPI Backup deployment (OXE in network) ........................................................................................... 22
7.1 Scheme of the architecture: network of 2 OmniPCX Enterprise and 2 TSAPI Servers (2 instances) and 3
TSAPI Backup (one per instance) ........................................................................................................... 22
7.1.1 Main TSAPI server Configuration ................................................................................................ 23
7.1.1.1 TSAPI configuration in order to create 2 links each with a dedicated Backup. ..........................................23
7.1.2 Backup TSAPI configuration ....................................................................................................... 29
7.1.2.1 After installation of one Backup instance, start this instance: .................................................................29
7.1.2.2 Install the second Backup instance ......................................................................................................29
8 TSAPI Server deployment in OmniPCX Enterpise duplicated mode ............................................................ 31

8.1 Scheme of the architecture: 1 OXE in duplicated mode and 1 TSAPI Server ........................................ 31
9 TSAPI Server deployment in OmniPCX Enterprise Spacial Redundancy mode ............................................ 33
9.1 Scheme of the architecture: 1 OXE in spacial redundancy mode and 1 TSAPI Server ........................... 33
TSAPI Premium Server - Release 7.3.2 and above

TSAPI Premium Server: TSAPI Server deployment in voice recorder context TC1601 ed.05
© Copyright 2021 ALE International, ALE USA Inc. page 2/50
10 TSAPI Server deployment in OmniPCX Enterprise PCS (Passive Call Server) mode ................................... 35
10.1 Scheme of the architecture: Call Servers (Main & Stanby) and PCS located in different subnetwork ... 35
11 TSAPI Server deployment in multiple TSAPI Clients solution ................................................................... 36
11.1 Scheme of the architecture: 1 OXE, 1 TSAPI Server and 2 TSAPI Clients .......................................... 36
11.2 Alcatel-Lucent TSAPI Premium Servers installation .......................................................................... 37
12 Max numbers of TSAPI Instances installed on a physical server .............................................................. 38
12.1 Scheme of the architecture ............................................................................................................ 38
12.2 Limitations .................................................................................................................................... 38
13 Max numbers of TSAPI Clients connected to same TSAPI Server ............................................................ 39
13.1 Scheme of the architecture ............................................................................................................ 39
13.2 Limitations .................................................................................................................................... 39
14 Multiple CSTA links typed for voice recorder in OXE ............................................................................... 40

14.1 OXE Release R12 M1 ..................................................................................................................... 40
14.2 OXE Release R12.1 M2.300 ............................................................................................................ 40
14.3 OXE Release R12.3.1 M4.500 – Double IP duplication ...................................................................... 41
15 TSAPI Server uninstallation .................................................................................................................. 42
15.1 TSAPI Server with only one instance (OXE stand-alone) .................................................................. 42
15.2 TSAPI Server with two instances (OXE in netwrok) .......................................................................... 45
15.3 Old TSAPI Server version (Release ≤ 7.0.3) ..................................................................................... 46
16 OXE /TSAPI High availabiltiy solutions basis .......................................................................................... 46

16.1 TSAPI capabilities .......................................................................................................................... 46
16.2 Single CS, single TSAPI Server ....................................................................................................... 47
16.3 Main/Stand-by (duplicated) CSs, single TSAPI Server ...................................................................... 47
16.4 Spacial redundancy, single TSAPI server ......................................................................................... 47
16.5 Spacial redundancy, two TSAPI Server ........................................................................................... 48
16.6 Main/Stand-by (Duplicated) CSs or single CS with PCS, 1 TSAPI Servers .......................................... 48
16.7 Spacial redundancy with PCS, 2 TSAPI Servers ............................................................................... 49
16.8 Others TSAPI Servers deployments ................................................................................................ 49

1 Description
This document describes the different ways to deploy the Alcatel-Lucent TSAPI Premium Server in an
OmniPCX Enterprise solution (Stand Alone or Network) with Voice Recording Systems (VRS).
This is an Alcatel-Lucent Enterprise document which concerns all AAPP VRS deployments from a TSAPI
Premium / OmniPCX Enterprise point of view. Your VRS vendor may have others documents dedicated
to its solution deployment with Alcatel-Lucent Enterprise TSAPI Premium Server.
2 Alcatel-Lucent TSAPI Premium release

Please refer to the dedicated Technical Communication “TC1602en-Minimum release of TSAPI & OXE
in Voice Recording Solution .doc”.
To download the release of the Alcatel-Lucent TSAPI Premium Server, please connect to the AAPP web
site.
3 Alcatel-Lucent TSAPI Premium components
3.1 Mandatory Alcatel-Lucent TSAPI components

- TSAPI Server : this is the CSTA client which is connected to the CSTA server ( CSTAmono
process of the OmniPCX Enterprise ). The name of the service which will be installed is “Alcatel
Open Telephony Server”,
- TSAPI Manager : this is the graphic interface to manage the TSAPI Server, used among other
to define the IP address of the OmniPCX Enterprise, the name and type of the TSAPI link. This
component is known under the name “Alcatel-Lucent OmniPCX OTS Manager”.
3.2 Optional TSAPI Client used to check the TSAPI configuration

The TSAPI Client is an optional component. 2 TSAPI clients are available:
- dll TSAPI client csta32.dll + testing tool cstatst32.exe
- dll TSAPI client csta64.dll + testing tool cstatst64.exe
This component is included in the “Typical” TSAPI installation if all the TSAPI components are installed
in the same physical server. Nevertheless TSAPI Client can also be installed on a dedicated physical
machine (server or PC client).
The TSAPI Client is used to check the TSAPI Server configuration and to emulate the TSAPI requests
sent by a Voice Recorder system.

4 Stand-Alone deployment
 Stand-alone deployment : from an OmniPCX Enterprise point of view, this is a single OXE
node.
 In a real VRS deployment, the TSAPI Client is a VRS component.
4.1 Scheme of the architecture: 1 OXE and 1 TSAPI Server
TSAPI
OmniPCX Enterprise Manager
CSTA link TSAPI Premium

CSTAmono
Server
TSAPI
Client
Default Port TSAPI link
Port 2555 3595
4.2 Alcatel-Lucent TSAPI Premium Server installation

In this document, Only installation of the TSAPI Server on windows server is presented in this
document.
The steps to install all the TSAPI Server MAIN components are described below.
Also you can refer to the document “install.pdf” (folder Documentation), for a windows deployment,
available from the cdrom of the Alcatel-Lucent TSAPI Premium Server.
By default, the TSAPI connection port is equal to 3595 and will be used during the installation detailed
in this document.
In order to choose another port, if this port 3595 is already used by another application, please follow
TSAPI Premium Server document (“install.pdf”).
The TSAPI Premium Server software is available on the AL-E Business Partner Web Site.

From the cdrom, double-click on “run_setup” to run the TSAPI Server installation:
The Typical installation start by the installation of the “Alcatel Omnipcx Open Telephony Server”:

At this step, if you check in the Services window, the “Alcatel Open Telephony Server” is installed:

Next installation is the “OmniPCX TSA Manager” component:
❶ ❷

At this step the OTS Manager is installed, you can check its installation from the list of the installed
program:
Also from the Control Panel \ Programs
To continue the installation of the TSAPI client component, you have to select which TSAPI client you
want to use:
First, click on the identified object to open the TSAPI Client Setup box.
Then select the “32-bit”, and click OK

At this step, the TSAPI client has been installed.
From the Control Panel \ Programs, check the TSAPI client is installed:
Then click Exit to quit the Setup interface.

5 TSAPI deployment in OmniPCX Enterprise Network
 OmniPCX Enterprise network : At least 2 nodes connected through ABC-F link.

 One TSAPI Server installation per OmniPCX Enterpise node .
 In a real VRS deployment, the TSAPI client is a VRS component.
5.1 Scheme of the architecture: network of 2 OmniPCX Enterprise and 2

TSAPI Servers (2 instances)
OmniPCX Enterprise
1
TSAPI
TSAPI link Client
CSTAmono CSTA link
TSAPI Premium Server (through
Instance 1 (3595) 3595)
Port
2555 TSAPI
Port Manager
3595
TSAPI Premium Server
ABC-F
Instance 2 (3596) (through
link
3596)
CSTA link
OmniPCX Enterprise
TSAPI link The 2 TSAPI Server
2
instances MUST NOT be
managed through the
Port
CSTAmono TSAPI same connection port.
3596 Client 2
Port
2555

5.2 Alcatel-Lucent TSAPI Premium Servers installation
One TSAPI Server installation is required per Node on which devices will be monitored and recorded.
In the above architecture, we took the example of 2 OmniPCX Enterprise nodes in ABC-F network.
To install the 2 TSAPI Servers, please follow the document “install.pdf” (folder Documentation), for a
windows deployment, available from the cdrom of the Alcatel-Lucent TSAPI Premium Server.
During the installation, the TSAPI connection port will be equal to 3595 for the first instance of TSAPI
and 3596 for the second TSAPI instance. This is because, in this deployment example, we are using
the same physical system for the TSAPI Servers. So, 2 different ports are required.
In order to choose another port because port 3595 and/or 3596 is already used by another
application, please follow the description on the document “install.pdf”.
Don’t manage the 2 TSAPI Servers through the same connection port number.
Concerning the management of each TSAPI Server (instance), you have to connect each TSAPI Server
independently. That means, from the TSAPI Manager (Start/All Programs/ Alcatel-Lucent OmniPCX
OTS Manager ) you have to connect the TSAPI Server (instance) by entering its port connection ( in our
example : 3595 for the instance 1 and 3596 for the instance 2 ).
Thos ports 3595 and 3596 are taken as an example and could be different number according to the
customer environment.
From the services window:
In this example, the “Alcatel Open Telephony Server “ is one TSAPI Server instance on port 3595, and
the “Alcatel Open Telephony Server2” is the second TSAPI Server instance on port 3596.
Open the OTS Manager and enter the port number associated to the TSAPI
Server you want to configure:

5.2.1 TSAPI configuration in order to create the 1st TSAPI link
5.2.1.1 Installation of the 1st Alcatel Open Telephony Server service (linked to OXE 1 – port
3595)
- From the CD Rom, run_setup.exe (typical).
- From the "Services" window, Start the created service:
5.2.1.2 Management of the TSAPI link concerning the OXE1 on the port 3595

5.2.2 TSAPI configuration in order to create the 2nd TSAPI link
5.2.2.1 Installation of the 2nd Alcatel Open Telephony Server service (linked to OXE 2 - port
3596)
- Copy and rename the following files under C:\Program Files(x86)\Alcatel\OmniPCXTSA:

- Service TSA.exe --> Service TSA1.exe
- service tsa.ini --> service tsa1.ini
Then, renamed the files:
 Create the instance "Alcatel Open Telephony Server1"

- Start/Run/cmd
- C:\Documents and Settings\Administrator>cd "C:\Program Files(x86)\Alcatel\OmniPCXTSA"
- C:\Program Files\Alcatel\OmniPCXTSA>"Service TSA1.exe" �install 3596
Alcatel Open Telephony Server1 installed -> BinaryPath:
"C:\Program Files\Alcatel\OmniPCXTSA\Service TSA1.exe"
hit return to exit
 From the "Services" window, start the 2nd OTS service ("Alcatel Open Telephony Server1") :

5.2.2.2 Management of the TSAPI link concerning the OXE2 on the port 3596



6 TSAPI Backup deployment (one OXE)
 This TSAPI Backup deployment is applicable to OmniPCX Enterprise in stand-alone as well as

OmniPCX Enterprise in network .
6.1 Scheme of the architecture: 1 OXE, 1 TSAPI Server Main / TSAPI server
Backup
10.10.10.1
TSAPI Manager
Port
(through 3595)
2555
OmniPCX Enterprise

CSTAmono
Server Main
TSAPI link
TSAPI
Port Client 1
Physical server
3595
CSTA link IP Lan
20.20.20.1
TSAPI Premium
Server Backup
Physical server

To deploy the TSAPI Backup configuration, 2 physical servers are required, 1 physical system for the
TSAPI Server “Main” and 1 physical system for the TSAPI Server “Backup”.
6.2.1 TSAPI Server “Main”
Please follow the section 4.2 in this document to install the TSAPI Server “Main”.
After installing the TSAPI Server “Main”, the existence of the TSAPI Server “Backup” must be known by
the TSAPI Server “Main” in order to switchover as soon as the TSAPI Server “Main” is down.
From the “Alcatel-Lucent OmniPCX OTS Manager” interface, we connect to the TSAPI Server Main.
At the “Server configuration – OTS Nodes”, we have to add another entry ( more than the TSAPI
Server “Main” IP address ) : the IP address where the TSAPI Server “Backup” is installed and running.
Also for this entry, the Backup check box has to be checked.
The above screenshot shows that the TSAPI Server “Main” (Administration), on port 3595, has
a TSAPI Server “Backup” located on the IP address 10.10.10.1.

6.2.2 TSAPI server “Backup”
TSAPI Server Backup is installed by choosing “advanced”, “Alcatel OmniPCX OTS” and then “Install”
after running the setup (run_setup.exe] of the TSAPI Premium Server.
By this way, we will be able to choose and install only the TSAPI Server and not the 2 others TSAPI
components (TSAPI Manager and TSAPI Client).
No management is required on the TSAPI Server Backup.
The TSAPI Server must be only installed and running. That explains why no extra TSAPI components
(like the TSAPI Manager) are needed on this physical server.

7 TSAPI Backup deployment (OXE in network)
 OmniPCX Enterprise network : At least 2 nodes connected through ABC-F link.
 One TSAPI Server installation per OmniPCX Enterpise node .
 In a real VRS deployment, the TSAPI client is a VRS component.
 One TSAPI Backup per TSAPI Server instance
7.1 Scheme of the architecture: network of 2 OmniPCX Enterprise and 2

TSAPI Servers (2 instances) and 3 TSAPI Backup (one per instance)
20.20.20.1
TSAPI Premium TSAPI Premium

Server Backup Server Backup
(Instance 1) (Instance 2)
OmniPCX Enterprise
1 10.10.10.1 TSAPI
TSAPI link Client
CSTAmono CSTA link
TSAPI Premium Server (through

Instance 1 (3595) 3595)
Port
2555 TSAPI
Port Manager
3595 TSAPI Premium Server
ABC-F
Instance 2 (3596) (through
link
3596)
CSTA link
OmniPCX Enterprise
TSAPI link The 2 TSAPI Server
2
instances MUST NOT be
managed through the
Port TSAPI
CSTAmono same connection port.
3596
Client 2
Port
2555

7.1.1 Main TSAPI server Configuration
7.1.1.1 TSAPI configuration in order to create 2 links each with a dedicated Backup.
 Installation of the 1srt instance (linked to OXE 1 – port 3595): from the CD Rom, run_setup.exe
(typical).
 From the "Services" window, Start the created instance:
 Installation of the 2nde instance (linked to OXE 2 – port 3596):

Copy and rename the following files under C:\Program Files\Alcatel\OmniPCXTSA:
After renamed the files:
Create the instance "Alcatel Open Telephony Server1"

- Start/Run/cmd
- C:\Documents and Settings\Administrator>cd "C:\Program Files\Alcatel\OmniPCXTSA"
- C:\Program Files\Alcatel\OmniPCXTSA>"Service TSA1.exe" –install 3596

hit return to exit
 From the "Services" window, start the 2 TSAPI instances:
 Management of the link concerning the OmniPcx Enterprise 1
The first time the OTS manager is

launched, the default password
(SuperUser) has to be changed.

node1 is the hostname associated to
Call Server 1 IP address.

C:\WINNT\system32\drivers\etc\hosts
192.168.6.65 node1
172.27.132.22 node2

TSAPI Main management:

192.168.6.81 is the IP address of the
server on which the instance of the
Main TSAPI (service "Alcatel Open
Telephony) is installed and started.
 Administration has to be checked.
If TSAPI Backup management:

Backup TSAPI (service "Alcatel Open
 Backup has to be checked.


To define the type of the TSAPI link:

 CSTA V2



 Management of the link concerning the OmniPcx Enterprise 2

node2 is the hostname associated to
the Call Server 2 IP address.

C:\WINNT\system32\drivers\etc\hosts
192.168.6.66 node1
172.27.132.22 node2

TSAPI Main management:
Main TSAPI (service "Alcatel Open
 Administration has to be checked.
If TSAPI Backup management:

Backup TSAPI (service "Alcatel Open
 Backup has to be checked.
To define the type of the TSAPI link:

CSTA V2




7.1.2 Backup TSAPI configuration
7.1.2.1 After installation of one Backup instance, start this instance:

On the Backup server, only the TSAPI Server part has to be installed (no TSAPI client either OTS manager).
 from the CD Rom, Servers\OmniPcx TSA\Setup.exe
7.1.2.2 Install the second Backup instance

 Copy and rename the following files under C:\Program Files\Alcatel\OmniPCXTSA:

After renamed the files:
 Create the instance "Alcatel Open Telephony Server1"

- Start/Run/cmd
- C:\Documents and Settings\Administrator>cd "C:\Program Files\Alcatel\OmniPCXTSA"
- C:\Program Files\Alcatel\OmniPCXTSA>"Service TSA1.exe" –install 3596
hit return to exit
Opening the file "service tsa1.ini", the tsa_port has to be equal to 3596 as specified in the installation
command.
Refresh the "services" windows.
 Start the new created instance

After starting the 2 instances, the 2 following folders will be present:
C:\Program Files\Alcatel\OmniPCXTSA\dyn\nicevm@3595
C:\Program Files\Alcatel\OmniPCXTSA\dyn\nicevm@3596
Now each Main instance has its dedicated Backup instance.

8 TSAPI Server deployment in OmniPCX Enterpise duplicated mode
 From the OmniPCX enterprise point of view, two CPUs in the same shelf or same subnetwork
 Also called “Main/Stand-By”
 Duplicated : Is not equal to OmniPCX Enterprise « Spacial Redundancy » .
8.1 Scheme of the architecture: 1 OXE in duplicated mode and 1 TSAPI

Server
Same shelf or
Same subnetwork
Call Server A Main Port TSAPI Manager

Stand-by 2555 Port
(through 3595)
3595
CSTAmono
TSAPI Premium
CSTA link Server
TSAPI link
Call Server B Stand-by TSAPI
Main Client
CSTAmono
In the OmniPCX Enterprise, the role addressing is managed : Main IP address and Stand-By IP
address.
The TSAPI Premium Server will connect the Main IP address (so to the call server which is in Main
role).

There is only 1 TSAPI Server installed and running. The TSAPI Server will be able to connect the call
server which is active (role Main) through the Main IP address.
From the “Alcatel-Lucent OmniPCX OTS Manager” interface, at the “Server configuration – Telephone
nodes”, in the part Characteristics/Main, we have to type a name (example: OXE_Node1) to identify
the OXE in “Identifier” box and the IP address of the role Main in the “Main” box.
After validating this entry, the value in the “Stand by” check box will be put automatically to the same
put in “Main”. Please don’t change this value in the “Stand by” check box, only the value in the
“Main” check box will be used.
IP address of the role “Main”

(according to the Netadmin
management in the
OmniPCX Enterprise).

9 TSAPI Server deployment in OmniPCX Enterprise Spacial
Redundancy mode
 From the OmniPCX enterprise point of view, two CPUs in different subnetworks
 Spacial Redundancy is not equal to the “duplicated” deployment. A “Main” IP address is
managed for each CPU through netadmin.
9.1 Scheme of the architecture: 1 OXE in spacial redundancy mode and 1

TSAPI Server
Subnetwork 1 TSAPI
Port Port
Call Server A Main 2555 3595 Manager
Stand-by (through 3595)
CSTAmono
Server
TSAPI link
TSAPI
Client
Wan IP
CSTA link
Subnetwork 2
Call Server B Stand-by

Main
CSTAmono

There is only 1 TSAPI Server installed and running. The TSAPI Server will be able to connect the Call
Server which is active (role Main) through the “Main” IP address.
From the “Alcatel-Lucent OmniPCX OTS Manager” interface, we connect the TSAPI Server Main. At the
“Server configuration – Telephone nodes”, in the part Characteristics/Main, we have to type a name
(example: OXE_Node1) to identify the OXE in “Identifier” box, the IP address of the role Main for the
Call Server A in the “Main” box and the IP address of the role “Main” for the Call Server B in the
“Stand by” box.

of the Call Server A.

of the Call Server B.

10 TSAPI Server deployment in OmniPCX Enterprise PCS (Passive
Call Server) mode
 Call Server(s) (could be Main and Standby) located in the “Central Site” and the PCS located in
a remote office.
 PCS is a particular Call Server which becomes ACTIVE as soon as the link to the Main CS is
down.
10.1 Scheme of the architecture: Call Servers (Main & Stanby) and PCS
located in different subnetwork
In the following example, we will take a CS architecture (spacial redundancy). Nevertheless, it
is possible to have only one Call Server (Main) and no Standby (Call Server) in the solution
with PCS.
TSAPI
Subnetwork 1 Port Port
Manager
2555 3595
Call Server A (Main) (through 3595)
CSTAmono Server TSAPI
link1 : Client
CSTA link TSAPI link to Main & Stanby
Wan IP
Subnetwork 2 Subnetwork 3 Passive Call Server
Call Server B (Std By) CSTAmono
CSTAmono
CSTA link
TSAPI TSAPI Premium
Manager Server
(through 3595)
link2 :
TSAPI TSAPI link to PCS
Client

11 TSAPI Server deployment in multiple TSAPI Clients solution
 One TSAPI Server installed and connected to OmniPCX enterprise

 For example, 2 TSAPI Clients connected to the SAME TSAPI Server.
11.1 Scheme of the architecture: 1 OXE, 1 TSAPI Server and 2 TSAPI Clients
10.10.10.1
TSAPI
Manager
OmniPCX Enterprise

CSTAmono
Server
Request « Escape
Default Port
Port 2555 3595 Register Service »
+
150 Monitoring
TSAPI link
10.10.10.5
Request « Escape
Voice recorder A
telnet on the OXE : Register Service »
(TSAPI Client 2)
( )> telnet localhost 2555 +
D 150 Monitoring
(dbg)> ls
10.10.10.6
1 [10.10.10.1] CSTA (DR_LINK ) 150 monitorings Voice recorder B

or NICE (TSAPI Client 1)
The link is typed differently according to the voice

recorder which is connected.
The 2 TSAPI clients has to send, both, the request “Escape Register Service” and then the requests to monitor
the devices (150 monitorings is an example, max is 3000 and can be extended to 5000).
This is important to note that all the TSAPI Clients connected to the same TSAPI Server MUST use the same
type of link. So in case of voice recorder solution, all the TSAPI Clients MUST connect the TSAPI Server/OXE
by a link typed for voice recorder. It is forbidden to mix on the TSAPI Server different type of link.

After the second TSAPI Client (voice recorder side) has sent its request “Escape Register Service”, it will
receive from the TSAPI Server a strange chain of character (example: ).
This is due to the TSAPI Server doesn’t send the request to the OXE because the first TSAPI Client has already
realized this connection. That means the TSAPI Server has some intelligence to not do this request twice to
the OXE.

For the deployement of the TSAPI Server, see the chapter 4.2.

12 Max numbers of TSAPI Instances installed on a physical server
12.1 Scheme of the architecture
OmniPCX Enterprise
1
One Physical TSAPI Server
CSTAmono CSTA link

Instance 1 (3595)
OmniPCX Enterprise
2 TSAPI Premium Server
CSTA link
Instance 2 (3596)
CSTAmono

CSTA link Instance 20 (36xx)
OmniPCX Enterprise
20
CSTAmono
12.2 Limitations
The max number of TSAPI instance which can be installed and running on the same physical server is
20 TSAPI instances.
 1 TSAPI Server instance is dedicated for 1 OmniPCX Enterprise connection.

13 Max numbers of TSAPI Clients connected to same TSAPI Server
13.1 Scheme of the architecture
Call Server A (Main)

CSTAmono TSAPI
(3595)
Client
IP Lan
CSTA link TSAPI link
TSAPI
Client
TSAPI
Client
13.2 Limitations
The max number of TSAPI clients which can be connected to the SAME TSAPI Server is theoretically
2000.
The maximum is indicated for information, in most of the voice recorder installation there is only one
TSAPI Client connected to the TSAPI Server.
 All the connected TSAPI Clients MUST be connected by the same type of link to the
same TSAPI Server:
- voice recorder type (see chapter which concerns the deployment).

14 Multiple CSTA links typed for voice recorder in OXE
14.1 OXE Release R12 M1

Until the OXE Release R12 M1, the OXE can only accept ONE CSTA link typed for voice recorder system (NICE
or DR_LINK):
14.2 OXE Release R12.1 M2.300

From the OXE Release R12.1 M2.300, OXE is able to accept more than one CSTA link typed for voice recorder
system (NICE or DR_LINK):
For multiple voice recorder system connection, OXE can only accept multiple CSTA link of same type (like
multiple DR_LINK, or multiple NICE but not a mix of DR_LINK and NICE).
If several voice recorder systems are connected to an OXE, each recorder monitors a group of TDM or IP
extensions, and different recorder is not allowed to manage the same user.
(If the extension is already monitored by another DR-Link application, the service is rejected with the error
message: Service busy).

14.3 OXE Release R12.3.1 M4.500 – Double IP duplication
From the OXE Release R12.3.1 M4.500, OXE is still able to accept more than one OmniPCX Record
system and the following IP Phones are able to duplicate their IP stream to 2 different IP
addresses (OmniPCX Record): all NOE 3G EE IPTOUCH 8008, 8018, 8028s, 8058s, 8068s, 8078s with
NOE 3G EE R500 5.40.09 binary version and IP Desktop Softphone with minimum version 11.5.x.
If several DR-Link recorders are connected to an OXE, each recorder monitors a group of TDM or IP
extensions, and different recorders are allowed to monitor the same user. No limitation to monitor the same
directory number.
If 3 voice recorders (all typed as DR_Link) are connected to the OXE, and request to monitor the same IP
Touch (8068s), the 2 first StartIPRecording will be accepted but the third will be refused
(INVALID_OBJECT_STATE) because the IP extensions is able to duplicate 2 * 2 flows, and not 3 * 2 flows.

15 TSAPI Server uninstallation
15.1 TSAPI Server with only one instance (OXE stand-alone)

Stop the “Alcatel Open Telephony Server”
Control Panel \ Programs \ Programs and Features
Select “Alcatel TSAPI Client”, right click\Uninstall to uninstall the TSAPI client
Click Yes
Select “Alcatel-Lucent” OmniPCX TSA Manager”, right click\Uninstall to uninstall the TSA Manager
Click Yes

Select “Alcatel OmniPCX Open Telephony Server”, right click\Uninstall to uninstall the TSAPI Server
Click Yes
Click OK
The service “Alcatel Open Telephony Server” is no more displayed after the refresh
All the TSAPI Server components have been uninstalled.

Let’s finish by removing the associated folder:

If the TSAPI client was the 32-bit application, it was located under:
install_drive\Program Files (x86)\Alcatel
If the TSAPI client was 64-bit application, it was located under:

install_drive\Program Files\Alcatel-Lucent Enterprise

15.2 TSAPI Server with two instances (OXE in netwrok)
To uninstall the TSAPI Client and the TSAPI Manager, the steps are completely same as the steps detailed in
the previous section 15.1.
The difference here concerns the uninstallation of the 2 TSAPI Server instances:
- Open the console interface
- Go to the folder install_drive:\Program Files (x86)\Alcatel\OmniPCXTSA

(in this example, the install-drive is C)
- Remove the “Alcatel Open Telephony Server”
- Remove the “Alcatel Open Telephony Server2”
Then, remove the associated folderas described in the previous section 15.1.

15.3 Old TSAPI Server version (Release ≤ 7.0.3)
DO NOT VALIDATE the parameter " Would you like remove all files and subdirectories in the diectory : C:\
Windows?" at the uninstallation of the OTS Manager, for all Releases ≤ Release 7.0.3 of the
Alcatel-Lucent Enterprise TSAPI Premium Server.
16 OXE /TSAPI High availabiltiy solutions basis
16.1 TSAPI capabilities

The TSAPI Server is a client of the OmniPCX Enterprise CSTA server.The TSAPI Server is not able to
decide, by itself, to disconnect an established CSTA link to a CS (Call Server) or to a PCS (Passive Call
Server). It means that a CS or a PCS CSTA server is running: the TSAPI Server is connected to this CS
or to this PCS. The TSAPI will never decide by itself to disconnect itself from the CS or the PCS: If CS or
PCS CSTA internal server is up and running and Lan/Wan is up and running for an infinite time, the
TServer stays connected to this CSTA server for an infinite time.
So, the behavior of a TSAPI Server depends only of the CS or PCS configuration :
 Duplicated CS,
 Spacial redundancy CSs,
 Passive Call Server.
In all cases the CS, CSs and/or PCS drives the behavior of the TSAPI Server.
The TSAPI responsibility in a voice recorder deployment at the time the connection with a CS or PCS
Csta server is established :
 The TSAPI Server is not able to type the TSAPI by itself to Dr-Link
=>Voice recorder has to send escape service.
 The TSAPI server is not able to request agents/phone set Csta monitoring by itself
=>Voice recorder as to send the requests for phone set/agents CSTA monitoring ,each time
necessary ,when the link is established or established again.
 The voice recorder has to put in a “black list” and to report a configuration issue to the voice
recorder administrator tool, the directory numbers for which the monitoring is not possible (
unavailable number, not well configured number ,licenses exceed ,…)
When the connection to a CS or PCS is broken :

 The TSAPI Server sends an event to the client (via Csta32.dll) to inform the voice recorder
system that a link is broken …nothing else.
 When the connection to a CS or PCS is established again :The TSAPI Server sends an event to
the client (via Csta32.dll) to inform the voice recorder system that a link is established
…nothing else.
Basicaly, the TSAPI Server is an OmniPCX client ,from a Csta point of view and a TSAPI Server from a
service consumer point of view (the voice recorder is a TSAPI Client).
16.2 Single CS, single TSAPI Server

In this use case there is only one TSAPI Server (with or without TSAPI Backup), configured to
established a connection with one IP address : the single CS address.
 If CS falls or Lan falls, no more CSTA server running inside CS, TSAPI is not connected to any
CS.
16.3 Main/Stand-by (duplicated) CSs, single TSAPI Server

In this use case there is only one TSAPI Server (with or without TSAPI Backup), configured to establish a
connection with one IP address :The CSs main address.
 If a failure occures ,the TSAPI link is broken and the TSAPI Server will try to establish again the
link with the CS (Main address).
16.4 Spacial redundancy, single TSAPI server

In this use case there is only one TSAPI Server (with or without TSAPI Backup), configured to establish a
connection with 2 Ip addresses : CS1 and CS2.
In case of failure occures:
 CS1 is down = TSAPI link broken. TSAPI tries to re-establish the link with CS1 few times .It fails:
TSAPI established the link with CS2. This state stays as it is! The TSAPI will never decide by itself
to re-established again the connection with CS1 if CS2 does not break the link. The behavior
depends of spacial redundancy configuration applied when such case of “double main”
occures.
Thanks to read carefuly OmniPCX documentation describing the way the system decides who is
main
1. Highest Priority :Reference shelf is OXE configuration,
2. Prefered CPU is OXE configuration.
3. number of visible IP links.
4. Lowest priority :Highest @IP
In all cases the OmniPCX Enterprise will apply the rules to keep only one single main ,based on those
priorities. OmniPCX documentation contains very useful informations concerning this configuration.

16.5 Spacial redundancy, two TSAPI Server
It is a possible deployment, from a TSAPI point of view. However it is the responsibility of the voice
recorder vendor to manage the possible situations where both TSAPI can be active at the same time
(Case where both CS are main (double main) ) this is normaly a transcient state (a duration of few
seconds) if all the solution recovers all normal behaviors.
As decribed earlier, there is some rules used by OXE to prioritize the selection of the “main” cpu
(previous chapter , 4 priorities).
16.6 Main/Stand-by (Duplicated) CSs or single CS with PCS, 1 TSAPI Servers

In this use case both Main/Stand-by OXE or single CS OXE + PCS are located on the same Lan .
The TSAPI is configured to be able to use:
 -Main address
PLUS
 -PCS address.
Restrictions are the sames:

 The TSAPI stays connected to the active system. The active system is:
1. The Main/standby-by CS (by using the main IP address) or the single CS,
2. The PCS in case of failure of the main/stand-by CSs or single CS.
When the failure occures, the TSAPI looses the connection to the Main/stand-by CSs or to the single
CS … After a while, the PCS starts to answer to the TSAPI which tries to establish a connection.
Do not forget that once a TSAPI link is established, the connection stays active. That means that,
depending of the PCS configuration, the TSAPI can continue to be connected to the PCS if this one
continue to answer to the CSTA request, even if the main/stand-by Css or single CS is up and running.
Please check PCS configuration if you expect to have a PCS shutdown when the CS is back .The
behavior of the PCS is described in OmniPCX Enterprise documentation .
Reminders :
PCS has 3 posisble states: Active,Inactive ,Inactive * (star) .
1. Active: The PCS has a link with the main CPU ,link is OK.
2. Inactive: The PCS has no link with the main CPU ,link is NOK.
3. Inactive * (star): The link is established bbut the PCS secured the IP domains.
Please, take in account the fact that a PCS in “inactive * (star)” mode observes 3 possible behaviors:
1. PCS reboots automaticaly when the link is established with the CPU and stable for a duration
of 30 seconds:This is the default behavior.
2. PCS will reboot after a configurable delay or never if this timer value is set to -1 (minus one).
3. PCS will reboot at a certain configurable time.

In all cases, thanks to check that the voice recorder behaviors matches the PCS configuration. This is
the responsibility of the voice recorder vendor.
Remarks :
It is also important to take in account the fact that all phone sets associated to an IP domain,
associated to a PCS will be detected as “out of order” by the CS which is up and running as long as
the PCS is in a state “inactive *”. So, all Csta requests from a voice recorder to the TSAPI Server
connected to the CS, for all phones set under the control of the PCS, will fail. The voice recorder, if
any, will continue to send requests to the TSAPI Server connected to the PCS, to record
communications which are processes by the PCS in “inactive *” state.
16.7 Spacial redundancy with PCS, 2 TSAPI Servers
In this use case, one TSAPI is configured to be able to establish a connection with CS1 or CS2.
Another TSAPI Server is configured to establish a connection with the PCS.
Thanks a lot to remind to yourself that a PCS behavior is configurable (previous chapter).
In all case, thanks to check the voice recorder behaviors which matches the PCS configuration. This is
the responsability of the voice recorder vendor.
Please take in account the previous chapter remarks.
16.8 Others TSAPI Servers deployments
Thanks to get help from your voice recorder vendor. TSAPI is nothing else than an API to make easier
the software development for the voice recorder vendor all behaviors are implemented in the voice
recroder system.
Thanks to check the published Inter Working Reports to know the supported/tested deployments,
depending of the voice recorder vendor .

Submitting a Service Request
Please connect to our eService Request application.
Before submitting a Service Request, please be sure:

 The application has been certified via the AAPP if a third party application is involved.
 You have read the release notes that list new features, system requirements, restrictions, and more,
and are available in the Technical Documentation Library.
 You have read through the related troubleshooting guides and technical bulletins available in the
Technical Documentation Library.
 You have read through the self-service information on commonly asked support questions and known
issues and workarounds available in the Technical Knowledge Center.
- END OF DOCUMENT -


TC1601en-Ed05 TSAPI Deployments For Voice Recorder

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

TC1601en-Ed05 TSAPI Deployments For Voice Recorder

Uploaded by

Copyright:

Available Formats

Technical Bulletin TSAPI Premium Server

TC1601 ed.05 Release 7.3.2 and above

TSAPI Premium Server: TSAPI Server

Edition 1: January 11, 2012 creation of the document

2 Alcatel-Lucent TSAPI Premium release...................................................................................................... 4

3 Alcatel-Lucent TSAPI Premium components .............................................................................................. 4

6 TSAPI Backup deployment (one OXE) ..................................................................................................... 19

8 TSAPI Server deployment in OmniPCX Enterpise duplicated mode ............................................................ 31

TSAPI Premium Server - Release 7.3.2 and above

14 Multiple CSTA links typed for voice recorder in OXE ............................................................................... 40

16 OXE /TSAPI High availabiltiy solutions basis .......................................................................................... 46

TSAPI Premium Server - Release 7.3.2 and above

2 Alcatel-Lucent TSAPI Premium release

3 Alcatel-Lucent TSAPI Premium components

3.1 Mandatory Alcatel-Lucent TSAPI components

3.2 Optional TSAPI Client used to check the TSAPI configuration

TSAPI Premium Server - Release 7.3.2 and above

4.1 Scheme of the architecture: 1 OXE and 1 TSAPI Server

CSTA link TSAPI Premium

4.2 Alcatel-Lucent TSAPI Premium Server installation

TSAPI Premium Server - Release 7.3.2 and above

TSAPI Premium Server - Release 7.3.2 and above

TSAPI Premium Server - Release 7.3.2 and above

TSAPI Premium Server - Release 7.3.2 and above

Also from the Control Panel \ Programs

Then select the “32-bit”, and click OK

TSAPI Premium Server - Release 7.3.2 and above

Then click Exit to quit the Setup interface.

TSAPI Premium Server - Release 7.3.2 and above

 OmniPCX Enterprise network : At least 2 nodes connected through ABC-F link.

5.1 Scheme of the architecture: network of 2 OmniPCX Enterprise and 2

TSAPI Premium Server - Release 7.3.2 and above

From the services window:

TSAPI Premium Server - Release 7.3.2 and above

TSAPI Premium Server - Release 7.3.2 and above

- Copy and rename the following files under C:\Program Files(x86)\Alcatel\OmniPCXTSA:

Then, renamed the files:

 Create the instance "Alcatel Open Telephony Server1"

TSAPI Premium Server - Release 7.3.2 and above

TSAPI Premium Server - Release 7.3.2 and above

TSAPI Premium Server - Release 7.3.2 and above

 This TSAPI Backup deployment is applicable to OmniPCX Enterprise in stand-alone as well as

CSTA link TSAPI Premium

CSTA link IP Lan

TSAPI Premium Server - Release 7.3.2 and above

6.2.1 TSAPI Server “Main”

TSAPI Premium Server - Release 7.3.2 and above

No management is required on the TSAPI Server Backup.

TSAPI Premium Server - Release 7.3.2 and above

7.1 Scheme of the architecture: network of 2 OmniPCX Enterprise and 2

TSAPI Premium TSAPI Premium

TSAPI Premium Server (through

TSAPI Premium Server - Release 7.3.2 and above

 Installation of the 2nde instance (linked to OXE 2 – port 3596):

After renamed the files:

Create the instance "Alcatel Open Telephony Server1"

TSAPI Premium Server - Release 7.3.2 and above

 From the "Services" window, start the 2 TSAPI instances:

 Management of the link concerning the OmniPcx Enterprise 1

The first time the OTS manager is

TSAPI Premium Server - Release 7.3.2 and above

TSAPI Main management:

If TSAPI Backup management: