Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 8.5(1)
Cisco Unified JTAPI Installation
Downloads: This chapterpdf (PDF - 930.0KB) The complete bookPDF (PDF - 12.68MB) | Feedback

Cisco Unified JTAPI Installation

Table Of Contents

Cisco Unified JTAPI Installation

Overview

Determining the Current JTAPI Version

Installing the Cisco Unified JTAPI Software

Silent Install Invocation

Command Line Invocation

End User Installation

Installation Procedures

Linux and Solaris Platforms

Verifying Linux and Solaris Installation

Windows Platforms

Verifying Windows Installation

Auto Install for Upgrades

Configuring Cisco Unified JTAPI Preferences

JTAPI Tracing Tab

Log Destination Tab

CallManagers Tab

Advanced Tab

Security Tab

Language Tab

Administering User Information for JTAPI Applications

Fields in the jtapi.ini File

Sample jtapi.ini file with default values


Cisco Unified JTAPI Installation


This chapter describes how to install and configure the Cisco Unified Java Telephony API (JTAPI) client software for Cisco Unified Communications Manager 6.0 and later releases.

This chapter contains the following topics:

Overview

Installing the Cisco Unified JTAPI Software

Auto Install for Upgrades

Configuring Cisco Unified JTAPI Preferences

Administering User Information for JTAPI Applications

Fields in the jtapi.ini File

Overview

The Cisco Java Telephony API (JTAPI) implementation comprises Java classes that reside on all client machines that run JTAPI applications. Installation of the Cisco Unified JTAPI implementation must take place before these applications can function correctly. Make sure that the Cisco Unified JTAPI classes are installed wherever JTAPI applications run, whether on Cisco Unified Communications Manager, a separate machine, or both.

Previously, the system supported installation of the JTAPI client only on Windows platforms. Beginning with the 5.0 release, the JTAPIInstaller provides a unified installation/uninstallation process for the JTAPI client for Linux, Windows, and Solaris, as listed in Table 4-1. For Linux and Solaris versions, the InstallShield MultiPlatform (ISMP) installer generates a binary file (.bin), and for the Windows version, it generates an executable file (.exe), after the set of files that need to be installed is obtained.

Table 4-1 Supported JVM Versions for Cisco Unified Communications Manager 

Platform
Release
CiscoUnified Communications Manager Release 4.x
CiscoUnified Communications Manager 5.x, 6.x, 7.x

Linux

AS 3.0

IBM JVM 1.3.1

IBM JVM 1.4.2

Sun JVM 1.3.1

Sun JVM 1.4.2

Sun JVM 1.5.0.4

Sun JVM 1.4.2

 

Red Hat 7.3

IBM JVM 1.3.1

IBM JVM 1.4.2

Sun JVM 1.3.1

Sun JVM 1.4.2

SunJVM 1.5.0.4

Sun JVM 1.4

Solaris

6.2 on SPARC

Sun JVM 1.3.1

Sun JVM 1.4.2

Sun JVM 1.5.0.4

Sun JVM 1.4.2

Windows

9x

Sun JVM 1.3.1

Sun JVM 1.4.2

Sun JVM 1.4.2

 

2000
NT 4.0+
XP (32 bit)
2003

Sun JVM 1.3.1

Sun JVM 1.4.2

Sun JVM 1.5.0_13

Sun JVM 1.5.0.4

Sun JVM 1.4.2

 

Vista (32 bit)

Sun JVM 1.3.1

Sun JVM 1.4.2

Sun JVM 1.5.0.4

Sun JVM 1.4.2



Note If you have upgraded to Cisco Unified Communications Manager 5.0, you must upgrade the JTAPI client software on any application server or client workstation on which JTAPI applications are installed. If you do not upgrade the JTAPI client, your application will fail to initialize. If you need to upgrade, download the appropriate client as described in the Installing the Cisco Unified JTAPI Software section.

Upgraded JTAPI client software does not work with previous releases of Cisco Unified Communications Manager.


Determining the Current JTAPI Version

To determine the JTAPI version number from the installer, use one of the following commands:

CiscoJtapiVersion.exe - silent -W newversion.check="1" -goto showversion

CiscoJtapiClient-linux.bin -silent -W newversion.check="1" -goto showversion

CiscoJtapiClient-solarisSparc.bin -silent -W newversion.check="1" -goto showversion

CiscoJtapiClient-solarisX86.bin -silent -W newversion.check="1" -goto showversion

These commands create a file called "jtapiversion.txt" in the folder where you execute the command. This file contains the JTAPI version in the format A.B(C.D).


Warning Installation of the new software may fail if you do not first manually uninstall any Release 4.X or earlier version of the JTAPI SDK.


When a previous JTAPI version is present in the system and an upgrade is made to the current version of JTAPI, the installer invokes the uninstaller of the previous release. If you want to invoke the previous uninstaller in silent mode on a Windows system, use the command

