Configuring a Vocera ResponderSync Subscriber Adapter

Description of the settings that enable direct communication between the Vocera ResponderSync Subscriber 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.
  1. Access the Vocera Platform Web Console and navigate to the adapters.
  2. Select New Adapter in the Action menu, or select an adapter you wish to configure and then select Edit, to display the configuration fields. The configuration fields are the same for new and existing adapters.
  3. 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.
  4. Complete the configuration fields as described in the table.
    Configuration Field Description
    Component Name Click the Component Name field to display a list of the systems and devices that the Vocera Platform currently supports. Select the name of the adapter to create.
    Reference Name

    Enter a short descriptive name in the Reference Name field to uniquely identify an adapter instance.

    It may demonstrate the adapter function or other information; for example, Production adapter may differentiate a live adapter from a development or "sandbox" adapter.

    Enabled Select the Enabled checkbox to allow the Vocera Platform to use the new adapter. The Vocera Platform ignores the adapter if this option is disabled.
    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.

  5. Complete the ResponderSync Adapter Settings configuration fields as described in the table.

    One installation may have several instances of the Vocera ResponderSync Subscriber Adapter, but each instance must have a unique URL, as described here.

    ResponderSync Adapter Settings Description
    Staff Assignment Service URL Enter the URL of the staff assignment service to communicate with this adapter. Multiple Vocera ResponderSync Subscriber Adapter may be used in one installation, however, each adapter instance must have a unique URL.
    Assigned Facility

    Select the name of the facility to be associated with the teams of the Rauland-Borg staff assignment service. This name must match the name of the facility configured in the service. Used when the facility is not present in a message.

    Assigned Site Enter the site associated with the staff assignment service.
    Request Pending Assignments

    Check this box to indicate that the adapter should request future assignments from the ResponderSync assignment system.

    The following restrictions apply to the Request Pending Assignments checkbox:

    • Anticipates that the facility is using Assignment Manager to manage the assignments.
    • Does not support "Staff on break" event processing.
    • Some assignment systems (such as Rauland Responder) do not support this pending assignments functionality.
    Assignment Adapter Identifier

    Enter the adapter identifier to use in assignments created by this adapter; uses the adapter's ID number by default. If the Assignment Manager is used by the facility, the Assignment Adapter Identifier can be used to specify this adapter's identifiers.

    Once assignments have been created, changing the value in the Assignment Adapter Identifier field will require updating the existing assignments' adapter identifier.

    User Identification

    Select the method from the dropdown list to specify how key values for Users, Groups, Locations, and Assignments are created and used by the adapter.

    Available options are as follows:

    • Unique by Facility: Uses the legacy method, which uses the facility name in the key; this is not recommended for new instances.
    • Unique by Adapter: Uses the adapter ID as part of the key to make them truly unique; this the preferred method.
    • Staff ID is Login: Uses the adapter ID as part of the key to make them unique, except the staff ID is assumed to be the user's login.
    Link Assignments to Roles

    Check this box to link incoming assignments to a functional role based on the assigned user's role in the source system, in this case ResponderSync.

    Managed Line Regex

    Enter a regular expression to match the lines that should be managed by this adapter when assigning users to lines. If an expression is not entered in this field, only numeric lines will be managed.

    Use this field when the Rauland-Borg Staff Assignment Service is not sending line numbers in the device number field; for example, when the Rauland service is sending user names as device numbers.

    See Understading Regular Expressions for an overview explanation and examples of Regex code and mappings

    Managed Device Vendors

    Enter the list of device vendor types to be managed by ResponderSync when assigning users to lines.

    If another adaptor is managing user-to-device assignment, do not list its vendor type in this field. For example, when "Associate Users" is set in the device workflow to enable CUCM to manage user-to-device mappings for Cisco devices, do not list CUCM in the Managed Device Vendors field.

    See the following Managed Device Vendors table.

    This Managed Device Vendors table describes the conditions under which ResponderSync should manage device mapping.

    Adapter Vendor Managed by ResponderSync?
    Ascom Ascom Yes, unless user-to-device mapping is permanently made through the device workflow
    CUCM Cisco Yes, unless Cisco Extension Mobility is used, or user-to-device mapping is permanently made through the device workflow
    SpectraLink XML SpectraLinkXML Yes, unless SpectraLink User Profiles are used, or user-to-device mapping is permanently made through the device workflow
    Vocera Vocera Yes, unless user-to-device mapping is permanently made through the device workflow
    Outgoing WCTP WCTP No. Outgoing WCTP always manages the device mapping
    XMPP XMPP No. XMPP always manages the device mapping
  6. Complete the Subscriber Settings configuration fields as described in the table.

    This adapter configuration supports other systems which use the same SOAP API, including systems which provide future assignments in conjunction with the Assignment Manager. Complete the information needed in this section to communicate with the subscribing system.

    Subscriber Settings Description
    Subscriber Source Name

    Enter a source name to identify the subscriber in the staff assignment service. In this example, the Subscriber Source Name is Subscriber-252. When multiple Vocera Platform servers are connected to a ResponderSync URL, each appliance needs a subscriber source name to allow each appliance to receive updates. Otherwise, the last subscribed service will receive all the updates.

    Protocol Scheme

    Select the protocol scheme to use when constructing the subscriber URL from the dropdown list. Select either http or https.

    Hostname

    Enter the hostname or IP address that the Clinical Staff Assignment service should use when invoking publisher operations. If this field is empty, the FQDN of the appliance is used by default.

    Port

    Enter the port to use when constructing the subscriber URL. This is the port that the ResponderSync service should use when invoking publisher operations. The value must be a number between 1 and 65535. When this field is empty, the port value defaults to 80.

    Protocol Version

    Enter the protocol version used in communication with the remote Responder service. When this field is empty, the port value defaults to 1.20.

  7. Complete the Location Type configuration fields as described in the table.
    Location Type Settings Description
    Reference Name Specify a name or label for this collection of settings.
    Active Select this checkbox to make Location Types active.
    Facility Regex Specify a Regex to capture values for the facility from the data received.
    Facility Mapping Specify the value that the Facility mapping will be set to. The expression can use numbered capture groups (e.g. $1) to reference elements matched, but may also include literal strings.
    Unit Regex Specify a Regex to capture values for the Unit from the data received.
    Unit Mapping Specify the value that the Unit mapping will be set to. The expression can use numbered capture groups (e.g. $1) to reference elements matched, but may also include literal strings.
    Room Regex Specify a Regex to capture values for the Room from the data received.
    Room Mapping Specify the value that the Room mapping will be set to. The expression can use numbered capture groups (e.g. $1) to reference elements matched, but may also include literal strings.
    Bed Regex Specify a Regex to capture values for the Bed from the data received.
    Bed Mapping Specify the value that the Bed mapping will be set to. The expression can use numbered capture groups (e.g. $1) to reference elements matched, but may also include literal strings.
  8. Select one of the available options to exit the adapter configuration page. See Saving an Adapter for details.