Integrating Incoming WCTP with Vocera Platform |
Because an MCR message may contain multiple responses, the Vocera Incoming WCTP 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 adapter configurations and message types, so each message type should be configured with a regex to match the correct Accept response, and a separate regex to match the correct Decline response. The message type that the message was matched to is configured with the Starting Dataset.
RESPONSE_OPTIONS Dataset Attributes
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. This is a optional separate "display value" to be shown to the user when choosing the response. |
Attribute | response_index | N/A | True | N/A | N/A | String | Attribute that stores the index of the response in the list of responses. This is the numerical order in which the responses were received, or some order determined by the adapter. |
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. |
First create a many-to-many link between either the Alerts dataset or other Starting Dataset, and the ResponseOptions dataset. Then configure the Vocera Incoming WCTP Adapter, specifying this link when providing the Link for Responses field in the Message Type settings. Finally, create many-to-one links between the Starting Dataset and the ResponseOptions dataset so that the specific response can be accessed in a rule.
Create the link attribute on the starting dataset that is specified in the rule on the dataset. Create the response_options attribute to link to the ResponseOptions dataset from the Alerts dataset in this example.
Name | Reverse Name | Linked Dataset | Type | Key | Reverse Key | index |
---|---|---|---|---|---|---|
response_options | alerts | ResponseOptions | many-to-many | false | false | false |
Use the link attribute created to connect with the ResponseOptions dataset in the Vocera Incoming WCTP Adapter configuration. Provide the new link attribute in the Link for Responses field in the Message Type settings.
Create many-to-one links between the StartingDataset dataset and the ResponseOptions when matching message types. These links provide the specific response to be accessed in a rule to send to the user or to send back to the originating system.
Name | Reverse Name | Linked Dataset | Type | Key | Reverse Key | Index |
---|---|---|---|---|---|---|
accept_response | accepted_alert | ResponseOptions | many-to-one | false | false | false |
decline_response | declined_alert | ResponseOptions | many-to-one | false | false | false |
Use the link attributes in the Response Type Matching settings in the Vocera Incoming WCTP Adapter configuration.
These links can then be supplied in a rule to send a message to a user or to send back to the originating system. Configure the Response List field in the Rule Settings on a dataset rule that uses the Vocera adapter in the example below.