CiscoJtapiClient.exe -silent -W newversion.silent="1"

If it is installed, you can also use the JTAPI Preferences user interface utility tool to verify the installed JTAPI version.


Step 1 Choose Start > Programs > CiscoJTAPI > JTAPI Preferences. The following menu displays:

Step 2 Select the "ReadMe" file. This file identifies the currently installed version of Cisco Unified JTAPI.


Installing the Cisco Unified JTAPI Software

You can install the Cisco Unified JTAPI software in these modes:

Silent Install Invocation

Command Line Invocation

End User Installation

For the ISMP installer to run, the installer temporarily installs a Java Runtime Environment (JRE) version and uses it for its operation. The system removes the JRE during the uninstall operation.


Note Distribution of the JRE with the Cisco Unified JTAPIInstaller occurs in accordance with an agreement between Sun Microsystems, Inc., and Cisco Systems, Inc.



Warning Installation of the new software may fail if you do not first manually uninstall any Release 4.X or earlier version of the JTAPI SDK.


Silent Install Invocation

Applications can bundle the JTAPIInstaller along with their installation by using a silent install invocation of the JTAPIInstaller.

Applications that run the JTAPIInstaller in silent mode can use of the following commands:

Linux platforms—CiscoJTAPIClient-linux -silent

Solaris (Sparc) platforms—CiscoJTAPIClient-solarisSparc.bin -silent

Solaris (X86) platforms—CiscoJTAPIClient-solarisX86.bin -silent

Windows (Win9X, Win ME, Win2K, or WinXP) platforms—CiscoJTAPIClient.exe -silent

When you are performing a fresh install or an upgrade/downgrade, the JTAPIInstaller automatically detects the destination folders and does the silent install. The installer places the JTAPI Sample Applications and the JAR Files in the appropriate folders that the user specifies during installation or in the default folders in case of a silent install. However, if a previous version is present, the JTAPIInstaller does not know the applications path, so it creates the default folders, Lib and JTAPITools, and installs the applications in those folders.

For Windows clients, the JTAPIInstaller also updates the registry with the new install information. For Linux versions, it creates the file jtapiver.ini in the users home directory.

Command Line Invocation

To run the JTAPIInstaller interactively from the command line, enter one of the following commands from the command prompt:

Linux platforms—CiscoJTAPIClient-linux.bin -console

Solaris (Sparc) platforms—CiscoJTAPIClient-solarisSparc.bin -console

Solaris (X86) platforms—CiscoJTAPIClient-solarisX86.bin -console

Windows (Win9X, WinME, Win2K, or WinXP) platforms—CiscoJTAPIClient.exe -console

You will find that the command line mode is helpful for installing JTAPI in systems that do not have GUI support, such as Linux systems. A character-based menu, where the user is asked to provide a series of inputs based on the install time conditions, guides the entire installation procedure. This mode also provides all the other options that the GUI-based installer provides.

End User Installation

The JTAPI Installer uses a Java Foundation Classes (JFC) swing interface for the end user interface. The install procedure asks the user to provide a series of information and checks.

The installer creates and installs uninstallers on the target system, under the folder "_uninst." Find this folder under the JTAPI application path, which is normally C:\Program Files\JTAPITools for Windows and $HOME/.jtapi/bin for Linux). The user can invoke the uninstaller by using this path.

A log file that is named ismpInstall.txt (or ismpUninstall.txt) in the folder from which the installer/uninstaller is executed stores all details about the installation procedure. You can also use this file to check for any errors that may occur because it contains the entire list of traces of the various events that occur during product installation.

Installation Procedures

The following sections describe the installation procedures for the Linux, Solaris, and Windows platforms.

Linux and Solaris Platforms

Cisco Unified JTAPI supports multiple languages for the installation and JTAPI Preferences user interface.

The Cisco Unified JTAPIInstaller installs the following items on the local disk drive:

JTAPI java classes in $HOME/.jtapi/lib

JTAPI Preferences in $HOME/.jtapi/bin

JTAPI sample applications (makecall, jtrace) in $HOME/.jtapi/bin

JTAPI documentation in $HOME/.jtapi/bin/doc

Perform the following steps to install the Cisco Unified JTAPI software on a Linux/Solaris platform:


Step 1 Log in to the computer where you want to install the Cisco Unified JTAPI client software.

Step 2 Locate the appropriate ISMP installer and launch it:

CiscoJTAPIClient-linux.bin - for Linux OS

CiscoJTAPIClient-solarisSparc.bin - for Solaris Sparc OS

CiscoJTAPIClient-solarisX86.bin - for Solaris X86 OS

Step 3 Follow the instructions that the Cisco Unified JTAPI Installer presents.


