Configuring a Vocera Clinical API Adapter

These settings enable direct communication between the Vocera Clinical API 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.
  5. Complete the Datasets Settings configuration fields as described in the table.
    Datasets Configuration Field Description
    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.

  6. Complete the Main Settings configuration fields as described in the table.
    General Settings Configuration Field Description
    Publish Care Assignments Check this box if the facility wants to publish care assignments. This box is selected by default.
    Publish Future Care Assignments Check this box if the faciity wants to publish future care assignments.
    Facilities Specifies zero or more facility names whose inventory, care assignments, and device assignments will be published. If no facility name is mentioned then it will consider all facilities for publishing.
    Units Specifies zero or more unit names whose inventory and care assignments will be published. If no unit name is mentioned care assignments will be published for all units.
    Roles Specifies zero or more role names whose inventory and care assignments will be published. If no role name is mentioned care assignments will be published for all roles.
    Publish Device Assignments Specifies whether device assignments should be published. By default this is selected.
    Phone Type Vendor(s) Specifies zero or more device vendor names for which phone type devices are to be published. If no device vendor names are mentioned here then none of the phone type devices will be published.
    Locator Badge Type Vendor(s) Specifies zero or more device vendor names for which locator badge type devices are to be published. If nothing is mentioned here then none of the locator badge type devices will be published.
    Employee ID Path Specifies an attribute path relative to the Users dataset that will be published as the employee ID.
    Message Timeout Specifies message timeout in minutes. Cancels the subscription if the adapter has not received or successfully sent an event for this period.
  7. Complete the Security Token Settings configuration fields as described in the table.
    Security Token Settings Description
    Issuer Specifies a string that identifies the adapter when receiving a request to and from the Clinical API subscriber. This is required.
    Audience Specifies a string that identifies the client when a receiving a request to and from the Clinical API subscriber.
    Key Specifies the secret used to encode a security JWT that authenticates requests to and from Clinical API subscriber.
    Timeout Specifies the length of time the security JWT is valid in seconds (1-3600).
  8. Sidebar Information
    Field Description
    Subscriber URL Shows the current active subscription URL. This will also indicate if no active subscription exists at the moment.
    Refresh Select the Refresh button to subscribe to the URL. Additionally, select this button if there is a new subscription.
    Cancel Subscription Select the Cancel Subscription button to close the existing subscription.
  9. Select one of the available options to exit the adapter configuration page. See Saving an Adapter for details.