Define a database connection object

A connection parameter definition and an authentication definition for connection to the third-party component is available in the XML object GenericAPIIntegrationConfig and a resource bundle is defined in Alfabet Expand.

Specify the connection to the third-party component in the Generic API Integration - Data Connections Configuration view in the Alfabet user interface.

If the functionality is not available, you can add it to the menu of an administrative user profile . Set the Target Type attribute of the menu item to GraphicView and the Target attribute to CONF_GAI_INTEGRATION.

  1. In the toolbar, click New > Create Generic API Integration Database Connection.
  2. Specify the connection parameters:

    Basic Data tab:

    • Name: Define a name for the connection. The name is used to identify the connection in the following configuration steps.
    • Description: Optionally enter a description of the purpose of this connection.
    • Release Status: If your company supports release status definitions for API connections, you can select a release status to specify the approval state of the connection definition.

    Authorized Access tab: Define the authorized user responsible for maintaining the connection definition and the user groups whose members shall have edit rights for the connection definition.

    Connection tab:

    • Generic API Connection: Select the name of the relevant generic API integration connection definition in the XML object GenericAPIIntegrationConfig.
    • OAS Bundle: Select the name of the relevant resource bundle.
    • OAS Item: Select the name of the OAS connection which you defined in the resource bundle's assistant in the attribute OAS Connector Name.

    If you are using OAuth2 authentication for the connection to the third-party component, go to the OAuth2 Configuration tab, enter the OAUth authorization code provided by the third-party vendor in the authorization Code field and click Get Access Token. If the connection succeeds, the access token will be displayed behind the text Access Token. Otherwise, an error message is displayed in the field Response.

  3. Click Next if you would like to define fixed parameters handed over to the third-party's RESTful service during each call. If all mandatory parameters are defined in the connection definition, ADIF schemes configured to use this connection definition will not require a parameter mapping for the call. If you do not want to specify fixed parameters, you can directly exit the editor.

    In the Connection Details view, click New > Create New Connection Property to define a parameter to be handed over to the connection. A wizard opens. Define the name, data type and value for the parameter. If parameters are handed over in a hierarchy, you can define the subordinate connection properties in the next step of the wizard.