Note The installation software installs the Cisco Unified JTAPI software on the default drive.
In Linux, for example, the default directory is $HOME/.jtapi/lib



Verifying Linux and Solaris Installation

To ensure that the JTAPI installation has been done properly, perform the following steps:


Step 1 Check that the .jtapiver.ini file was created in the $HOME directory.

Step 2 Check that the JTAPI Program files and documentation are present under the folder $HOME/.jtapi/bin.
Look for the makecall, jtrace, Locale_files, and doc folders.

Step 3 Check that the JTAPI Library is present under the folder $HOME/.jtapi/lib.
Look for the jtapi.jar, jtracing.jar, and updater.jar files.

Step 4 After ensuring that jtapi.jar is present in the classpath, run the following command from the command line prompt of $HOME/.jtapi/bin ./_jvm/bin/java:

com.cisco.services.jtprefs.jtprefsFrame

This should open the JTAPI Preferences dialog box.


Note In the absence of the JTPrefs application, you can generate the jtapi.ini file by entering:
< jview | java > CiscoJtapiVersion -parms
This command generates a jtapi.ini file in the current directory.



During installation, users can choose a different folder than $HOME to install JTAPI. In this case, the system creates a folder called .jtapi within the specified folder and creates the bin and lib folders within that folder for copying the corresponding files. For example, if the user chooses the folder name /home/jtapiuser, the folder structure would be

/home/jtapiuser/.jtapi/bin — Contains the makecall, jtrace, Locale_files, and doc folders.

/home/jtapiuser/.jtapi/lib — Contains the jtapi.jar, jtracing.jar, and updater.jar files

In this case, run the command at Step 4 from the /home/jtapiuser/.jtapi/bin folder.

Windows Platforms

Cisco Unified JTAPI supports multiple languages for the installation and JTAPI Preferences user interface. The Cisco Unified JTAPI Installer installs the following items on the local disk drive:

JTAPI Java classes in %SystemRoot%\java\lib

JTAPI Preferences in Program Files\JTAPITools

JTAPI sample applications (makecall, jtrace) in Program Files\JTAPITools

JTAPI documentation in Program Files\JTAPITools\doc

To install the Cisco Unified JTAPI software on a Windows platform, perform the following steps:


Step 1 Log in to the computer where you want to install the Cisco Unified JTAPI client software.

Step 2 Close all Windows programs.

Step 3 Locate the ISMP installer (CiscoJTAPIClient.exe) and launch it.

Step 4 Follow the installer instructions.



Note The installation software installs the Cisco Unified JTAPI software on the default drive.
When Windows NT is installed, for example, the default directory is C:\WINNT\Java\lib.


Verifying Windows Installation

To verify the JTAPI Windows installation, you can use the makecall application that allows you to place a call via JTAPI. Perform the following steps to use the makecall application.


Step 1 From the Windows NT command line, navigate to the directory where you installed Cisco Unified JTAPI Tools. By default, this directory is C:\Program Files\JTAPITools.

Step 2 Execute the following command:

java CiscoJtapiVersion

Step 3 Execute the following command:

java makecall <server name> <login> <password> 1000 <phone1> <phone2>


Note The server name variable specifies the hostname or IP address of the Cisco Unified Communications Manager (for example, CTISERVER).


The phone1 and phone2 variables designate directory numbers of IP phones or virtual phones that the user controls according to the user configuration. Refer to the Cisco Unified Communications Manager Administration Guide for details.

For the login and password variables, use the user ID and password that you configured in the Cisco Unified Communications Manager User Configuration window.


Auto Install for Upgrades

The auto install feature provides a facility by which an application at startup can identify itself to a Cisco Unified Communications Manager web server via an HTTP request and receive a response with the version of the required JTAPI API. The application compares the version that is available on the server to the local version in the application classpath and determines whether an upgrade is necessary.

The application makes changes in the init process to instantiate an updated API to discover the server installed component and download the component as needed.

The feature allows applications to refresh the jtapi.jar component to match the Cisco Unified Communications Manager and also provides a way to centrally deploy the jtapi.jar to which applications can auto update.

The API that is required to perform this functionality is packaged in the form of an updater.jar. Packaging for jtapi.jar and updater.jar includes a standard manifest that can be used to compare versions. Applications do not have to resort to instantiating a version class because this could make the API write protected from an update.

This feature, when specified with the location and component, downloads jtapi.jar from the server and copies it to local directory. The application can either copy the downloaded jtapi.jar with its copy by overwriting it or by changing the classpath to access the new jtapi.jar.


Note Auto Install does not update JTAPI preferences, TAPITestTools, updater.jar, and javadoc components. If applications require these components, install JTAPI from the Cisco Unified Communications Manager plug-in windows.


Configuring Cisco Unified JTAPI Preferences

