HiPath 3000/5000 HiPath TAPI 120 V2.0. Installation and Configuration

(1)

(2)

(3)

Content

0

1 Introduction . . . 1-1

1.1 What is HiPath 3000/5000 TAPI 120 V2.0?. . . 1-1 1.2 Requirements . . . 1-4

2 Installation and Configuration . . . 2-1

(4)

(5)

What is HiPath 3000/5000 TAPI 120 V2.0?

1 Introduction

1.1 What is HiPath 3000/5000 TAPI 120 V2.0?

General

The HiPath 3000/5000 TAPI 120 V2.0 enables Microsoft TAPI applications to control assigned telephones.

HiPath 3000/5000 TAPI 120 V2.0 is derived from Hicom CTI TAPI 3P/HiPath TAPI 170. Running both TAPI drivers on the same machine is not possible.

Documentation

● To improve readability, "telecommunications system(s)" has been abbreviated to

"sys-tem(s)" in this document.

● The product name HiPath 3000/5000 TAPI 120 V2.0 has also been abbreviated to TAPI

120 for the same reason.

Solutions

TAPI 120 can be used as standalone software with a system/server or can be purchased and used in conjunction with several systems/servers. Basic operation is identical:

● HG 1500 ● HiPath 500

● CMD (CSTA Message Dispatcher), component of the HiPath 3000/5000 network, which

(6)

Configuration example: TAPI 170 and TAPI 120 with CMD

License monitoring

If TAPI 120 is operating with CMD licenses are monitored for the access of TSP 120 to the CSTA-interface of the CMD. License administration is located in the CMD.

Features

The following features are available:

● outgoing connection setup ● incoming call acceptance ● dropping of calls

● display of call state, display of caller id, display of caller name (internal calls) ● logging of calls

● call pickup (group) ● consultation hold ● toggling between calls

(7)

● call forwarding, do not disturb

● additional information for redirectred calls ● data exchange between TAPI applications

TAPI application: Example

(8)

Requirements

1.2 Requirements

Hardware requirements for server connection

Connection to HiPath 500 or to the HiPath 3000/5000 component CMD is realized via TCP/IP. Connection to HG1500 is realized via S₀ (vCAPI).

Software requirements for TAPI 120 PCs ● Windows 98

● or Windows ME

● or Windows NT Server 4.0 Service Pack 4 or later ● or Windows NT Workstation 4.0 Service Pack 4 or later ● or Windows 2000 Server

● or Windows 2000 Advanced Server ● or Windows 2000 Professional ● or Windows XP Professional ● or Windows XP Home

The Windows NT Service Pack can be downloaded from the Internet at the following URL:

> http://www.microsoft.com/downloads/

Other requirements

Requirements for the system connection via TCP/IP:

● Network protocol:

(9)

General

2 Installation and Configuration

2.1 General

Installation media

A CD with the following name is supplied

HiPath TAPI 120 V2.0 P30370-P270-A-* Scope of installation

The components to be installed can be selected when installing TAPI 170 components. The fol-lowing components are available:

● TSP

● CMD

Installation of the component CMD is only neccessary if more than six clients per node will be operated.

Installation and configuration

If both components are selected for installation, the individual installation routines and dialogs for entering the configuration parameters may be automatically started one after the other. In the present document, installation procedures are described in section Starting installationand configurable parameters are described in section Configuring components.

2.2 Starting installation

Starting installation

1. Log on as an administrator and close all running applications.

2. Insert the HiPath TAPI 120 V2.0 installation CD. Select Start - Run, enter the file name setup.exe on the installation drive and confirm with OK.

3. The Welcome dialog is displayed. Click Next to confirm. The installation setup type must then be specified.

>

If (another) CTI TAPI is installed on the PC, you have to uninstall this version before installing HiPath TAPI 120. For uninstalling this driver please follow the description

(10)

Starting installation

Display

4. Select the components to be installed in the dialog displayed and confirm with Next. Installation of the selected components is started.

– Installing the CMD component

– Installing TAPI 120 SP V2

(11)

2.2.1 Installing the CMD component

