Using the TopazCLI program

[Belinda Frick]

Overview

CLI is an acronym for Caller Line Identification. Another name
is CallerID. For telephony, it simply means that you receive
some information which is unique to the caller, allowing you to
know who is calling before you answer the call.

Most often, this is only the telephone number. In some cases,
it might include the name of the person. CLI is not always
provided, depending on the type of line, your telephony service
provider, and the caller.

The TopazCLI program can be used either as a standalone
application or to provide this functionality to another
application. This other application controls TopazCLI and
receives a message when an incoming call arrives. The method of
controlling TopazCLI is via the Microsoft COM. TopazCLI has a
COM object, and the COM object allows other applications to
control or receive messages from TopazCLI.


Requirements

Telephone lines that support CLI (all BRI, PRI and some analogue
lines).
A PABX which supports CLI.
Support for CLI in the utility that connects Topaz to the PABX.
This is usually something like PABX3, DTP or RubyTAPI.
Topaz telephone management system, configured with the hostnames
or IP addresses of the PCs.
Network connectivity between the PCs that need to use TopazCLI
and Topaz

Tapi must be enabled on the PABX
CLI (Caller line identity) must be activated on the Telkom lines
TOPAZ from Datatex
DTP from Datatex
CLI COM object from Datatex
Windows PC at each user

The objective

When a call is received the telephone number will “popup” at the relevant
PC via the CLI software. Please note that the caller ID must be enabled.


Installing TopazCLI

Whether it is used as a standalone application or a COM object, the
installation is simply to run the TopazCLI installer.
This is usually named Topaz.TopazCLI.Install-x.x.x.x where x.x.x.x is a
version number. Run the installer on each PC which requires CLI
information.

TOPAZ configuration for TopazCLI to pop up.

TOPAZ -> Setup -> properties -> Network\FrontOffice, enable the Callmonitor port on 25003.
Under Data and extensions in TOPAZ, make certain that each extension has there individual IP
address entered.
If DTP is sending to TOPAZ, TOPAZ will then send the relevant information to TopazCLI and
pop up when a call is received.

Using TopazCLI as a standalone application

Add TopazCLI to the Startup menu in Windows. Make sure TopazCLI is
running. Configure Topaz with the PCs host name or IP address linked
to the extension of the phone. When a call arrives, TopazCLI will
pop up with the details of the call.


Using TopazCLI as a COM object

Use the COM object in the application. TopazCLI will then start up
when the application initialises it. Configure TopazCLI with
popups turned off, unless you want it to pop up when CLI arrives in
addition to sending it to your application.

When CLI data arrives, the CLIData event will be called.
The following parameters will be passed:
Extension - the telephone extension that received the call.
Number - the telephone number that called.
Destination - a description of the caller (filled in by Topaz).
CallType - can be ignored
Direction - INCOMING or OUTGOING
AgentStatus - can be ignored

Your application can use the number to do a lookup, or if you associate
account codes on Topaz with the number, you can use the Destination field.


Visual Basic example

Option Explicit

Public WithEvents CLI As TopazCLI.TopazCLIServer

Private Sub CLI_CLIData(ByVal Extension As String, ByVal Number As String,
ByVal Destination As String, ByVal CallType As String, ByVal Direction As
String, ByVal AgentStatus As String)
Label1.Caption = Extension
Label2.Caption = Number
Label3.Caption = Destination
Label4.Caption = Direction
End Sub

Private Sub Form_Load()
Set CLI = New TopazCLI.TopazCLIServer
End Sub

Private Sub Form_Unload(Cancel As Integer)
Set CLI = Nothing
End Sub