Use the Cisco Unified JTAPI Preferences application (JTPREFS) to configure trace levels and trace destinations as well as several other system parameters. Installation of the Cisco Unified JTAPI Preferences into the Program Files\JTAPITools directory utility takes place by default. To open the Cisco Unified JTAPI Preferences utility, choose Start > Programs > Cisco Unified JTAPI > JTAPI Preferences.

This section, which describes how to use the Cisco Unified JTAPI Preferences application, includes the following topics:

JTAPI Tracing Tab

Log Destination Tab

CallManagers Tab

Advanced Tab

Security Tab

Language Tab

JTAPI Tracing Tab

The JTAPI Tracing tab lets you change trace settings only for the JTAPI layer. You can enable security install tracing levels on the Security Tab. Figure 4-1 illustrates the JTAPI Tracing tab of the Cisco Unified JTAPI Preferences application. The window title shows the JTAPI version number.

Figure 4-1 JTAPI Tracing Tab

The JTAPI Tracing tab lets you enable or disable JTAPI trace levels as listed in Table 4-2.

Table 4-2 JTAPI Trace Levels 

Jtapi.ini fields
Default
Min
Max
Description
Trace Levels

WARNING

None

N/A

N/A

Low-level warning events

INFORMATIONAL

None

N/A

N/A

Status events

DEBUG

None

N/A

N/A

Highest level debugging events

Debug Levels

JTAPI_DEBUGGING

None

N/A

N/A

JTAPI methods and events trace

JTAPIIMPL_DEBUGGING

None

N/A

N/A

Internal JTAPI implementation trace

CTI_DEBUGGING

None

N/A

N/A

Trace Cisco Unified Communications Manager events that are sent to JTAPI

CTIIMPL_DEBUGGING

None

N/A

N/A

Internal CTICLIENT implementation trace

PROTOCOL_DEBUGGING

None

N/A

N/A

Full CTI protocol decoding

MISC_DEBUGGING

None

N/A

N/A

Miscellaneous low-level debug trace


Log Destination Tab

The Log Destination tab allows you to configure how JTAPI creates traces and how they are stored. Figure 4-2 illustrates the Log Destination tab of the Cisco Unified JTAPI preferences application. Table 4-3 contains descriptions of the log destination fields.

Figure 4-2 Log Destination Tab

Table 4-3 Log Destination Fields 

Jtapi.ini fields
Default
Min
Max
Description

Enable Alarm Service
(UseAlarmService)

0

NA

NA

When this option is enabled, JTAPI alarms go to an alarm service that is running on the specified machine. You must specify the host name and port number when you enable this option.

Use Syslog
(UseSyslog)

FALSE

NA

NA

When this option is enabled, traces go to a UDP port as specified in the Collector and Port Number fields. Syslog collector service collects traces and directs them to the CiscoWorks2000 server.

Alarm Service Settings

Host Name

 

NA

NA

Use this field to specify the host name of the alarm service server.

Host Port

 

NA

NA

Use this field to specify the host port of the alarm service server.

Syslog Settings

Collector

0

NA

NA

Use this field to specify the Syslog collector service that collects traces.

Port Number

514

NA

NA

Use this field to specify the UDP port of the collector.

Use Rotating Log Files
(SyslogCollector)

FALSE

NA

NA

This field allows you to direct traces to a specific path and folder. No fewer than two log files and no more than 99 files can exist. Cisco Unified JTAPI rotates through the log files in numerical order, returning to the first log file after filling the last. Log files increase in size in 1-megabyte increments.

Use Java Console
(UseSystemDotOut)

FALSE

NA

NA

When this option is enabled, tracing goes to the standard output or console (command) window.

Log File Settings

Maximum Number of Log Files
(NumTraceFiles)

10

2

1000

This setting lets you specify the maximum number of log files to be written.

Maximum Log File Size
(TraceFileSize)

1048576

1048576

NP

This setting lets you specify the maximum size of log files to be written.

Use the Same Directory
(UseSameDirectory)

1

NA

NA

This setting lets you specify whether the same folder name should be used for each instance of an application.

When this option is enabled, JTAPI traces the log files to the same directory. In this case, successive instances of a JTAPI application will restart the log files, starting at index 01.

When this option is disabled, each instance of the application, whether successive or simultaneous, will cause trace files to be placed in a new folder sequential to the last folder that was written. Cisco Unified JTAPI detects the last folder present in the trace path and automatically increments the numeric index.

Trace Path
(TracePath)

.

NA

NA

This setting lets you specify the path name to which trace files are written. When the path is not specified, JTAPI defaults to the application path.

Directory Name Base
(Directory)

.

NA

NA

This setting lets you specify a folder name where the trace files will be contained.

File Name Base
(FileNameBase)

Cisco
Jtapi

NA

NA

Use this value to create the trace file name.

