Viewing the Vocera Incoming VMI Adapter Requirements

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 ALERT_META_DATA Dataset stores the Metadata for persisting additional Alert information.
• The GROUPS Dataset stores all user groups.
• The RESPONSE_OPTIONS Dataset stores a response option for sending and replying with custom responses.
• The SITES Dataset stores all site information.
• The USERS Dataset stores all Vocera users.

ALERT_META_DATA Dataset

Element	Name	Reverse Name	Key	Reverse Key	Required	Type	Description
Attribute	message_key	N/A	True	N/A	N/A	String	Attribute that stores the locally unique message key for the message.
Attribute	interface	N/A	False	N/A	False	String	Attribute that stores the reference name of the processing interface.
Attribute	message_identifier	N/A	False	N/A	False	String	Attribute that stores the external identifier for the message.
Attribute	sender_id	N/A	False	N/A	False	String	Attribute that stores the external identifier for the client.

GROUPS 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 of the group.
Link	site	groups	True	False	N/A	Many-to-one	The GROUPS Dataset is linked to the SITES Dataset, and the link order is n:1 (many groups associated to one site)

RESPONSE_OPTIONS Dataset

Element	Name	Reverse Name	Key	Reverse Key	Required	Type	Description
Attribute	display_value	N/A	True	N/A	N/A	String	Attribute that stores a response value which may be used to display to the recipient.
Attribute	response_index	N/A	True	N/A	N/A	String	Attribute that stores the index of the response in the list of responses.
Attribute	response_value	N/A	True	N/A	N/A	String	Attribute that stores the response value to be sent back to the originating system.

SITES 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 unique name for the site.
Link	groups	site	False	True	N/A	One-to-many	The SITES Dataset is linked to the GROUPS Dataset, and the link order is 1:n (one site associated to many groups)
Link	users	site	False	False	N/A	One-to-many	The SITES Dataset is linked to the USERS Dataset, and the link order is 1:n (one site associated to many users)

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	site	users	False	False	N/A	Many-to-one	The USERS Dataset is linked to the SITES Dataset, and the link order is n:1 (many users associated to one site)