If required the CMD component can be installed on a central PC. This PC has to meet the fol-lowing requirements:

● Windows NT V4.0 SP6 or higher or Windows 2000 SP2 or higher. ● Has to cover the operating time of all HiPath TAPI 120 V2 clients.

● It is not allowed to use applications that might cause peak loads or shortage in resources.

1. A welcome dialog is not displayed when installing the CMD component. Progress is dis-played in a window.

2. For PCs with two network cards, a dialog appears prompting you to select the IP address to be used.

3. The CMD configuration dialog opens automatically following successful CMD installation. The required parameters can be entered in this dialog or configured at a later stage.

Display

(12)

2.2.2 Installing TAPI 120

1. Click Next to confirm the TAPI 120 welcome dialog.

TSP 120 installation is then started and progress is displayed in a window.

(13)

Configuring components

2.3 Configuring components

Manual activation of configuration dialogs

The individual component parameters can be configured during installation or at a later stage.

Effectiveness of modified configuration parameters

Modified configuration parameters are immediately effective once the data has been saved in the configuration dialog (Apply or OK buttons). Components do not have to be reassigned and the PC does not have to be rebooted.

2.3.1 Configuring the CMD component

2.3.1.1 Starting the configuration dialog Activating the configuration dialog

To edit the CMD configuration parameters after installation, start the configuration dialog as fol-lows:

1. Open the Windows Control Panel via Start - Settings - Control Panel. Activate the CSTA Message Dispatcher by double-clicking the associated icon.

● The CMD configuration dialog is then displayed.

2. Edit the following parameters as required:

– General CMD parameters for HiPath 3000

– General CMD parameters for HiPath 3000/5000

– Advanced CMD parameters

– CMD assignment parameters for HiPath 3000

– CMD assignment parameters for HiPath 3000/5000

– CMD parameters for CTI firewall

– CMD license parameters

(14)

2.3.1.2 General CMD parameters for HiPath 3000

The type of system connected, the type of connection between the CMD and the system and the relevant connection parameters must be determined when configuring the general CMD parameters.

> Activate the General tab in the CMD configuration dialog.

Display

The following is a description of parameter meaning:

Parameter Description

System For selecting the connected system. The following systems can be sel-ected:

● HiPath 3000 (Default) ● HiPath 3000/5000

CSTA link Connection type between CMD and the system. The following con-nections can be selected:

● S0

● COM1...COM8 ● TCP/IP (default)

Connection via TCP/IP is predefined in the case of HiPath 3000/5000 and cannot be changed.

Call number Access number for the system’s CSTA interface.

(15)

Saving parameters

● To save entries, click Apply (to configure parameters in other tabs for example) or OK (to

exit the configuration dialog and save changes).

● A confirmation message appears in both cases before the parameter values are saved in

the database. Click Yes to confirm this message.

CAPI-DLL Name of the DLL file including the CAPI driver for the S0 card, which is installed during S0 card installation.

The default file name is CAPI2032.DLL.

This parameter is relevant to and can only be entered for TAPI 120 Standalone via an S0 connection.

CAPI controller S0 card controller number.

Baud rate Interface transfer rate between the CMD and the system.

This parameter is only relevant for TAPI 120 Standalone via a V.24 (COM1...COM8) connection.

The following baud rates can be selected:

● 2400

● 9600 (default) ● 19200

CMD IP port Number of the CMD IP port that TAPI clients override.

>

If the system is changed, a message may appear indicating that the licensing infor-mation may have been changed. If this occurs, the licensing information for the new system must be checked.

(16)

2.3.1.3 General CMD parameters for HiPath 3000/5000

The type of system connected, the type of connection between the CMD and the system and the relevant connection parameters must be determined when configuring the general CMD parameters.

> Activate the General tab in the CMD configuration dialog.

Display

System For selecting the connected system. The following systems can be se-lected:

● HiPath 3000

● HiPath 3000/5000 (Default)

CSTA link Connection type between CMD and the system.

TCP/IP connection is predefined and cannot be changed. Call number Access number for the system’s CSTA interface.