File Name Extension
(FileNameExtension)

log

NA

NA

This setting lets you specify a numerical index to append to the file base name indicates the order in which trace files are created.

If you enter "jtapiTrace" in the File Name Base field and "log" in the File Name Extension field, the system names the trace files jtapiTrace01.log, jtapiTrace02.log, and so on. If the File Name Base and File Name Extension fields are left blank, JTAPI picks the trace files names as CiscoJtapi01.log, CiscoJtapi02.log, and so on.


CallManagers Tab

This tab allows you to define a list of Cisco Unified Communications Managers that a JTAPI application can present to the user for optional Cisco Unified Communications Manager connectivity. Figure 4-3 illustrates the CallManagers tab of the preferences application.

Figure 4-3 CallManagers Tab

Advanced Tab

You can configure the parameters in Table 4-4 through the Advanced tab in the JTPrefs application. You may need these low-level parameters for troubleshooting and debugging purposes only. Figure 4-4 illustrates the Advanced tab of the preferences application.

Figure 4-4 Advanced Tab


Note Cisco strongly recommends that you not modify the parameters in Table 4-4 unless the Cisco Technical Assistance Center (TAC) instructs you to do so.


Table 4-4 Advanced Configuration Fields 

Jtapi.ini fields
Default
Min
Max
Description

Enable Periodic Wakeup
(PeriodicWakeupEnabled)

FALSE

(disabled)

NA

NA

Enables (or disables) a heartbeat in the internal message queue that JTAPI uses. If JTAPI has not received a message in the time that is defined in PeriodicWakeupInterval, it causes the thread to wake up and creates a log event.

Periodic Wakeup Interval
(PeriodicWakeupInterval)

50

NP

NP

Allows you to define a period of inactivity in the JTAPI internal message thread (in seconds). If JTAPI has not received a message during this time, the thread wakes up and logs an event.

Enable Queue Stats
(QueueStatsEnabled)

FALSE

(disabled)

NA

NA

Causes JTAPI to log the max queue depth over the specified number of messages that are queued to JTAPI main event thread.

For every x messages processed, JTAPI logs a DEBUGGING level trace that reports the maximum queue depth over that interval, where x represents the number of messages that are specified in Queue Size Threshold.

Queue Size Threshold
(QueueSizeThreshold)

25

10

NP

Specifies the number of messages that define the interval over which JTAPI will report the maximum queue depth.

CTI Request Timeout
(CtiRequestTimeout)

15

10

NP

Specifies the number of seconds that JTAPI will wait for a response from a CTI request.

Provider Open Request Timeout
(ProviderOpenRequestTimeout)

200

10

NP

Specifies the number of seconds that JTAPI will wait for a response to a Provider Open Request.

Provider Retry Interval
(ProviderRetryInterval)

30

5

NP

Specifies the number of seconds that JTAPI will retry opening connection to a Cisco Unified Communications Manager cluster in case of system failure.

Server Heartbeat Interval
(DesiredServerHeartbeatInterval)

30

>0

NP

Specifies the interval at which the connection between JTAPI and the Cisco Unified Communications Manager cluster will get verified (in seconds).

If JTAPI fails to receive heartbeats, it will establish a connection via the second CTIManager that is specified in the provider open request.

Route Select Timeout
(RouteSelectTimeout)

5000

0

NP

Specifies the interval in milliseconds that JTAPI will wait for the application to respond to the Route event. If the application does not respond in this time, JTAPI ends the route and sends the corresponding RouteEnd event.

Post Condition Timeout

15

0

NP

Specifies the timeout.


Security Tab

Figure 4-5 illustrates the Security tab of the preferences application.

Figure 4-5 Security Tab

Application users need to configure the User Name, InstanceID, Authorization Code, TFTPServer IP-Address, and CAPFServer IP-Address parameters through the JTAPI Preferences application before invoking the JTAPI API or JTAPI Preferences to download/install certificates on the application server.

You can use JTAPI Preferences to configure security profiles for one or more userName/instanceID pair. If an application user has previously configured a security profile for a userName/instanceID pair, the security profile automatically populates when the user enters the username/instanceID and clicks any of the other edit boxes.

Apart from the GUI that is provided through JTAPI Preferences, an application can also install a client certificate by calling the interface that is provided at CiscoJtapiProperties. When Interface UpdateCertificate() is called, the JTAPI client connects to the TFTP server to download the CTL file and extract certificates to the given certificate path. It then connects to the CAPF server to download the client certificate and installs it into the given certificate path.

The jtapi.ini files store user security records in comma separated value (CSV) format. Semicolons separate individual records. An example of a users security record follows:

SecurityProperty=user,123,12345,172.19.242.37,3804,172.19.242.37,69,.\\,true,false;<next record>; ...

You can configure the following parameters on the Security tab:

