Viewing the Vocera Ascom Adapter Requirements

System

The Vocera Ascom Adapter is designed for the Ascom Unite Connectivity Manager (UCM) version 3.00-A. This integration supports Ascom d62, i62, and i75 phones.

The Vocera Platform supports Version 4 of Ascom's Open Access Protocol (OAP).

Warning: The Vocera Ascom Adapter contains known issues when used in conjunction with Ascom Unite Connectivity Manager (UCM) version 4.04-B.

Ports

Port 1322/tcp is the inbound port on the Ascom Unite Connectivity Manager to which the Vocera Platform sends the outbound OAP messages.

Ports 5000-5004/tcp are the default incoming ports used by the Vocera Platform to receive responses from interactive messages from the UCM. Up to five Ascom UCM can be configured; port 5000 is used first by default, but any unused port can be assigned.

Warning: Do NOT use the following ports for an adapter configuration: 22, 8888, 8443, 1099, 52517, 3700, 3820, 3920, 4848, 7676, 8080, 8181, 8686, 13579, 36123, 41776, 52071, 5432, 80, 443, 25

Lines and Devices

One device is required per line that is registered with the Vocera Platform. The Vocera Platform will send messages to one device using a unique line. Multiple devices cannot receive messages from the same line.

Datasets

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.

The ASCOMMESSAGES Dataset details of every core object triggered by the Ascom interface.
The DEVICES Dataset stores all details of every device registered with Engage. Each device to which Engage can send a message must be listed in this dataset.
The LINES Dataset stores each telephone line reported by a device when it is registered.
The USERS Dataset stores all Engage users.

ASCOMMESSAGES Dataset

Element	Name	Reverse Name	Key	Reverse Key	Required	Type	Description
Attribute	delivery_object_id	N/A	True	N/A	N/A	Integer	Attribute that stores the delivery object id generated when the rule originally triggered.
Attribute	core_object_id	N/A	False	N/A	True	Integer	Attribute that stores the core object id of the record that originally triggered the rule.
Attribute	line_number	N/A	False	N/A	True	String	Attribute that stores the line number of the recipient for the delivery.
Attribute	rule_template_id	N/A	False	N/A	True	Integer	Attribute that stores the id of the rule template that was triggered.

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	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	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)

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.
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)