This parameter is only relevant for connection via S0 and is not rele-vant to HiPath 3000/5000.

CAPI-DLL Name of the DLL file including the CAPI driver for the S0 card. This parameter is not relevant for HiPath 3000/5000.

(17)

Baud rate Interface transfer rate between the CMD and the system. This parameter is not relevant for HiPath 3000/5000. CMD IP port Number of the CMD IP port that TAPI clients override.

>

If the system is changed, a message may appear indicating that the licensing infor-mation may have been changed. If this occurs, the licensing information for the new system must be checked.

(18)

2.3.1.4 Advanced CMD parameters

When configuring advanced CMD parameters, you are configuring parameters that are rele-vant to the connection between the connected system and the CMD. System-dependent para-meters are defined on the system and should be specified here accordingly.

> Activate the Advanced tab in the CMD configuration dialog.

Display

Enter the following parameters:

CSTA3 user CSTA3 user name of the system.

To record a change of the system user name here as well, enter the new user name. Entering the name immediately opens an input dialog in which you can enter and confirm the new name, then return to the configuration dialog. CSTA3 password CSTA3 system password.

To record a change of the system password here as well, enter the new password. Entering the password immedia-tely opens an input dialog in which you can enter and con-firm the new password , then return to the configuration di-alog.

(19)

> To save entries, click Apply (to configure parameters in other tabs for example) or OK (to exit the configuration dialog and save changes).

> A confirmation message appears in both cases before the parameter values are saved in the database. Click Yes to confirm this message.

Heartbeat period (s) Time rhythm (seconds) for checking CSTA interface activity. The value „0“ disables the check.

Default value. Should not be changed.

Heartbeat timeout (s) Additional time in seconds until automatic re-installation in the case of CSTA interface failure.

Consistency check period (s) Time rhythm (in seconds) for cyclical plausibility checks. The value „0“ disables the check.

CSTA reestablish period (s) CMD waiting time (in seconds) until a connection is re-es-tablished following connection failure.

CSTA invoke timeout (s) CMD timeout (in seconds)

Transmission interval (ms) Waiting time between two CMD messages.

(20)

2.3.1.5 CMD assignment parameters for HiPath 3000

When configuring the assignment parameters, assign the systems connected to the CMD via the CMD IP-ports on the Assignment tab.

> Activate the Assignment tab in the CMD configuration dialog.

Display

A list of assigned CMDs/systems is displayed under the following entry:

Sorting the list displayed

The list can be sorted in ascending/descending order according to column content by clicking the relevant column heading, e.g. Name.

Column / field Description

Name System description, entered during installation/configurati-on - usually the customer name.

V-Node ID Node ID of the system connected to the CMD. The node ID is entered during system installation/configuration and is unique in the network.

CMD IP address CMD IP address

(21)

> A confirmation message appears in both cases before the parameter values are saved in the registration database. Click Yes to confirm this message.

Editing/deleting an entry Editing an entry

> To edit the parameters of a configured system double-click the corresponding value. The value can then be changed in the entry field displayed.

Deleting an entry

> Highlight the entry to be deleted using the mouse and click Delete or press the * key. The entry is then deleted from the list.

Importing/Exporting nodes Importing

1. V-node parameters can also be imported from a file. Click Nodes Import to start importing. 2. Select the file to be imported.

The entries are imported and the CMD configuration dialog re-appears.

Exporting

1. The configured V-node information can be exported to a file, e.g. to save a specific level. Click Nodes Export to start exporting.

(22)

The following is required when using CMD with standalone systems:

1. Click Add in the Assign tab.

Enter the following parameters:

2. Click Apply to save entries. You can then enter additional parameters for other systems. Click OK to save changes and exit the entry dialog. The CMD configuration dialog re-ap-pears.

A maximum of 64 systems/nodes can be configured.

Node ID System description, entered during installation/configurati-on - usually the customer name.

Node Name Node ID of the system connected to the CMD. The node ID is entered during system installation/configuration and is unique in the network.

Node IP Node IP address of the system connected to the CMD. Node Port IP port number of the system, always set to 7001. CMD Port CMD Listener Port port number to be configured for the

