Viewing the Vocera QGenda Adapter Requirements

System

This Vocera QGenda Adapter depends on Vocera Platform 6.0.0 and greater.

This Vocera QGenda Adapter depends on version 5.5 or greater of the Engage Platform.

Datasets

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.

• The ASSIGNMENTS Dataset stores all assignments for staff. These are used to determine who to send alerts to.
• The FACILITIES Dataset stores all facility information for a site. Represents a physical building location or campus.
• The FUNCTIONAL_ROLES Dataset stores all roles for assignments. These are used to determine the activities users can perform.
• The LOCATIONS Dataset stores all locations. These represent a bed or group of beds to which assignments are made.
• The USERS Dataset stores all Engage users.

ASSIGNMENTS Dataset

Element	Name	Reverse Name	Key	Reverse Key	Required	Type	Description
Attribute	assignment_id	N/A	True	N/A	N/A	String	Attribute that stores the unique identifier for the assignment.
Attribute	interface_id	N/A	True	N/A	N/A	String	Attribute that stores the identifier for the interface owning this assignment.
Attribute	level	N/A	True	N/A	N/A	String	Attribute that stores the level of the assignment.
Attribute	assigned_at	N/A	False	N/A	False	Date/Time	Attribute that stores the timestamp at which the assignment was assigned to the user.
Attribute	ends_at	N/A	False	N/A	False	Date/Time	Attribute that stores the timestamp at which the assignment is scheduled to end.
Attribute	external	N/A	False	N/A	False	String	Attribute that stores whether or not the assignment came from an external system.
Attribute	starts_at	N/A	False	N/A	False	Date/Time	Attribute that stores the timestamp at which the assignment is scheduled to start.
Link	location	assignments	False	False	N/A	Many-to-one	The ASSIGNMENTS Dataset is linked to the LOCATIONS Dataset, and the link order is n:1 (many assignments associated to one location)
Link	role	assignments	False	False	N/A	Many-to-one	The ASSIGNMENTS Dataset is linked to the FUNCTIONAL_ROLES Dataset, and the link order is n:1 (many assignments associated to one functional_role)
Link	usr	assignments	False	False	N/A	Many-to-one	The ASSIGNMENTS Dataset is linked to the USERS Dataset, and the link order is n:1 (many assignments 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 of the facility.
Link	locations	facility	False	True	N/A	One-to-many	The FACILITIES Dataset is linked to the LOCATIONS Dataset, and the link order is 1:n (one facility associated to many locations)
Link	roles	facility	False	True	N/A	One-to-many	The FACILITIES Dataset is linked to the FUNCTIONAL_ROLES Dataset, and the link order is 1:n (one facility associated to many functional_roles)

FUNCTIONAL_ROLES 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 role.
Link	facility	roles	True	False	N/A	Many-to-one	The FUNCTIONAL_ROLES Dataset is linked to the FACILITIES Dataset, and the link order is n:1 (many functional_roles associated to one facility)
Link	assignments	role	False	False	N/A	One-to-many	The FUNCTIONAL_ROLES Dataset is linked to the ASSIGNMENTS Dataset, and the link order is 1:n (one functional_role associated to many assignments)

LOCATIONS Dataset

Element	Name	Reverse Name	Key	Reverse Key	Required	Type	Description
Attribute	location_id	N/A	True	N/A	N/A	String	Attribute that stores the unique identifier for the location.
Link	facility	locations	True	False	N/A	Many-to-one	The LOCATIONS Dataset is linked to the FACILITIES Dataset, and the link order is n:1 (many locations associated to one facility)
Link	assignments	location	False	False	N/A	One-to-many	The LOCATIONS Dataset is linked to the ASSIGNMENTS Dataset, and the link order is 1:n (one location associated to many assignments)

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.
Link	assignments	usr	False	False	N/A	One-to-many	The USERS Dataset is linked to the ASSIGNMENTS Dataset, and the link order is 1:n (one user associated to many assignments)