Understanding the XMPP Rules

XMPP rules are configured to send conversation, message, and presence information to the Vocera XMPP Adapter when this information is created by an external resource.

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

The Vocera XMPP Adapter rules can be configured to interact with non-XMPP devices by using virtual sessions to allow them to participate in a conversation.

The XMPP rule configuration options are handled in eight different Rule Action types, each type with its own rule settings. For each of the eight Rule Action types below, a figure displays the Adapter Settings fields and a table provides the details for configuring each field.

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

Expire Conversation

Select Expire Conversation in the Rule Action dropdown menu.

Setting Description
Conversation The Jabber ID of the conversation to expire. May contain an attribute expression in the form of #{...}. This is a required field.

Leave Conversation

Select Leave Conversation in the Rule Action dropdown menu.

Setting Description
Recipients A list of Jabber IDs or logins of the resources who will receive the message. For sending a new message to an existing conference room, use the Jabber ID of the room. It may contain attribute expressions in the form of #{...}. This is a required field.
Conversation The Jabber ID of the conversation. May contain an attribute expression in the form of #{...}. This is a required field.

Send Alert

Select Send Alert in the Rule Action dropdown menu.

Settings Description
Recipients A list of Jabber IDs or logins of the resources who will receive the message. For sending a new message to an existing conference room, use the Jabber ID of the room. If left blank for a Send Alert rule a conference room will be created but no resources will receive a message without an additional Send Invitation rule. It may contain attribute expressions in the form of #{...}. This is a required field.
Re-Alert If checked and a recipient has already received an alert for the same triggering event, the recipient will be notified again based on the priority, audible, and vibration settings in this rule. If not checked and a recipient has already received an alert for the same triggering event, a recipient will not receive a new notification.
Subject The topic of the conversation room. May contain attribute expression in the form #{...}. Use keywords in this Subject field, as the device display is limited to between 12 and 20 characters. Although this field accepts any entries, the display is truncated depending on the size and number of characters. For example, large size characters such as 'w' take up more space in the Subject display than small size characters such as 'i'. This is a required field.
Alarm Time Use a patient monitor event time in standard solution alarm time; #{alarm_time} or #{alarm_time.as_iso}. An accurate alarm time is critical for aligning the alert with other data, such as waveforms. This field should be left empty if the alert is not for a patient monitor alarm, or if an accurate alarm time is not available.
Message The message to be shown to recipients. This could be a summary of the information in the workflow page. May contain attribute expressions in the form of #{...}. This is a required field.
Short Message The short message to be played or displayed on a badge. This is an optional text field.
Patient MRN The MRN of the patient associated with the alert. May contain attribute expressions in the form of #{...}.
Event Response Team The Jabber IDs of the other resources who are involved in the patient care. May contain attribute expressions in the form of #{...}.
Time-to-Live The time, in minutes, after which the message is no longer applicable. May be an attribute expression in the form of #{...}, but it must evaluate to an integer. This is a required field.
Accept A list of attribute expression and the values to which to update those attributes when the user clicks on "Accept'. Must be in the form of "expression=value", one per line. Expressions are expressed without #{...}. Values may contain other attribute expressions in the form of #{...}.
Accept Badge Phrases A list of phrases sent to a badge when the user clicks on "Accept'. Must be one per line. A total of 5 combined accept and decline phrases can be used.
Accept and Call A list of attribute expressions and the values to which to update those attributes when the user clicks on "Accept and Call'. Must be in the form "expression=value", one per line. Expressions are expressed without #{...}. Values may contain other attribute expressions in the form of #{...}.
Callback Number Phone number of the device that will be dialed when the user clicks on 'Accept and Call'.
Decline A list of attribute expressions and the values to which to update those attributes when the user clicks on 'Decline'. Must be in the form "expression=value', one per line. Expressions are expressed without #{...}. Values may contain other attribute expressions in the form of #{...}.
Decline Badge Phrases A list of phrases sent to a badge when the user clicks on 'Decline'. Must be one per line. A total of 5 combined accept and decline phrases can be used.
Store Responding User as The attribute expression describing which dataset to save the responding user name.
Additional Content Any additional content to be displayed to the user associated with this alert. May contain attributes in the form of #{...}.
Priority Level The priority of the message.
Badge Alert Sound The file name of the alert sound to play on a badge.
Vibrate Enabled Flag to determine if the device should vibrate when a message is sent to the device. Vibrate is not supported on all devices.
Audible Alert Flag to determine if the device should play an audio alert when a message is sent to the device. Audible alerts ALWAYS play even if the device is not idle.
Alert Sound The file name of the alert sound to play. This field is only an option if Audible Alert is selected.
Always Play If checked, the alert sound is played on the device even if the user is marked as Unavailable. This field is only an option if Audible Alert is selected.

Send Alert Custom Parameters

Custom parameters can be used with the XMPP Send Alert Rule. For a full explanation of Custom Parameters, please see the Vocera XMPP Adapter configuration page.

Settings Descriptions
Parameter The name of the custom parameter to be added to the alert. Custom parameters allow XMPP alerts to be extended with app specific settings. For example, integration with AirStrip ONE requires the parameters airstripone.bed and airstripone.unit. The value of the custom parameter must be added to the alert if the Parameter is entered. Custom Parameters are optional, but if a Value is entered, the Parameter is a required field.
Value The value to be added to the alert. Custom parameters allow XMPP alerts to be extended with app specific settings. For example, integration with AirStrip ONE requires values of Bed and Unit, (bed1 and ICU for example). The parameter of the customer parameter must be added to the alert if the Value is entered. Custom Parameters are optional, but if a Parameter is entered, the Value is a required field.

Send Mass Alert

