Vocera

The Vocera integrated system provides communication integration into IPFusion .

Definitions

Vocera Badge — Physical device carried by a person that interacts with the Vocera system.

Setup

Compatibility

The Vocera integrated system is compatible with software version 5.2.

Prerequisites

Software Minimum Version
IPFusion — Vocera 1.8
.NET Framework 4.7.2

When completing your setup, be sure to have the Vocera documentation available for reference.

Ports

These ports must be open in your network firewall for the integration to work.

Purpose Default Value Configurable
Vocera Server Connection 5005 No
Dataserver 9610 Yes
Debug Tools 9611 No

Communication Configuration

Communication Settings

IPFusion connects to Vocera by logging in as a user through the Vocera Message Interface.

Important: It is strongly recommended that a separate user is created in the Vocera configuration for IPFusion.

In the integrated system configuration panel, you will find the Communication Settings. The below information is required.

Server Address The Address of the Vocera server.

The Vocera integrated system supports a failover architecture for connecting to the Vocera servers. Any number of Vocera servers can be entered into the Communication Settings and are ordered by Priority. When initializing the connection, Runtime will always attempt to connect to the highest Priority server first, and move down the list. When re-establishing a connection, Runtime will always attempt to reconnect to the previous server first before moving down the list.

Note: Red X indicates an invalid or out of range value given for field.

Data Servers

The data servers is a machine where the integrated server drivers are run. These drivers facilitate the communication between Runtime and Vocera.

Table 1. Data Servers
Server Address The network IP address or DNS host name of the Data Server.
Port The port number for the server connection.
Client ID The user ID of the user for IPFusion to use in the Vocera configuration. The client ID must be unique for each dataserver.
Priority This determines which server Runtime will try to connect to first. Connection attempts are made starting with the smallest value. If the connection attempt fails and has reached its number of Connection retries before failover, it will move to the second smallest priority value and so on until a connection is made.
Reconnect to primary server when available Check this option to have Runtime try to reconnect to the primary dataserver in the event it fails over to one of the other dataservers. This assists in preventing different Workstations from connecting to different dataservers. The maximum number of supported dataservers when using this option is two.
Warning: This will cause slight service interruptions when reconnecting to the primary dataserver.
Primary server retry interval (s) If the option to Reconnect to primary server when available is checked, this is how frequently (in seconds) Runtime will check the availability of the primary server. If it is available, Runtime will reconnect.
Table 2. Advanced Settings
Connection retries before failover In the event of a loss of communication, Runtime attempts to reconnect to the integrated system's server before failing over to another server.
Connection retry delay The time period set (in milliseconds) before Runtime tries to reconnect to the server.
Heartbeat interval The time in seconds of the signal for when an integrated system will communicate its status to Runtime.

Assets

System Asset

This asset represents the connection state of the Vocera system.

View all properties

Supported States

Normal The asset is online and in its default state.
Masked The asset has been masked over its true state.
Fault An issue has been detected in a connected asset.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

Workflow Integration

System Commands

System commands are commands executed through Workflows at the system level. For more information about Workflows, see the Workflows section.

Send Message Command

The Send Message command is used to send a message to a Vocera user or user group.

Table 3. Parameters
Send To The user IDs of the users or name of the groups to send the message to.
Note: A list of IDs must be surrounded by quotations, e.g. "User1,Group2,Group3".
Text The message body.
Ringtone The Ringtone to annunciate on the user badge.
Priority The priority of the message. This can be set to:
  • 0 — Normal
  • 1 — High
  • 2 — Urgent
Callback Number The Number where any responses will be sent to. This is optional.
Responses The additional Responses to include with the message options. This is optional.
Note: The list of responses must be surrounded by quotations, e.g. "Response1,Response2,Response3".
WAV Files key The custom audio file used for the alert tone of the message. This is optional.
Source A Source parameter or ID to attach to the message. This value is not sent to Vocera and is optional.
Call Type A Type of Call to associate with the message. This value is not sent to Vocera and is optional.

System Events

System events are events used to trigger Workflow actions at the system level. For more information about Workflows, see the Workflows section.

User Response

A User has Responded to a message via one of the provided Responses.

Call Type The Call Type attached to the trigger message in the Send Message command.
Callback Number The Callback Number of the trigger message.
Sent To The user ID or user group name the trigger message was sent to.
Priority The Priority of the trigger message. This can be:
  • 0 — Normal
  • 1 — High
  • 2 — Urgent
Responder Login ID The user ID of the user who responded to the message.
Response The Response that the user has selected.
Responses Provided The Responses of the trigger message.
Source Parameter The Source attached to the trigger message in the Send Message command.
Text The body of the trigger message.
WAV Files The WAV Files key of the trigger message.

Failed Message Delivery

This trigger fires when a message fails to be sent to a user. This can occur in the below scenarios:
  • User not available
    • User not logged in
    • User not online
    • User in DND (Do Not Disturb)
  • Invalid LoginID sent
  • No users available in group
Call Type The Call Type attached to the trigger message in the Send Message command.
Callback Number The Callback Number of the trigger message.
Priority The Priority of the trigger message. This can be:
  • 0 — Normal
  • 1 — High
  • 2 — Urgent
Reason The reason why the message failed to send to the user.
Responses Provided The Responses of the trigger message.
Sent To The user ID or user group name the trigger message was sent to.
Source Parameter The Source attached to the trigger message in the Send Message command.
Text The body of the trigger message.
WAV Files The WAV Files key of the trigger message.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.