TSP User Guide

Documentation Disclaimer
Matrix Comsec reserves the right to make changes in the design or components of the product as engineering and
manufacturing may warrant. Specifications are subject to change without notice.

This is a general documentation for all models of the product. The product may not support all the features and
facilities described in the documentation.

Information in this documentation may change from time to time. Matrix Comsec reserves the right to revise
information in this publication for any reason without prior notice. Matrix Comsec makes no warranties with respect
to this documentation and disclaims any implied warranties. While every precaution has been taken in the
preparation of this manual, Matrix Comsec assumes no responsibility for errors or omissions. Neither is any liability
assumed for damages resulting from the use of the information contained herein.

Neither Matrix Comsec nor its affiliates shall be liable to the purchaser of this product or third parties for damages,
losses, costs or expenses incurred by the purchaser or third parties as a result of: accident, misuse or abuse of this
product or unauthorized modifications, repairs or alterations to this product or failure to strictly comply with Matrix
Comsec's operating and maintenance instructions.

Copyright
All rights reserved. No part of this manual may be copied or reproduced in any form or by any means without the
prior written consent of Matrix Comsec.

TAPI Version 2.2

Release Version 1.2
Release date: October 18, 2014
 Contents

Introduction..................................................................................................................................................... 1

Installing Matrix TAPI Service Provider........................................................................................................ 3

Configuring Matrix TAPI Service Provider ................................................................................................... 9

Uninstalling Matrix TAPI Service Provider ................................................................................................. 17

Table of Contents i
ii Table of Contents
CHAPTER 1 Introduction

The Telephony Application Programming Interface (TAPI) is a platform used for developing and using computer
telephony applications. The Matrix TAPI Service Provider (Matrix TSP) is a TAPI 2.x compliant service provider that
works with Matrix's PBX. This driver supports basic and supplementary call features, and enables 3rd party TAPI
developers to develop TAPI compliant application to run with Matrix's PBX.

For TAPI Application development, refer the Matrix TAPI Developer's Guide that is provided with the installation.

This document includes step by step procedure to install Matrix TSP to the computer and configure the TSP
parameters.

Intended Audience
This document is intended for the TAPI developers / users, who wants to Install and use Matrix TSP.

Notices
The following symbols have been used to draw your attention to important things:

Note: It indicates something that requires your special attention or reminds you of something you need to
do when you are using the Matrix TSP.

Caution/Warning: It indicates an action or condition that is likely to result in malfunction of the Matrix TSP.

Abbreviations used in the Guide

CTI Computer Telephony Integration

TAPI Telephony Application Programming Interface

TSP TAPI Service Provider

TSPI Telephony Service Provider Interface

PBX Private Branch Exchange

TCP Transmission Control Protocol

Matrix TSP User Guide 1

 IP Internet Protocol

MB Mega Bytes

Additional Information
If you face any problems regarding the installation and configuration of Matrix TAPI Service Provider, contact the
Matrix “Customer Care”.

2 Matrix TSP User Guide

CHAPTER 2 Installing Matrix TAPI
Service Provider

Before Installing Matrix TAPI Service Provider

In order to use Matrix TSP properly, make sure the system on which the Matrix TSP is to be installed:
• Runs on WINDOWS platform.
• Operates on - Windows 2000/XP Professional, Windows 7, Windows 8, Windows Vista, Windows Server
2003/2008.
• Has Telephony Services installed.

Administrator privileges are required to install Matrix TSP.

Installing Matrix TSP

This section describes step by step procedure to install Matrix TSP.

The Version referred to as x.x.x.x corresponds to the Version of the Matrix TSP software you have.

Step - 1
• Extract the provided ".zip" file. It includes all the necessary setup files.

• If your computer supports 32-bit operating system, unzip the Matrix_tspx.x.x.x_inst_x86.exe

Path on the CD ROM: TAPI Service Provider >>Setup >>Matrix_tspx.x.x.x_inst_x86.exe

• If your computer supports 64-bit operating system, unzip the Matrix_tspx.x.x.x_inst_x64.exe

Path on the CD ROM: TAPI Service Provider >>Setup >>Matrix_tspx.x.x.x_inst_x64.exe

Matrix TSP User Guide 3

 • Run the Setup EXE file.

• Click Next.

Step - 2
• Select the Installation directory to install Matrix TSP files.

4 Matrix TSP User Guide

 • Click Next..

• Click Next.

Step - 3
• Wait while the setup is installing necessary files to the system.

Matrix TSP User Guide 5

 • During installation, Setup will automatically add the Matrix TSP to the Phone & Modem. If you want to
remove and then later add it manually, see “Add / Remove Service Provider”.

Step - 4
• Setup has successfully installed the Matrix TSP to the system.

• Click Finish to complete the Installation.

• After adding Matrix TSP, Configuration Dialog box of the TSP will pop up.

• You may skip TSP configuration. To do so, click Cancel.

6 Matrix TSP User Guide

 • Configure the necessary TSP parameters. For instructions, see “Configuration Settings”.

Re-Installing Matrix TSP

• In case, you re-install (updated TSP Version or the same TSP Version), an Alert message will appear.

• Click Yes. The Uninstallation Wizard will appear.

• Navigate the wizard to uninstall the previous setup. As soon the uninstallation is successful, the Installation
Wizard will appear.

• Navigate the wizard to complete the installation.

Matrix TSP User Guide 7

