JTapiNonTriggeringSubscribe

Metreos.Providers.JTapi.JTapiNonTriggeringSubscribe

Summary

Registers a device with JTAPI.

Usage

JTapiNonTriggeringSubscribe will register a device dynamically. The specific Cisco Unified Communications Manager node to which the device is registered is decided by the specified DevicePoolName, which is described in mceadmin. Note that the device pool described by DevicePoolName is a Cisco Unified Application Environment configuration; it is completely distinct from device pools as defined by Cisco Unified Communications Manager.

If a device has successfully been registered with JTapiNonTriggeringSubscribe, then later that device can be unregistered with JTapiUnsubscribe.

Remarks

The JTapiNonTriggeringSubscribe action is a way for an application to register a device at application run-time. However, one can also specify devices for permanent JTAPI registration via the mceadmin web interface. he following information is meant to help determine if you should use the mceadmin 'static' mechanism, or the JTapiNonTriggeringSubscribe dynamic mechanism: if you know that you need to always monitor a phone in order to catch certain interesting events which occur non-deterministically, then use the static mechanism available via mceadmin. If instead you only need to monitor a phone for a specific, deterministic amount of time, then this dynamic mechanism is probably more ideal because there is a maximum number of concurrent JTAPI registrations possible for a given Cisco Unified Communications Manager cluster. By registering a device only as you need it, an application which does not have extremely high usage patterns could help keep the total number of registrations below this maximum concurrent amount, but still be able to control any device in the deployment as needed.

If the application server is restarted, then all registrations created via JTapiNonTriggeringSubscribe will be lost and are not automatically re-created upon startup of the application server.

Action Parameters
Parameter Name.NET TypeDefaultDescription
TimeoutSystem.Int32The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.
DeviceName *System.StringThe device name of the device to be registered.
DevicePoolName *System.StringThe device pool to which this device should be placed in. This device pool is configured in the mceadmin web interface, and does not correspond to device pools as defined by Cisco Unified Communications Manager.
DeviceType *System.StringThe device type of the device. This must currently be set to CtiMonitored in all situations.
Result Data
Parameter Name.NET TypeDescription
ResultCodeSystem.StringDescribes the result of the action with a textual success or error message.

Branch Conditions 

Success

No description.

Failure

No description.

Timeout

No description.