Select Send Mass Alert in the Rule Action dropdown menu.

Settings Description
Recipients A list of Jabber IDs or logins of the resources who will receive the message. For sending a new message to an existing conference room, use the Jabber ID of the room. It may contain attribute expressions in the form of #{...}. This is a required field..
Subject The topic of the conversation room for the mass alert (e.g. Tornado Warning). May contain attribute expression in the form #{...}. This is a required field.
Message The message to be shown to recipients (e.g., Tornado Warning details: counties affected, duration, etc.). May contain attribute expressions in the form of #{...}. This is a required field.
Short Message The short message to be shown or played on a badge.
Time-to-live The time in minutes after which the message is no longer applicable. Values must be between 1 and 64800 inclusive (45 days). This is a required field.
Additional Content Any additional content to be displayed to the user associated with this alert.
Priority Level The priority of the message.
Badge Alert Sound The file name of the alert sound to play on a badge.
Vibrate Enabled Flag to determine if the device should vibrate when a message is sent to the device.
Audible Alert Flag to determine if the device should play an audible alert when a message is sent to the device.
Alert Sound

The file name of the alert sound to play. This field is only an option if Audible Alert is selected.

Always Play Flag to determine if the device should always play an audible alert when a message is sent to the device, even if the user is in dnd/unavailable mode. This field is only an option if Audible Alert is selected.

Send Mass Alert Custom Parameters

Custom parameters can be used with the XMPP Send Mass Alert Rule. For a full explanation of Custom Parameters, please see the Vocera XMPP Adapter configuration page.

Settings Descriptions
Parameter The name of the custom parameter to be added to the alert. Custom parameters allow XMPP alerts to be extended with app specific settings. For example, integration with AirStrip ONE requires the parameters airstripone.bed and airstripone.unit. The value of the custom parameter must be added to the alert if the Parameter is entered. Custom Parameters are optional, but if a Value is entered, the Parameter is a required field.
Value The value to be added to the alert. Custom parameters allow XMPP alerts to be extended with app specific settings. For example, integration with AirStrip ONE requires values of Bed and Unit, (bed1 and ICU for example). The parameter of the customer parameter must be added to the alert if the Value is entered. Custom Parameters are optional, but if a Parameter is entered, the Value is a required field.

Send Invitation

Select Send Invitation in the Rule Action dropdown menu.

Settings Descriptions
Recipients A list of Jabber IDs or logins of the resources who will receive the message. For sending a new message to an existing conference room, use the Jabber ID of the room. It may contain attribute expressions in the form of #{...}. This is a required field.
Re-Alert If checked and a recipient has already received an alert for the same triggering event, the recipient will be notified again based on the priority, audible, and vibration settings in this rule. If not checked and a recipient has already received an alert for the same triggering event, a recipient will not receive a new notification.
Conversation The Jabber ID of the conversation. May contain an attribute expression in the form of #{...}. This is a required field.
Reason The reason for the conversation room invitation. May contain an attribute expression the form of #{...}.

Send New/Accept Decline System Message

Select Send New Accept/Decline System Message in the Rule Action dropdown menu.

Settings Descriptions
Recipients A list of Jabber IDs or logins of the resources who will receive the message. For sending a new message to an existing conference room, use the Jabber ID of the room. It may contain attribute expressions in the form of #{...}. This is a required field.
From The single Jabber ID of the resource who sent the message. Ignored if marked as a system message. May contain attribute expressions in the form of #{...}. This is a required field.
Accept Message If checked, the message is accepted; if not, the message is declined.

Send New Message

Select Send New Message in the Rule Action dropdown menu.

Settings Descriptions
Recipients A list of Jabber IDs or logins of the resources who will receive the message. For sending a new message to an existing conference room, use the Jabber ID of the room. It may contain attribute expressions in the form of #{...}. This is a required field.
From The single Jabber ID of the resource who sent the message. Ignored if marked as a system message. May contain attribute expressions in the form of #{...}. This is a required field
Message The message to be shown to the recipients. This could be a summary of the information in the workflow page. May contain attribute expressions in the form of #{...}. This is a required field.
Short Message The short message to be played or displayed on a badge.

Send New System Message

Select Send New System Message in the Rule Action dropdown menu.

Settings Descriptions
Recipients A list of Jabber IDs or logins of the resources who will receive the message. For sending a new message to an existing conference room, use the Jabber ID of the room. It may contain attribute expressions in the form of #{...}. This is a required field.
Message The message to be shown to the recipients. This could be a summary of the information in the workflow page. May contain attribute expressions in the form of #{...}. This is a required field.
Short Message The short message to be played or displayed on a badge.

Start Conversation

Select Start Conversation in the Rule Action dropdown menu.

Settings Descriptions
Recipients A list of Jabber IDs or logins of the resources who will receive the message. For sending a new message to an existing conference room, use the Jabber ID of the room. If left blank for a Send Alert rule a conference room will be created but no resources will receive a message without an additional Send Invitation rule. It may contain attribute expressions in the form of #{...}. This is a required field.
Subject The topic of the conversation room. May contain attribute expression in the form #{...}. Use keywords in this Subject field, as the device display is limited to between 12 and 20 characters. Although this field accepts any entries, the display is truncated depending on the size and number of characters. For example, large size characters such as 'w' take up more space in the Subject display than small size characters such as 'i'. This is a required field.

Update Presence

Select Update Presence in the Rule Action dropdown menu.

Settings Descriptions
Recipients A list of Jabber IDs or logins of the resources who will receive the message. For sending a new message to an existing conference room, use the Jabber ID of the room. It may contain attribute expressions in the form of #{...}. This is a required field.
Presence Type The Presence Type to be set. The options are Available, Unavailable, or Offline. This is a required field.