Skip to main content

Adding an Agile Data Engine Connection

Prerequisites

  • A user with sufficient permissions is required to establish a connection with Agile Data Engine.
  • Zeenea traffic flows towards the data source must be open.
note

A link to the configuration template can be found here: Zeenea Connector Downloads.

Supported Versions

The Agile Data Engine connector is compatible with version 22.1 and later to take advantage of the Agile Data Engine version 2 metadata interface.

Installing the Plugin

You can download the plugin here: Zeenea Connector Downloads.

For more information on how to install a plugin, please refer to the following article: Installing and Configuring Connectors as a Plugin.

Declaring the Connection

Creating and configuring connectors is done through a dedicated configuration file located in the "/connections" folder of the relevant scanner.

Read more: Managing Connections

In order to establish a connection with an Agile Data Engine instance, specifying the following parameters in the dedicated file is required:

ParameterExpected value
nameThe name that will be displayed to catalog users for this connection.
codeThe unique identifier of the connection on the Zeenea platform. Once registered on the platform, this code must not be modified or the connection will be considered as new and the old one removed from the scanner.
connector_idThe type of connector to be used for the connection. Here, the value must be solita-ade and this value must not be modified.
CSV files connection configuration
connection.pathAbsolute folder path which contains metadata interface CSV files
Database connection configuration
connection.urlDatasource URL
connection.driverDriver class name (example: org.postgresql.Driver)
connection.usernameDatabase username
connection.passwordDatabase user password
filter.includesList of regular expressions with comma separated representing target entity package to include
filter.excludesList of regular expressions with comma separated representing target entity package to exclude

User Permissions

In order to collect metadata, the running user's permissions must allow them to access and read files or databases that contain metadata.

Data Extraction

To extract information, the connector runs requests on following objects:

  • workflow_load_target_entity
  • workflow_load_usage
  • workflow_load_source_entity
  • package
  • entity
  • workflow_load

Collected Metadata

Data Process

A data process is an Agile Data Engine workflow load.

  • Name: Workflow load identifier
  • Source Description
  • Technical Data:
    • Workflow Name
    • Workflow Cron
    • Target Entity Package

Unique Identifier Keys

A key is associated with each item of the catalog. When the object comes from an external system, the key is built and provided by the connector.

More information about unique identification keys in this documentation: Identification Keys.

ObjectIdentifier KeyDescription
Data processcode/workflow load identifier
  • code: Unique identifier of the connection noted in the configuration file
  • workflow load identifier