Configuring a Vocera VMP Adapter

These settings enable direct communication between the Vocera VMP 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. 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.
  3. Complete the configuration fields as described in the table.

    This section explains the settings that enable direct communication between the adapter and the Vocera Platform. Complete the fields described below to configure an adapter with the appropriate information to perform as required.

    Select an empty field and begin typing, or select an existing value and type over it. To keep existing values, do not edit that field.

    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.

  4. Complete the Connection Settings configuration fields as described in the table.

    The connection settings provide Vocera Platform with the explicit information required to communicate with the VMP server.

    Connection Settings Description
    Service URL

    Enter the URL used to contact the remote VMP service. This field is required.

    The Service URL must identify a unique adapter instance.

    Username

    Enter the username of the account used to make requests to the remote VMP service. This field is required.

    Password

    Enter the password of the account used to make calls to the remote VMP service. This field is required.

    Update Period

    Enter the minimum time in hours between automatic updates to synchronize users with the VMP system. Valid range is 1 to 168 hours (one week).

    An Update Users option is provided to manually sychronize users, as well.

    Client ID Enter the client ID used to make requestst to the remote VMP system.
  5. Complete the Callback Settings configuration fields as described in the table.

    The callback settings provide Vocera Platform with the explicit information required to communicate with the Voice Server (VS) for callback data.

    Callback Settings Description
    Callback Protocol Scheme

    Select the protocol scheme (http, or https) that the remote VMP service will use when calling back to the Vocera VMP Adapter. This field is required.

    The options are http, and https.

    Callback Hostname

    Enter the hostname that the remote VMP service will use when calling back to the adapter.

    If none is specified, the configured FQDN of the appliance will be used.

    Callback Port Enter the port that the remote VMP service should use when calling back to the adapter. This value must be between 1 and 65535.

    If none is specified, the adapter will use the default port for the selected protocol scheme (80 or 443).

  6. Select one of the available options to exit the adapter configuration page. See Saving an Adapter for details.