Table 4-5 JTAPI Security Configuration Fields 

Jtapi.ini fields
Default
Min
Max
Description

Enable Security Tracing
(SecurityTraceEnabled)

FALSE

NA

NA

You can enable (or disable) tracing for certificate install operations by checking this check box and choosing the desired trace level.

Select Trace Level
(SecurityTraceLevel)

0

0

2

You can choose one of three different trace levels:

Error=0 — Logs error events

Debug=1 — Logs debugging events

Detailed=2 — Logs all events

User Name
(Username)

NA

NA

NA

If application users have previously configured a security profile for a userName/instanceID pair, that security profile automatically populates when the user enters the username/instanceID and clicks any of the other edit boxes.

Instance ID
(instanceID)

NA

NA

NA

This field specifies the application instance identifier. If an application is connecting to CTIManager with the same user, it needs to define an instanceID for each instance of the application to download the certificate Authorization String.

Authentication String
(authcode)

NA

NA

NA

This field specifies a one-time string that is used to download a certificate.

TFTP Server IP Address

NA

NA

NA

This field specifies the IP address of the TFTP server (normally the Cisco Unified Communications Manager IP Address).

TFTP Server Port

69

NP

NP

The TFTP Server Port defaults to 69. Do not change this value unless the System Administrator advises you to do so.

CAPF Server IP Address

NA

NA

NA

This field specifies the IP address of the CAPF server in dotted decimal.

CAPF Server Port

3804

NP

NP

The CAPF Server Port number defaults to 3804; however, you can also configure this number in the Cisco Unified Communications Manager Administration. Ensure that the value that is entered through the JTAPI Preferences matches the one that is configured in Cisco Unified Communications Manager Administration.

Certificate Path

JTAPI.jar
location

NA

NA

This field specifies the path where the application wants server and client certificates to be installed. If this field is blank, the system installs certificates in the ClassPath of JTAPI.jar.

Enable Secure Connection

FALSE

NA

NA

Check this option to enable a secure TLS connection to Cisco Unified Communications Manager. If this option is not checked, JTAPI cannot make a nonsecure connection to CTI even if the certificate is updated/installed.

Certificate Update Status

NA

NA

NA

This field provides information on whether the certificate has been updated.

Delete Certificate

NA

NA

NA

This button deletes the existing certificate.

Update Certificate

NA

NA

NA

This button updates the existing certificate with the changed parameters.


Language Tab

Figure 4-6 illustrates the Language tab of the preferences application.

Figure 4-6 Language Tab

The Language tab allows you to select one of the installed languages to view the configuration settings in that language. You can select the following languages:

Arabic

Brazilian Portuguese

Chinese Taiwan

Croatian

Czech

Danish

Dutch

English

Finnish

French

German

Greek

Hebrew

Hungarian

Italian

Japanese

Nederlands

Norwegian

Polish

Portuguese

Russian

Simplified Chinese

Slovak

Spanish

Swedish


Select a language, and the tabs display with text in that language.

Administering User Information for JTAPI Applications

The JTAPI application requires that users be given the privilege to control one or more devices. Follow the procedures for adding a user and assigning devices to a user in the "Adding a New User" section before using the JTAPI application. The list of devices that are assigned to the user represents the phones that the user needs to control from the application (for example, make calls and answer calls).

Fields in the jtapi.ini File

Applications that run in non-GUI based platforms, where JTPrefs cannot be invoked, can write their own jtapi.ini file and place it along with jtapi.jar based on the values that are provided here. JTAPI will make use of these values to configure itself.

Applications should ensure that they provide valid data as described in Table 4-6. Applications have responsibility for errors that are caused in JTAPI behavior due to improper jtapi.ini file values.

NA: Not Applicable
NP: Not Present

Table 4-6 Fields in jtapi.ini File 

Jtapi.ini fields
Default
Min
Max
Description

INFORMATIONAL

0

NA

NA

This field specifies status events

DEBUG

0

NA

NA

This field specifies highest level debugging events

WARNING

0

NA

NA

This field specifies low-level warning events

JTAPI_DEBUGGING

0

NA

NA

This field specifies JTAPI methods and events trace

JTAPIIMPL_DEBUGGING

0

NA

NA

This field specifies internal JTAPI implementation trace

CTI_DEBUGGING

0

NA

NA

This field specifies trace Cisco Unified Communications Manager events that are sent to the JTAPI implementation

CTIIMPL_DEBUGGING

0

NA

NA

This field specifies internal CTICLIENT implementation trace

PROTOCOL_DEBUGGING

0

NA

NA

This field specifies full CTI protocol decoding

MISC_DEBUGGING

0

NA

NA

This field specifies miscellaneous low-level debug trace

DesiredServerHeartbeatInterval

30

>0

NP

