Understanding the Vocera Ascom Adapter Rules

Dataset rules can be configured to trigger the Vocera Ascom Adapter to send messages to a wireless handset.

See the Vocera Platform Dataset Guide for information about working with rules. See Configuring a Vocera Ascom Adapter for information about the adapter settings.

A rule can trigger the Vocera Ascom Adapter to send messages to a wireless handset. The rule configuration needed to implement this action defines the parameters used in formulating the message, to whom it should be sent, and what to do with the response.

In the Adapter Settings, configure the Rule Settings fields to manage message delivery.

Setting Description
Recipient The recipient of the Ascom message. The phone number(s) to where the message will be delivered. This value can be hard-coded or can be an attribute expression in the form of #{...}. If hard-coded, the value can be a single phone number, or multiple phone numbers that are comma-separated. An attribute expression is evaluated in relation to the dataset object that caused the rule to be triggered. This is a required field.
Subject The subject of the message to be delivered. This value can be hard-coded or can be an attribute expression in the form of #{...}. An attribute expression is evaluated in relation to the dataset object that caused the rule to be triggered. The length can be 150 characters max. This is a required field.
Message Text The body of the message to be delivered to the Ascom phone. This value can be hard-coded or can be an attribute expression in the form of #{...}. An attribute expression is evaluated in relation to the dataset object that caused the rule to be triggered. The length can be a 500 characters max. This is a required field.
Priority The severity level of the message. Tracked by the device object so that rules can filter out lower severity level messages. Options are "High", "Normal", and "Low".
Beep The number of beeps the device will sound. Options are "Silent", "1 beep", "2 beeps", "3 beeps", "4 beeps", "5 beeps", "10 beeps" and "Siren". This is a required field.
Callback Number The phone number to call back. This value can be hard-coded or can be an attribute expression in the form of #{...}. An attribute expression is evaluated in relation to the dataset object that caused the rule to be triggered. Normally, the phone number belongs to the object that triggered the rule.
Call Key Label The label for the soft key to be associated with the callback function. The label should not be longer than 6 characters. The default value is 'Call'. This is a required field if either the Callback Number or Call Key Value are provided.
Call Key Value The value to respond with when the call key has been selected. The default value is 'accepted-called'. This is a required field if either the Callback Number or Call Key Label are provided.
Accept Key Label The label for the soft key to be associated with the accept function. The label should not be longer than 6 characters. The default value is 'Accept'. This is a required field if the Accept Key Value is provided.
Accept Key Value The value to respond with when the accept key has been selected. The default value is 'accepted'. This is a required field if the Accept Key Label is provided.
Decline Key Label The label for the soft key to be associated with the decline function. The label should not be longer than 6 characters. The default value is 'Decline'. This is a required field if the Decline Key Value is provided.
Decline Key Value The value to respond with when the decline key has been selected. The default value is 'declined'. This is a required field if the Decline Key Label is provided.
Line Attribute Path The path to the attribute where the responding devices' directory number will be stored. This field is required if any Key Value is provided.
User Attribute Path The path to the attribute where the user associated with the responding device will be stored. This field is required if any Key Value is provided.
Value Attribute Path The path to the attribute where the response will be stored. This field is required if any Key Value is provided.