Viewing the Engage Amtelco Adapter Requirements

The minimum requirements for a Engage Amtelco Adapter installation are described here.

System

This adapter is supported on Engage Platform version 5.5.6.1 and greater.

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.

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)

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 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)

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.