This field specifies how often, in seconds, the connection between JTAPI and the Cisco Unified Communications Manager cluster will be verified. If JTAPI fails to receive heartbeats, it will establish a connection via the second CTIManager that is specified in the provider open request.

TracePath

.

NA

NA

This field specifies the path name to which the trace files are written. When the path is not specified, JTAPI makes the application path as the default.

FileNameExtension

log

NA

NA

This field specifies a numerical index that is appended to the file base name to indicate the order in which the files are created. For example, if you enter jtapiTrace in the File Name Base field and log in the File Name Extension field, the trace files would rotate between jtapiTrace01.log, jtapiTrace02.log, and jtapiTrace10.log. If the File Name Base and File Name Extension fields are left blank, Cisco Unified JTAPI picks the trace files names as CiscoJtapi01.log, CiscoJtapi02.log, and so on.

SyslogCollector

FALSE

NA

NA

This field specifies you to direct the traces to a specific path and folder in the system. No fewer than two log files and no more than 99 files can exist. Cisco Unified JTAPI rotates through the log files in numerical order, and returns to the first log file after filling the last. Log files increase in size in 1-megabyte increments.

TraceFileSize

1048576

1048576

NP

This field allows you to specify the maximum size of log files to be written.

UseAlarmService

0

NA

NA

When this option is enabled, JTAPI alarms go to an alarm service that is running on the specified machine. You must specify the host name and port number if you enable this option.

ProviderOpenRequestTimeout

200

10

NP

This field specifies the time in seconds that JTAPI will wait for a response for the Provider Open Request. The default is 10 seconds.

JtapiPostConditionTimeout

15

10

20

JTAPI has post conditions for events, and if the post condition is not met before a timeout, JTAPI will throw exceptions. Use this field to set the timeout value of such conditions.

ApplicationPriority

2

NA

NA

This field prioritizes multiple provider open requests. Currently, JTAPI only sends a default value.

SecurityTraceEnabled

FALSE

NA

NA

This field enables tracing for security-related messages.

You can enable (or disable) tracing for certificate install operations by selecting this check box and selecting the desired trace level.

AlarmServicePort

1444

NP

NP

This field is used for sending alarms to a different server. Users can select the alarm server host name and port on which the service is running, and JTAPI will send the alarms to the specified server and port.

AlarmServiceHostname

null

NA

NA

This field displays the alarm server host name.

RouteSelectTimeout

5000

0

NP

This field specifies the time, in milliseconds, that JTAPI waits for the application to respond to the Route event. If the application does not respond in this time, JTAPI ends the route and sends the corresponding RouteEnd event.

ProviderRetryInterval

30

5

NP

This field specifies the time, in seconds, that JTAPI will retry opening a connection to the Cisco Unified Communications Manager cluster in case of system failure.

QueueStatsEnabled

FALSE

NA

NA

This field is used by JTAPI to log the max queue depth over the specified number of messages that are queued to JTAPI main event thread. In other words, for every x messages processed, JTAPI logs a DEBUGGING level trace that reports the maximum queue depth over that interval, where x represents the number of messages that are specified in Queue Size Threshold.

FileNameBase

CiscoJtapi

NA

NA

This field specifies a value to create the trace file name.

PeriodicWakeupEnabled

FALSE

NA

NA

This field enables (or disables) a heartbeat in the internal message queue that JTAPI uses. If JTAPI has not received a message in the time that is defined in PeriodicWakeupInterval, it causes the thread to wake up and creates a log event.

JTAPINotificationPort

2789

1

NP

This field specifies the Port through which the JTAPI parameter changes are communicated to JTAPI applications during runtime.

PeriodicWakeupInterval

50

NP

NP

This field allows you to define a time of inactivity in the JTAPI internal message thread. If JTAPI does not received a message during this time, the thread wakes up and logs an event.

QueueSizeThreshold

25

10

NP

This field allows you to specify the number of messages that define the time over which JTAPI will report the maximum queue depth.

UseSystemDotOut

FALSE

NA

NA

This field is used to display traces on the console.

UseSameDirectory

1

NA

NA

This field allows you to specify whether the same folder name must be used for each instance of an application.

When this option is enabled, JTAPI traces the log files to the same directory. In this case, successive instances of a JTAPI application will restart the log files, starting at index 01.

When this option is disabled, each instance of the application, whether successive or simultaneous, will cause the trace files to be placed in a new folder sequential to the last folder that was written. Cisco Unified JTAPI detects the last folder in the trace path and automatically increments the numeric index.

NumTraceFiles

10

2

1000

This field allows you to specify the maximum number of log files to be written.

UseSyslog

FALSE

NA

NA

This field, when enabled, allows the traces go to a UDP port as specified in the Collector and Port Number fields. Syslog collector service collects traces and directs them to the CiscoWorks2000 server.

SecurityTraceLevel

