Viewing the Vocera Eventing Adapter Requirements

The minimum requirements for a Vocera Eventing Adapter installation are described here.

System

This adapter depends on Vocera Platform 5.5.4.

Ports

There are no port specifications for the Vocera Eventing Adapter

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.

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 raw_message N/A False N/A False String Attribute that stores the raw message payload.
Attribute sender_id N/A False N/A False String Attribute that stores the sender identifier.
Link paths alert_meta_data False False N/A Many-to-one The ALERT_META_DATA Dataset is linked to the EVENT_STATUS_ATTRIBUTE_PATHS Dataset, and the link order is n:1 (many alert_meta_datas associated to one event_status_attribute_path)

EVENT_STATUS_ATTRIBUTE_PATHS Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute activity_state_path N/A True N/A N/A String Attribute that stores the Attribute name where activity state is stored.
Attribute escalation_path N/A True N/A N/A String Attribute that stores the Attribute name where escalation is stored.
Attribute event_type_path N/A True N/A N/A String Attribute that stores the Attribute name where alert type is stored.
Attribute link_for_responses N/A True N/A N/A String Attribute that stores the Link to Responses dataset where the responses information is stored.
Link alert_meta_data paths False False N/A One-to-many The EVENT_STATUS_ATTRIBUTE_PATHS Dataset is linked to the ALERT_META_DATA Dataset, and the link order is 1:n (one event_status_attribute_path associated to many alert_meta_datas)

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.