These settings enable direct communication between the Vocera Eventing Adapter and the Vocera Platform.
Select an empty field and begin typing, or select an existing value and type over it. To keep an existing value, do not edit that field.
-
Navigate to the New Adapter option, or navigate to an existing adapter to edit.
See Creating a New Adapter and Editing an Adapter for instruction as needed.
The configuration fields are the same for new and existing adapters.
-
Complete the Datasets Settings configuration fields as
described in the table.
Datasets Configuration Field Description Required Datasets If more than one dataset exists that meets the adapter's requirements, select the appropriate datasets for the new adapter to function correctly. The system searches for the datasets that meet the adapters requirements. If the datasets already exist, the system will use them. If the datasets do not exist, the system will create them automatically.
Select Create in the drop-down menu to create a new dataset to meet the organization's requirements.
-
Complete the Main Settings configuration fields as
described in the table.
General Settings Configuration Field Description Sender Patterns A list of regular expressions to be matched to the sender for incoming messages. If none are specified, then this configuration will handle any message not handled by another active configuration. Report Non-Matching Messages as Audit Events Select this box to create an audit log event for messages that do not match message definition. This field is optional. Method Type Specify the type of message to retrieve the status of an Event. Message Timeout The amount of time, in minutes, that is expected to elapse between messages. The value must be a number between 1 and 10080. An Audit Event (610) will be generated if a message is not received when expected. -
Complete the Message Types configuration fields as
described in the table.
The Vocera Eventing Adapter message types include a regex mapping for the event data. Because of the nature of the response mechanism and the need to persist data across a failover, the Eventing interface must store additional information about alerts. This data will be persisted in a separate dataset, AlertMetaData, which is tied to the original alert by a locally unique identifier, referred to as the Message Key.
Response OptionsBecause an MCR message may contain multiple responses, the adapter must be able to store each response type and have a default Accept response and a default Decline response. Each MCR type may vary in response options between interface configurations and message types, so each message type should be configured with a Regex to match the correct Accept response and separate Regex to match the correct Decline response.
Implementation specialists may add, clone, remove, or modify message types as needed. If there are multiple message types configured, one or more can be deleted. Message types can be reordered by dragging and dropping each into the preferred order. See Understanding Regular Expressions for additional information.
Message Type Configuration Field Description Reference Name Enter a descriptive name to identify the message type. This field is required. Active Select the Active checkbox to indicate whether or not the message type is active. Discard Message Select the Discard Message checkbox to disregard this type of message without processing it. Discarded message types may be created for the sole purpose of filtering them from the audit log. Starting Dataset Select a dataset from the dropdown box. The dataset selected should be where you want to save messages of this type. Message Regex Specify the regular expression (Regex) necessary to parse the body of the incoming message into the value expressions contained in the Regex Mapping field. Specify a Regex to capture values from the Message Data of a message received from an Eventing endpoint. Message Mapping Specify one or more attributes, or attribute paths, to be filled with data from the Message Regex. One attribute or attribute path per line. Two different types of patterns for the attribute mapping are supported: Plain Attribute and Statement of Equality. If using a Plain Attribute list, each item in the mapping is a simple attribute path. The first capture group of the matched regular expression is used as the value of the first attribute path in the list, and so on. The number of capture groups in the Regex must match the number of attribute paths in the list. The Syntax: dataset_link_attr_name.attr_name or dataset_attr_name.
If using Statements of Equality, the left hand side is the attribute path, while the right-hand side is what the attribute path should be set to. The right-hand side should use numbered captured groups (e.g. $1) to reference elements matched, but may also include literal strings. Syntax: dataset_link_attr_name.attr_name=LITERAL, dataset_attribute_name=$1, or example_with_two_capture_groups=$2:$1
Message Key Path Specify the location into which the "global identifier" will be stored so that responses and status updates can be sent. Sender ID Path Specify the optional location into which to store the Sender ID specified in the message. Link for Response Options The link to the Response options dataset where the matching response options will be stored. -
Complete the Location configuration fields as described
in the table.
Message Types Configuration Field Description Store Location Select the checkbox to indicate that data should be stored in the specified location. Location Regex Specify a Regex to capture location values from the Place Data of a message received from an Eventing endpoint. Location Regex Mapping Specify one or more attributes, or attribute paths, to be filled with data from the Message Regex. One attribute or attribute path per line. Two different types of patterns for the attribute mapping are supported: Plain Attribute and Statement of Equality. If using a Plain Attribute list, each item in the mapping is a simple attribute path. The first capture group of the matched regular expression is used as the value of the first attribute path in the list, and so on. The number of capture groups in the Regex must match the number of attribute paths in the list. The Syntax: dataset_link_attr_name.attr_name or dataset_attr_name.
If using Statements of Equality, the left hand side is the attribute path, while the right-hand side is what the attribute path should be set to. The right-hand side should use numbered captured groups (e.g. $1) to reference elements matched, but may also include literal strings. Syntax: dataset_link_attr_name.attr_name=LITERAL, dataset_attribute_name=$1, or example_with_two_capture_groups=$2:$1
Advanced Configuration is optional and available for any Implementation Engineers who wish to configure custom attribute paths. The table below explains the elements.Advanced Configuration Field Description Escalation Key Path Specify the location to store the escalation. Link for Responses Specify the link to the Responses dataset where the response action is stored. Event Type Path Specify the location to store the event type. Activity State Path Specify the location to store the activity state.
