Cisco JTAPI is a Java-based telephony application programming interface that serves as a basic call control API.

Provides application portability and independence from any particular telephony gear or any particular Operating System.

Portal Configuration

The new presence connector is created as a sysadmin in the Jtel Web Portal.

Give the connector a name, and select CiscoCUCM Jtapi (Version) as the connector type.

The Configuration of the connector uses XML. In the following example, XML is used in the table below, to explain the settings.

Cisco CUCM Jtapi Presence Connector XML Settings
<?xml version="1.0" encoding="UTF-8"?>
<config>
	<implementation>
		<jar>
			<base>jtel-system-presence-connectors-cisco</base>
			<version>1.0</version>
		</jar>
		<class>de.jtel.system.presence.connectors.cisco.v10.CiscoJTAPIImplementation</class>
	</implementation>
	<parameters>
		<providerName>IP_ADDRESS</providerName>
		<user>JTAPI_USER</user>
		<password><![CDATA[JTAPI_USER_PASSWORD]]></password>
	</parameters>
	<addressTranslators>
		<translator>
			<match>^1(..)$</match>
			<replace>498946149501$1</replace>
		</translator>
		<translator>
			<match>^2(..)$</match>
			<replace>498946149502$1</replace>
		</translator>
	</addressTranslators>
	<addressExcluders>
		<excluder>
			<match>^9(..)$</match>
		</excluder>
	</addressExcluders>
	<behavior>
		<syncAcdUsers>0</syncAcdUsers>
		<syncPbxUsers>1</syncPbxUsers>
	</behavior>
</config>

Settings

SettingValueComments

implementation jar base

jtel-system-presence-connectors-cisco.v10

OR

jtel-system-presence-connectors-cisco.v12

Currently, Cisco v10 or v12 is supported. Configure the appropriate Cisco version.


implementation jar version
1.0
This version pertains to the jtel version of the connector implementation. Currently, version 1.0 is required (for all Cisco versions).
parameters providerNameIP_ADDRESSUse the IP Address or DNS Name of the CUCM Server.
parameters userJTAPI_USERUse the name of the configured user with JTAPI access in the CUCM Server.
parameters passwordJTAPI_USER_PASSWORD

Use the password of the configured user with JTAPI access in the CUCM Server.

Note: if special characters (not allowed in XML) are included in the password, these must be escaped inside a CDATA section as shown in the example configuration above.

addressTranslatorsXML Translator Definition

If the numbers reported by the CUCM server via JTAPI are not fully qualified E.164, they can be translated.

This assumes the portal has been configured fully to E.164, and may not be necessary for all installations.

The address translator mechanism provides a way to normalize the numbers before they are used to update the presence information in the jtel System.


A translator consists of two parts:

Match

A regular expression, which matches the number as reported by the CUCM.

For example, the following regex:

^1(..)$

Matches all 3 digit telephone numbers beginning with a 1. A grouping is used to isolate the last two digits of the number into group 1, referred to in the replacement as $1

Replace

The replacement to be made.

For example:

498946149501$1

This would cause the two-digit matched group from the regex to be appended to the string 498946149501.

Example

Input: 123

Output: 49894614950123

Recommendations

A number of translators can be used. They are all applied in sequence, so a little thought might be required to get the desired effect. It is recommended always to work with groupings and a specific length. Also, to prevent erroneous matches, the ^ (begin of string) and $ (end of the string) regex operators should be used.

addressExcludersXML Excluder Definition

Excluders are used to match number patterns which shall not be monitored.

For example, if trunks are passed to the jtel system, it does not make sense to monitor these entities.


An excluder consists of one part:

Match

A regular expression, which matches the number as reported by the CUCM.

For example, the following regex:

^9(..)$

Matches all 3 digit telephone numbers beginning with a 9, and will not setup monitor points to these numbers.

behavior syncAcdUsers0

Causes all reported extensions to be created as an ACD user. Setting this to 1 is not recommended.

Note: even if this is set to 0, the ACD user's presence status will still be set according to the current Tel1 field in the user record, and TelActive (the active telephone number).

behavior syncPbxUsers1Causes all reported extensions to be created as PBX Users. Setting this to 1 is recommended.
  • No labels