Understanding a Vocera CUCM Adapter Configuration |
The minimum requirements for a Vocera CUCM Adapter (CUCM) installation are described here.
The Vocera Platform requires Cisco Unified Communications Manager server version 7.1.3. or higher.
The Vocera CUCM Adapter will register only the line configured for Button 1 on that phone in order to receive messages. Sending messages to multiple lines on the same phone is not supported.
The phone must be reset if a new line is added to an existing phone in Communications Manager and the Vocera CUCM Adapter is already enabled in Vocera Platform.
Cisco phones connect to the Vocera Platform via port 80/tcp (or 443/tcp if SSL is enabled).
The network connectivity used in communicating with CUCM is handled by the JTAPI library via port 2748/tcp.
One device is required per line that is registered with Vocera Platform. Vocera Platform will send messages to one device using a unique line. Multiple devices cannot receive messages from the same line.
An adapter defines a default Dataset structure in order to function. Attributes are organized by Datasets and store the information required by the adapter. Adapters use this data during the process of receiving and sending messages.
Not all adapters require Datasets to function. When an adapter does require Datasets, the system will determine if they already exist. If they do not exist, the system will create the needed Datasets.
When creating or editing an adapter, use the following information to select the appropriate datasets in the Required Datasets section.
CALLED_PARTIES Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | number | N/A | True | N/A | N/A | String | Attribute that stores the phone number that a call was placed from or to. |
Attribute | caller_id | N/A | False | N/A | False | String | Attribute that stores the caller ID of a person making or receiving a phone call. |
Link | call | called_parties | True | False | N/A | Many-to-one | The CALLED_PARTIES Dataset is linked to the CALLS Dataset, and the link order is n:1 (many called_parties associated to one call) |
CALLS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | call_id | N/A | True | N/A | N/A | String | Attribute that stores the ID of a call. Not to be confused with caller ID. This is an internal Call Manager identifier. |
Attribute | established | N/A | False | N/A | True | Date/Time | Attribute that stores time when the call was established. |
Attribute | number | N/A | False | N/A | True | String | Attribute that stores the phone number that a call was placed from or to. |
Attribute | status | N/A | False | N/A | True | String | Attribute that stores the status of the call. One of INITIATING, CONNECTING, RINGING, ANSWERED, COMPLETED, or FAILED. |
Attribute | caller_id | N/A | False | N/A | False | String | Attribute that stores the caller ID of a person making or receiving a phone call. |
Attribute | duration | N/A | False | N/A | False | Integer | Attribute that stores the length of a call. |
Link | called_parties | call | False | True | N/A | One-to-many | The CALLS Dataset is linked to the CALLED_PARTIES Dataset, and the link order is 1:n (one call associated to many called_parties) |
DEVICES Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | name | N/A | True | N/A | N/A | String | Attribute that stores the name that identifies the device, often based upon the MAC address of the device. |
Attribute | status | N/A | False | N/A | True | String | Attribute that stores the current registration status of the device. Possible values are Registered, Disconnected, Virtual, or Unregistered. |
Attribute | vendor | N/A | False | N/A | True | String | Attribute that stores the vendor of the device. For example, Cisco or XMPP. |
Attribute | ip_address | N/A | False | N/A | False | String | Attribute that stores the current IP address of the device. In some cases Engage needs to keep track of the IP address of a device, such as with a Cisco phone. |
Attribute | priority | N/A | False | N/A | False | String | Attribute that stores the priority level of the most recent message sent to a device. Required by the device management library, but not set by the XMPP adapter. It is used as a filter to prevent less important messages from being sent to a user currently handling a critical issue. |
Attribute | token | N/A | False | N/A | False | String | Attribute that stores a special identifier needed by some devices, such as smart phones, in order to deliver a message. |
Link | history | device | False | False | N/A | One-to-many | The DEVICES Dataset is linked to the REGISTRATION_HISTORY Dataset, and the link order is 1:n (one device associated to many registration_histories) |
Link | lines | devices | False | False | N/A | One-to-many | The DEVICES Dataset is linked to the LINES Dataset, and the link order is 1:n (one device associated to many lines) |
Link | usr | devices | False | False | N/A | Many-to-one | The DEVICES Dataset is linked to the USERS Dataset, and the link order is n:1 (many devices associated to one user) |
LINES Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | number | N/A | True | N/A | N/A | String | Attribute that stores an actual telephone or directory number |
Link | device_history | line | False | False | N/A | One-to-many | The LINES Dataset is linked to the REGISTRATION_HISTORY Dataset, and the link order is 1:n (one line associated to many registration_histories) |
Link | devices | lines | False | False | N/A | Many-to-one | The LINES Dataset is linked to the DEVICES Dataset, and the link order is n:1 (many lines associated to one device) |
PRESENCE_UPDATE Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | timestamp | N/A | True | N/A | N/A | Date/Time | Attribute that stores the time this PresenceUpdate record was created. |
Attribute | show | N/A | False | N/A | False | String | Attribute that stores the show of the presence to set. |
Attribute | status | N/A | False | N/A | False | String | Attribute that stores the status of the presence to set. |
Link | usr | presence_updates | True | False | N/A | Many-to-one | The PRESENCE_UPDATE Dataset is linked to the USERS Dataset, and the link order is n:1 (many presence_updates associated to one user) |
REGISTRATION_HISTORY Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | device_status | N/A | False | N/A | False | String | Attribute that stores the current registration status of the device. |
Attribute | ip_address | N/A | False | N/A | False | String | Attribute that stores the device's current IP address. |
Attribute | token | N/A | False | N/A | False | String | Attribute that stores some devices, such as smartphones, require a special identifier in order to receive a message. The token is used to store that special identifier. |
Link | device | history | False | False | N/A | Many-to-one | The REGISTRATION_HISTORY Dataset is linked to the DEVICES Dataset, and the link order is n:1 (many registration_histories associated to one device) |
Link | line | device_history | False | False | N/A | Many-to-one | The REGISTRATION_HISTORY Dataset is linked to the LINES Dataset, and the link order is n:1 (many registration_histories associated to one line) |
Link | usr | device_history | False | False | N/A | Many-to-one | The REGISTRATION_HISTORY Dataset is linked to the USERS Dataset, and the link order is n:1 (many registration_histories associated to one user) |
USERS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | login | N/A | True | N/A | N/A | String | Attribute that stores the login name of the user. |
Attribute | presence_show | N/A | False | N/A | False | String | Attribute that stores the current presence show value for the user. |
Attribute | presence_status | N/A | False | N/A | False | String | Attribute that stores the current presence status message for the user. |
Link | device_history | usr | False | False | N/A | One-to-many | The USERS Dataset is linked to the REGISTRATION_HISTORY Dataset, and the link order is 1:n (one user associated to many registration_histories) |
Link | devices | usr | False | False | N/A | One-to-many | The USERS Dataset is linked to the DEVICES Dataset, and the link order is 1:n (one user associated to many devices) |
Link | presence_updates | usr | False | True | N/A | One-to-many | The USERS Dataset is linked to the PRESENCE_UPDATE Dataset, and the link order is 1:n (one user associated to many presence_updates) |