Configuring a Vocera AMiON Adapter

These settings enable direct communication between the Vocera AMiON 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.

  5. Complete the Main Settings configuration fields as described in the table.
    The configuration fields are the same for new and existing adapters.
    Main Settings Description
    AMiON URL Enter the URL used to contact the AMiON service. This should be the root URL to access the AMiON reports. This field is required.
    Note: Use the default AMiON URL provided in the configuration, unless otherwise specified.
    Login Enter the login for the account used to make requests to the remote AMiON server and return all schedules. This field is required. The AMiON system uses multiple schedules with both administrative and user (non-administrative) access accounts. Enter the site-wide non-administrative password in this field.
    Poll Interval Enter the value used to determine how frequently (in minutes) to poll the remote AMiON server for updated information. Must be between 5 and 720 minutes (12 hours). This field is required. The download and reconcilliation process is run when the adapter starts, and at the poll interval specified. Upon a system failover, the poll is delayed by one half the poll interval period.
    Time Zone Select the time zone to use for processing date and time information retrieved from AMiON. This value is also used to determine the actual start of a day. This field is required.
    Report Non-Matching Check this box to indicate whether audit events will be created for messages which do not match a schedule mapping. This box is unchecked by default.
  6. Complete the Staff Name Mappings configuration fields as described in the table.
    Mappings are processed in order to determine how to map an AMiON staff member name to an Vocera Platform user name. Only used if the staff member cannot be mapped by email or by login. At least one Staff Name mapping is required for the adapter to be used.

    Staff Name Mapping Description
    Refererence Name Enter a descriptive name for this staff name mapping, which will be used in logging and auditing.
    Active Check this box to enable the staff name mapping to be used in the facility implementation. If unchecked, the mapping will not be used.
    Name Regex Enter the regular expression to use to identify an AMiON staff member. When a staff member name matches this regular expression, this mapping will be applied. This field is required.
    Name Mapping Enter the mapping that specifies how to break up the staff name field into components and assign them to the User name fields. These attribute paths should be relative to the assignment.
  7. Complete the Schedule Mappings configuration fields as described in the table.
    Mappings are processed in order to determine how to map a particular shift to an Vocera Platform assignment's role and location. At least one schedule mapping is required for the adapter to be used. The Schedule Mapping matches a schedule entry if the Schedule Regex and Shift Regex fields can be applied. When there is a match, the two regex mappings (Schedule Mapping and Shift Mapping) are applied and the data added to the assignment

    Schedule Mappings Description
    Refererence Name Enter a descriptive name for this staff name mapping, which will be used in logging and auditing.
    Active Check this box to enable the schedule mapping to be used in the facility implementation. If unchecked, the mapping will not be used.
    Discard Check this box if matching schedule entries are to be ignored, or treated as if they do not exist. If unchecked, matching schedule entries will be processed as configured.
    Schedule Regex Enter the regular expression to use to identify the AMiON schedule name. This field is required.
    Schedule Mapping Enter the mapping that specifies how to map the Schedule name to attributes for the Vocera Platform assignment and its linked objects. This mapping is intended for use in creating Functional Role and/or Location links. This field is required unless the Discard box is checked.
    Shift Regex Enter the regular expression to use to identify the AMiON shift name. This field is required.
    Shift Mapping Enter the regular expression to use to specify how to map the Shift (Assignment) name to attributes for the Vocera Platform assignment and its linked objects. This mapping is intended for use in creating Functional Role and/or Location links. This field is required unless the Discard box is checked
    Clone Mappings Select Clone to make a duplicate configuration of the selected mapping. The cloned version of the mapping will have a unique reference name and will not be active, by default.
    Add Mappings Select Add to add a mapping to the configuration information
    Remove Mappings Select Remove to remove the mapping from the configuration information
  8. Select one of the available options to exit the adapter configuration page. See Saving an Adapter for details.