Configuring a Vocera Assignment Manager Adapter

These settings enable direct communication between the Vocera Assignment Manager 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 check box 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 Main Settings, Assignments To Activate, and Assignments To Expire sections using the information in the table below.
  6. Complete the configuration fields as described in the table.
    Configuration Field Description
    Managed Assignment Interfaces The Managed Assignment Interfaces field is located in the Main Settings section.

    Enter the adapter identifier (the assignment's interface_id value) used by the interface creating the assignments to be managed by the Vocera Assignment Manager Adapter. Each adapter identifier is generally associated with a single assignment source system. If this field is empty, all assignments will be managed by this Vocera Assignment Manager Adapter.

    Active Condition The Active Condition field is located in the Assignments to Activate section.

    Select a condition configured on the Assignments dataset which represents assignments that should be moved to the "active" state.

    Select Add to configure additional conditions for starting assignments.

    Select a condition for which all matching assignments will be marked as started. This field is required if a condition is added; otherwise, select Remove.

    Select Remove if you wish to delete the condition from this adapter's configuration.

    Deleted or Expired Condition The Deleted or Expired Condition field is located in the Assignments to Expire section.

    Select a condition configured on the Assignments dataset which represents assignments that should be moved to the "deleted" or "expired" states.

    Select Add to configure additional conditions for expiring or deleting assignments.

    Select a condition for which all matching assignments will be marked as ended. Future assignments will be marked "deleted", while active assignments will be marked "expired". This field is required if a condition is added; otherwise, select Remove.

    Select Remove if you wish to delete the condition from this adapter's configuration.

  7. Complete the Manage Patient Assignment section.
  8. Complete the configuration fields as described in the table.
    Configuration Field Description
    Map Staff Assignments to Patient Assignments Select this check box if patients assignments should be created and linked for staff assignments with a patient.
    Facilities Enter the facility name(s) whose assignments will create and link patient assignments. If this is blank, and the Map Staff Assignments to Patient Assignments box is checked, all assignments will create and link patient assignments.
    Units Enter the unit names whose assignments will create and link patient assignments. If this is blank, and the Map Staff Assignments to Patient Assignments box is checked, all assignments will create and link patient assignments.
    Roles Enter the role names whose assignments will create and link patient assignments. If this is blank, and the Map Staff Assignments to Patient Assignments box is checked, all assignments will create and link patient assignments.
    Map Patient Assignments to Staff Assignments Select this check box if staff assignments should be created and linked for patient assignments with staff.
    Facilities Enter the facility name(s) whose staff assignments will be created for patient assignments. If this is blank, and the Map Patient Assignments to Staff Assignments box is checked, a staff assignment will be created for all patient assignments.
    Units Enter the unit name(s) whose staff assignments will be created for patient assignments. If this is blank, and the Map Patient Assignments to Staff Assignments box is checked, a staff assignment will be created for all patient assignments.
    Roles Enter the roles name(s) whose staff assignments will be created for patient assignments. If this is blank, and the Map Patient Assignments to Staff Assignments box is checked, a staff assignment will be created for all patent assignments.
  9. Select one of the available options to exit the adapter configuration page. See Saving an Adapter for details.