Release Notes
Readme.txt list contains new TSP features, features related modifications, issues resolved & previous Release
History.

You can access Readme file from the Matrix TSP Installation Directory OR from the Start Menu as shown under.

• Click Start.

• Click All Programs.

• Click Matrix and then TAPI Service Provider x.x.x.x

• Click ReadMe.

8 Matrix TSP User Guide

CHAPTER 3 Configuring Matrix TAPI
Service Provider

This section describes step by step procedure to configure Matrix TSP.

Add / Remove Service Provider

• After installation, Matrix TSP is automatically added into the Service Provider list.

However, to add Matrix TSP manually,

• Open the Phone and Modem option in the Control Panel.

• Select Advanced tab in Phone and Modem Option.

Matrix TSP User Guide 9

 • Click Add… to add Matrix TSP to the Service Provider list.

• Select "Matrix TAPI 2.x Compatible Service Provider" and click Add.

• Matrix TSP will be added to the list of installed Service Provider.

To Remove Matrix TSP,

• Open Phone and Modem option in the Control Panel.

10 Matrix TSP User Guide

 • Select Advanced tab in Phone and Modem Option.

• Select Matrix TSP from the Service Provider list.

• Click Remove. An alert message will appear as shown under.

• Click Yes to remove Matrix TSP. You may click No to cancel, if required.

• A warning message appear as shown below.

• Click OK to continue.

Configuration Settings
After installation of Matrix TSP, you must program TSP configuration parameters.

• Select Matrix TSP from the Phone and Modem option in the Control Panel.

Matrix TSP User Guide 11

 • Select the Advanced tab in the Phone and Modem Option.

• Click Configure… to open Matrix TSP configuration dialog box.

OR

• Click Start.

• Click All Programs.

• Click Matrix and then TAPI Service Provider x.x.x.x

• Click Matrix TSP Configuration.

CTI Link Parameters

CTI Link is a TCP/IP connection between Matrix TSP & Matrix PBX. Valid CTI Link Parameters must be
programmed at TSP side & PBX side to establish CTI Link.

12 Matrix TSP User Guide

Enable CTI Link

Enable this option to use the Matrix TSP. CTI link will be established only if this option is enabled.

IP Address of PBX

Configure IP address of Matrix PBX to which the Matrix TSP has established CTI Link.

Listening Port of PBX

Configure the TCP port of CTI Link on which Matrix PBX is listening for the Matrix TSP connection.

Connection Retry Interval

If CTI Link is enabled, TSP will try to establish CTI Link with the configured parameters. If connection to PBX fails,
Matrix TSP will try continuously to establish CTI link at the programmed Connection Retry Interval (seconds).

To establish CTI link, make sure the CTI configuration is done properly in the PBX.

CTI Logs Parameters

Matrix TSP provides Tracing Mechanism, which may be helpful to troubleshoot problems. There are two
mechanisms for tracing. One is log to Syslog Server & other is log to Text File.

Matrix TSP User Guide 13

Enable Logs

Logs will be captured, if this option is enabled.

TSPI Logs

If this option is enabled, all TSPI functions will be logged.

CTI Link Logs

If this option is enabled, all Non-TSPI functions will be logged.

Log to Syslog Server

With this option, logs will be captured on Syslog Server.

Syslog Server IP address

Configure the IP address of the system on which Syslog Server is running.

Syslog Server Port

Configure the UDP Port on which the Syslog Server is listening.

14 Matrix TSP User Guide

Log to Text File

With this option, logs will be captured in the text file.

Log File

Specify the path of the text file to which one want to capture log.

Size Limit

Configure this option to limit the size of the log file (in MB) that is created. If size of the log file exceeds the
configured size, TSP will create a new file for logging.

The original log file name will be appended with the date and time of the creation of the log file. This method is
followed every time when a new file is created for logging.

Product & Company Information

You can know the version of the installed TSP from the About tab.

Matrix TSP User Guide 15

16 Matrix TSP User Guide
CHAPTER 4 Uninstalling Matrix TAPI
Service Provider

This section describes step by step procedure to uninstall Matrix TSP.

Step - 1
• Go to the Control Panel and open Add or Remove Programs.

• Select the Matrix TAPI Service Provider from programs list.

Matrix TSP User Guide 17

Step - 2
• Click Remove/Uninstall. An uninstall windows will pop up.

Step - 3
• Click OK to continue OR Click Cancel to abort Uninstallation.

Step - 4

• Click Next.. You will be prompted to close all TAPI Applications before uninstalling it.

• Close all the TAPI Applications, if open.

18 Matrix TSP User Guide

Step - 5

• Click OK to continue and wait while the setup is being Uninstalled.

Matrix TSP User Guide 19

Step - 6

• Setup has successfully uninstalled the Matrix TSP from system.

• Click Finish to complete the Uninstallation process

20 Matrix TSP User Guide

Matrix TSP User Guide 21
MATRIX COMSEC
Head Office
394-GIDC, Makarpura, Vadodara - 390010, India.
Tel.:+91 265 2630555, Fax: +91 265 2636598
E-mail: Info@MatrixComSec.com

Manufacturing Unit
19-GIDC, Waghodia - 391760, Dist. Vadodara, India.
Version 1.2, October 2014

Tel.: +91 2668 263172/73

Customer Care
Tel.: +91 265 2630555
E-mail: Customer.Care@MatrixComSec.com, Support@MatrixComSec.com

www.MatrixComSec.com