Configuring a Vocera Shift Admin Adapter

These settings enable direct communication between the Vocera Shift Admin Adapter and the Vocera Platform.

1. Access the Vocera Platform Web Console and navigate to the adapters.
   See Navigating the Vocera Platform Adapters for instructions.
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
   Server Address	Enter the root URL to the ShiftAdmin API.
   Server Username	Enter the username that will access the ShiftAdmin API.
   Server Password	Enter the password that will access the ShiftAdmin API
   Schedule Polling Interval	Enter a value between 5-720. This is how often, in minutes, to request schedule shifts.
   Report Non-Matching	Check this box if the Facility would like an audit generated for received messages that do not have a schedule mapping.

6. 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
   Reference 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 Shift Admin 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.
   Role Regex	Specify a Regex that will match a Role Name to a Role in order to capture values.
   Role Mapping	Enter the mapping that specifies how to map the Role 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

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