Details of an integration

The Details page of an integration is used to establish connection to the target and define the functional behavior of the integration. It is the configuration of the integration which is determined by the Integration Type. It accounts for the different requirements to the integration setup and thus, the availability of the parameters. However, all integration details can be categorized into the following four groups of settings:

  1. general definition;
  2. connection parameters;
  3. test connection capability;
  4. feature configuration.

For more specialized information on how a specific connector should be configured, refer to the respective connector documentation. Herein, it is a brief overview of what can be reach out on the Details page:

Integration DetailsIntegration Details

  1. General definition of an integration:
    1. Environment Type - a dropdown list to select an environment the new integration pertains to. The Na option establishes no environment.
    2. Integration Name - an automatically generated name for the new integration. The name is created by combining the Integration Type with what is established as Environment Type, Alternate Name, and Description for the new integration.
    3. Alternate Name - any preferred name for the new integration.
    4. Description - any valid text to differentiate one integration from another. This text is displayed in addition to the integration name in several UI elements, e.g., dropdown lists, in the system.
  2. Connection and authentication parameters for ObserveID to access a system. This section of parameters differs depending on the selected Integration Type.
  3. Capability to run an automated test and see if the connection is established and the parameters are effective and work.

Remember to click Save every time changes are made for the Details of an integration.

Often, it is referred to as an ‘integration config’ providing the details on how the current instance of the integration has been implemented. More information on the integration per Integration Type is available in the connector documentation as an integration specification and a reference of all available integration operations and integration data schema.