Understanding a Vocera Incoming VMI Adapter Configuration |
The Vocera Platform version and datasets required for a Vocera Incoming VMI Adapter are described here.
An adapter defines a default Dataset structure in order to function. Attributes are organized by Datasets and store the information required by the adapter. Adapters use this data during the process of receiving and sending messages.
Not all adapters require Datasets to function. When an adapter does require Datasets, the system will determine if they already exist. If they do not exist, the system will create the needed Datasets.
When creating or editing an adapter, use the following information to select the appropriate datasets in the Required Datasets section.
ACCESS_POINTS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | mac_address | N/A | True | N/A | N/A | String | Attribute that stores the MAC address of the access point. |
Link | access_point_location | access_points | False | False | N/A | Many-to-one | The ACCESS_POINTS Dataset is linked to the ACCESS_POINT_LOCATIONS Dataset, and the link order is n:1 (many access_points associated to one access_point_location) |
ACCESS_POINT_LOCATIONS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | name | N/A | True | N/A | N/A | String | Attribute that stores the name of the access point location. |
Link | facility | access_point_locations | True | False | N/A | Many-to-one | The ACCESS_POINT_LOCATIONS Dataset is linked to the FACILITIES Dataset, and the link order is n:1 (many access_point_locations associated to one facility) |
Link | access_points | access_point_location | False | False | N/A | One-to-many | The ACCESS_POINT_LOCATIONS Dataset is linked to the ACCESS_POINTS Dataset, and the link order is 1:n (one access_point_location associated to many access_points) |
ALERT_META_DATA Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | message_key | N/A | True | N/A | N/A | String | Attribute that stores the locally unique message key for the message. |
Attribute | interface | N/A | False | N/A | False | String | Attribute that stores the reference name of the processing interface. |
Attribute | message_identifier | N/A | False | N/A | False | String | Attribute that stores the external identifier for the message. |
Attribute | sender_id | N/A | False | N/A | False | String | Attribute that stores the external identifier for the client. |
DEVICES Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | name | N/A | True | N/A | N/A | String | Attribute that stores the name that identifies the device, often based upon the MAC address of the device. |
Attribute | status | N/A | False | N/A | True | String | Attribute that stores the current registration status of the device. Possible values are Registered, Disconnected, Virtual, or Unregistered. |
Attribute | vendor | N/A | False | N/A | True | String | Attribute that stores the vendor of the device. For example, Cisco or XMPP. |
Attribute | access_point_mac_address | N/A | False | N/A | False | String | Attribute that stores the mac address of the access point that the device is currently connected to. |
Link | usr | devices | False | False | N/A | Many-to-one | The DEVICES Dataset is linked to the USERS Dataset, and the link order is n:1 (many devices associated to one user) |
FACILITIES Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | name | N/A | True | N/A | N/A | String | Attribute that stores the unique name for the facility. |
Link | access_point_locations | facility | False | True | N/A | One-to-many | The FACILITIES Dataset is linked to the ACCESS_POINT_LOCATIONS Dataset, and the link order is 1:n (one facility associated to many access_point_locations) |
Link | groups | facility | False | True | N/A | One-to-many | The FACILITIES Dataset is linked to the GROUPS Dataset, and the link order is 1:n (one facility associated to many groups) |
Link | users | facility | False | False | N/A | One-to-many | The FACILITIES Dataset is linked to the USERS Dataset, and the link order is 1:n (one facility associated to many users) |
GROUPS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | name | N/A | True | N/A | N/A | String | Attribute that stores the name of the group. |
Link | facility | groups | True | False | N/A | Many-to-one | The GROUPS Dataset is linked to the FACILITIES Dataset, and the link order is n:1 (many groups associated to one facility) |
RESPONSE_OPTIONS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | display_value | N/A | True | N/A | N/A | String | Attribute that stores a response value which may be used to display to the recipient. |
Attribute | response_index | N/A | True | N/A | N/A | String | Attribute that stores the index of the response in the list of responses. |
Attribute | response_value | N/A | True | N/A | N/A | String | Attribute that stores the response value to be sent back to the originating system. |
USERS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | login | N/A | True | N/A | N/A | String | Attribute that stores the login name of the user. |
Attribute | presence_show | N/A | False | N/A | False | String | Attribute that stores the current presence show value for the user. |
Link | devices | usr | False | False | N/A | One-to-many | The USERS Dataset is linked to the DEVICES Dataset, and the link order is 1:n (one user associated to many devices) |
Link | facility | users | False | False | N/A | Many-to-one | The USERS Dataset is linked to the FACILITIES Dataset, and the link order is n:1 (many users associated to one facility) |