(23)

2.3.1.6 CMD assignment parameters for HiPath 3000/5000

When configuring the assignment parameters, assign the systems connected to the CMD via the CMD Listener Ports on the Assignment tab.

> Activate the Assignment tab in the CMD configuration dialog.

Display

A list of assigned CMDs/systems is displayed under the following entry:

Name System description, entered during installation/configurati-on - usually the customer name.

V-Node ID Node ID of the system connected to the CMD. The node ID is entered during system installation/configuration and is unique in the network.

Node IP address Node IP address of the system connected to the CMD. Node port IP port number of the system, always set to 7001.

CMD IP port CMD Listener Port port number to be configured for the sy-stem, e.g. 8001, 8002, etc.

(24)

> A confirmation message appears in both cases before the parameter values are saved in the registration database. Click Yes to confirm this message.

> To edit the parameters of a configured system double-click the corresponding value. The value can then be changed in the entry field displayed.

> Highlight the entry to be deleted using the mouse and click Delete or press the * key. The entry is then deleted from the list.

Adding nodes

> Click Add in the Assign tab.

> A list of all assigned nodes including the entries from the central database is displayed. Individually select the required nodes (multiple selection is possible using the keyboard/ mouse). Click Mark All to highlight all list entries.

> Click Add to accept the selected entries followed by Close to exit the list window. The CMD configuration dialog re-appears.

(25)

2.3.1.7 CMD parameters for CTI firewall

Every TAPI 120 client that is connected to the CMD and permitted to seize a line, must be en-tered in the CTI Firewall tab to enable this access.

> Activate the CTI Firewall tab in the CMD configuration dialog.

You will see a list of the TAPI 120 clients (IP addresses) already configured for access:

Display

Entries are displayed with the following information:

Column Description

(26)

> A confirmation message appears in both cases before the parameter values are saved in the database. Click Yes to confirm this message.

> To edit the parameters of an entered TAPI 120 client, double-click the corresponding value. The value can then be changed in the entry field displayed.

> Highlight the entry to be deleted using the mouse and click Delete or press the * key.

The entry is then deleted from the list.

Adding a TAPI 120 client

1. Click Add in the CTI Firewall tab.

2. Enter the data of the TAPI 120 client in the input dialog and confirm with OK. You return to the CTI Firewall tab.

(27)

2.3.1.8 CMD license parameters

Access by TAPI 120 clients via the CMD to the connected system is protected by a licensing procedure. You can obtain information on the current license as well as any license history that may exist. If necessary the Siemens engineer can download a new license code from the Sie-mens AG license server and enter it here.

The licenses are not specific to any particular node or TAPI 120 client.

> Activate the license tab in the CMD configuration dialog.

Display

MAC ID MAC ID that is used for encryption.

This is the MAC ID of the first network card in the PC. Current license Current license code for licensing (in accordance with

infor-mation in the central database). The Siemens engineer can download this key from the Siemens license server and en-ter a new license code. If a license is changed, the license key entered will be checked. Old keys are recorded in the li-cense history. If the wrong lili-cense key is entered, a message appears and the license key is rejected.

Date Limit date licenses

(28)

2.3.1.9 CMD version information

The version numbers of the components that are used and installed are listed in the Version tab.

License History Previous licenses are displayed here with the relevant infor-mation.

(29)

2.3.2 Configuration of HiPath TAPI 120

Manual activation of configuration dialogs

1. The individual component parameters can be configured during installation or at a later stage. To edit the settings after installation open the configuration dialog in the Control Pan-el - TPan-elephone.

Effectiveness of modified configuration parameters

Modified configuration parameters are immediately effective once the data has been saved in the configuration dialog (Apply or OK buttons). In certain cases, it may be necessary to re-in-itialize the components or restart the PC.

2.3.2.1 Starting the configuration dialog

The dialog for configuring TSP parameters for TAPI 120 automatically starts after installation. This dialog can also be manually started to edit parameters at a later time:

Activating the configuration dialog (Windows 98)

> Open the Windows 98 Control Panel via Start - Settings - Control Panel.