0

0

2

This field specifies trace level for security messages
0 = Error, 1 = debug, 2 = detailed

UseTraceFile

TRUE

NA

NA

This field enables the writing of logs to logFile Trace Writer.

CMAssignedAppID

0

NA

NA

This field specifies the feature ID that is assigned to the application. Cisco Unified Communications Manager preassigns this ID.

CtiManagers

null

NA

NA

This field specifies the list of CTI Managers for which tracing needs to be collected.

Directory

.

NA

NA

This field allows you to specify a folder name where the trace files will be contained.

Security Property

SecurityProperty=username, instanceId, authcode,
tftp ip address, tftp port,
capf ip address, capf port, certificate path, security option, certificate status

NA

NA

NA

This field specifies the users security record (username, instanceId, authcode, tftp ip address, tftp port, capf ip address, capf port, certificate path, security option, certificate status), that will be stored in jtapi.ini files in a comma separated string. A semicolon separates the records.

SecurityProperty=user,123,12345,172.19.242.37, 3804,172.19.242.37,69,.\\,true,false;<next record>;...

Username

NA

NA

NA

This field automatically populates the security profile of an application user who has previously configured a userName/instanceID pair and clicks any of the other edit boxes.

instanceId

NA

NA

NA

This field specifies the application instance identifier. If an application is connecting to CTIManager with the same user, it needs to define an instanceID for each instance of the application to download the certificate Authorization String.

authcode

NA

NA

NA

This field specifies authorization string that is configured in the Cisco Unified Communications Manager database. This can be used only once for getting certificate.

Communications Manager TFTP IP address

NA

NA

NA

This field specifies the TFTP Address of Cisco Unified Communications Manager (normally, the Cisco Unified Communications Manager IP Address)

CallManger TFTP port

69

NP

NP

This field displays the default value of the CallManager TFTP port.
Do not change the default value of 69 unless advised to do so by the System Administrator.

Communications Manager CAPF IP server address

NA

NA

NA

This field specifies CAPF Server IP Address

Communications Manager CAPF server port

3804

NP

NP

This field displays the default value (3804) for CAPF server port. Be aware, you can configure this value in Cisco Unified Communications Manager Administration service parameters. Ensure that the value you enter through this interface should match the value configured on Cisco Unified Communications Manager Administration window.

Certificate path

JTAPI.jar

location

NA

NA

This field specifies the location where application wants sever and client certificates to be installed. If this field is left blank, the system installs certificates in the ClassPath of JTAPI.jar

Enable secure connection

TRUE

NA

NA

This field, if set to TRUE then JTAPI will make a nonsecure connection to CTI even if certificates are updated/installed.

Certificate Update Status

NA

NA

NA

The JTAPI Preferences dialog box is used to configure the security profile for one or more userName/instanceID pairs.


Sample jtapi.ini file with default values

#Cisco Unified JTAPI version 7.0(1.1000)-1 Release ini parameters
#Wed Sep 14 16:55:30 PDT 2008
INFORMATIONAL=0
DesiredServerHeartbeatInterval=30
TracePath=.
FileNameExtension=log
SyslogCollector=
TraceFileSize=1048576
UseAlarmService=0
ProviderOpenRequestTimeout=200
JtapiPostConditionTimeout=15
ApplicationPriority=2
SecurityTraceEnabled=0
AlarmServicePort=1444
RouteSelectTimeout=5000
ProviderRetryInterval=30
QueueStatsEnabled=0
FileNameBase=CiscoJtapi
JTAPI_DEBUGGING=0
PeriodicWakeupEnabled=0
CTI_DEBUGGING=0
JTAPINotificationPort=2789
Traces=WARNING;INFORMATIONAL;DEBUG
PeriodicWakeupInterval=50
AlarmServiceHostname=
QueueSizeThreshold=25
Debugging=JTAPI_DEBUGGING;JTAPIIMPL_DEBUGGING;CTI_DEBUGGING;CTIIMPL_DEBUGGING; 
PROTOCOL_DEBUGGING;MISC_DEBUGGING
PROTOCOL_DEBUGGING=0
UseSystemDotOut=0
MISC_DEBUGGING=0
UseSameDirectory=1
NumTraceFiles=10
UseSyslog=0
DEBUG=0
SecurityTraceLevel=0
UseTraceFile=1
WARNING=0
CMAssignedAppID=0
UseProgressAsDisconnectedDuringErrorEnabled=0
CtiManagers=;;;;;;;;;
Directory=
CTIIMPL_DEBUGGING=0
CtiRequestTimeout=30
JTAPIIMPL_DEBUGGING=0
SyslogCollectorUDPPort=514
SecurityProperty=cisco,123,12345,A.B.C.D,3804,A.B.C.D,69,/C\:/Program 
Files/JTAPITools/./,false,false;