> Double-click the Telephone icon. Activate the Telephone Driver tab in the Dialing Parameters dialog displayed.

> Select the HiPath TAPI 120/170 V2.0 TAPI 2.2 SP entry and click Configure.

Activating the configuration dialog (Windows ME)

> Open the Windows ME Control Panel via Start - Settings - Control Panel.

Activating the configuration dialog (Windows NT)

> Open the Windows NT Control Panel via Start - Settings - Control Panel.

(30)

> The Phone and Modem Options dialog is displayed. Activate the Advanced Options tab, select the entry HiPath TAPI 120/170 TAPI 2.0 SP from the list of providers displayed and click Configure.

Activating the configuration dialog (Windows XP)

> Open the Windows 2000 Control Panel via Start - Settings - Control Panel. Activate the Telephone and Modem Options by double-clicking the associated icon.

> The Phone and Modem Options dialog is displayed. Activate the Advanced Options tab, select the entry HiPath TAPI 120/170 TAPI 2.0 SP from the list of providers displayed and click Configure.

(31)

2.3.2.2 Configuration of TSP 120 parameters

The configuration dialog appears following installation or manual activation:

Display for HiPath 500

(32)

Display for CMD

Display for LIM

> Select the System which is connected to the extension in the field System. Possible entries are:

(33)

– CMD (CSTA Message Dispatcher)

(component of the HiPath 3000/5000 network, which distributes the CSTA interface of the connected system network-wide.)

– LIM (Line Interface Module)

> Depending on the selected System the field CSTA link shows one of the following connection types:

– HiPath 500: CSTA via TCP/IP – HG 1500: CSTA via S0

– CMD: CSTA via TCP/IP – for LIM: CSTA via TCP/IP

It is not possible to edit the field value.

> Enter the Call number of the extension and the Name of the user in the appropriate fields. > After selection of the system HG 1500 you can not edit the entries in the fields USBS-Call

number, CAPI2032.DLL and CAPI controller. Only by simultaneous operation of VCAPI

and CAPI with one PC adapter you can enter the driver and controller in these fields.

> If connected to the system HiPath 500 or to CMD operating in a HiPath 3000/5000 network or to LIM you have to enter the IP address of the system / the CMD / the LIM in the field IP

address. This address is determined during installation / configuration of the system / the

CMD / the LIM .

> If connected to the system HiPath 500 or to CMD in a HiPath 3000/5000 network or to LIM you have to enter the IP port of the system / the CMD / the LIM in the field IP port. The port number is determined during installation / configuration of the system / the CMD / the LIM .

> If connected to HiPath 500 or HG 1500 enter the range of trunk access codes in the fields

Trunk access code start and Trunk access code end. Usually you dont need to change

the recommended values.

> Set the option Trace for activating trace messages (CSTA messages) that can be interpreted using separate standard debugging tools.

> You can click on the Config Export or Config Import button for exporting / importing the configuration settings in / from a selected file.

> Click on the Save button to save the settings. Quit the dialog by clicking on the OK button. If you leave the dialog without saving your settings a message box appears.

(34)

Uninstall HiPath TAPI 120 and/or CMD

2.4 Uninstall HiPath TAPI 120 and/or CMD

To uninstall TAPI 120 and /or CMD proceed as follows:

> Open Start - Settings - Control Panel and click on Software. > Activate the entry HiPath TAPI 120 SPV2

– To uninstall one of both components click the Change button and follow the instruc-tions.

(35)

Index

Z

C

CMD advanced parameters 2-10 CMD assignment parameters 2-12, 2-15 CMD General Parameters 2-6, 2-8 CMD license parameters 2-19

CMD parameters for CTI firewall 2-17 CMD version information 2-20

Configuring the CMD component 2-5

I

Installation media 2-1

Installing the CMD component 2-3 Installing the TSP component 2-4

L

License monitoring 1-2

R

Requirements 1-4

S

Scope of installation 2-1 Solutions 1-1 Starting installation 2-1

T

TSP 120 parameters 2-23

U

(36)

(37)

(38)