Skip to content

Integration Group

An integration group describes a collection of integration connectors that are to run together in one or more integration daemons.


Each integration connector is represented by an entity of type IntegrationConnector linked to a Connection via the ConnectionToAsset relationship. This connection is used to instantiate the integration connector. It is also passed to the integration connector as it initializes, so it is used to pass configuration properties that describes its desired behaviour. The connection's optional endpoint describes the catalog target. Alternatively, the integration connector's catalog target(s) can be supplied via the CatalogTarget relationship.

integration group structure

Examples of integration connector definitions

The exact specification of an integration connector depends on how the integration connector is implemented. Details of the integration connectors supplied with Egeria, and how to configure them are available in the connector catalog.

Some integration connectors use a simple connection structure. The ConnectorType linked to the connection identifies the implementation of the integration connector. The endpoint describes how to connect to the third party technology.

integration connector with a simple connection

Some connectors need a virtual connection with embedded connectors that describe different resources.

Integration connector with a virtual connection

For example, this integration connector has a virtual connection with an embedded secrets store for managing passwords ans certificates.

Example of integration connector with a virtual connection

Alternatively, using catalog targets provides a more efficient way to supply information about the technology that the integration connector is to work with.

The connection for the integration connector just needs the connector type to describe its implementation. The CatalogTarget relationship links to an asset that describes the technology that the integration connector is to work with.

Example of integration connector with a virtual connection

The integration connector can have multiple catalog log targets that can change over time.

Configuring integration groups

An integration daemon is configured with a list of qualified names for various integration groups. It retrieves the list of integration connectors in each of these groups from the open metadata ecosystem and starts to run them. It continues to monitor for changes to the integration groups and their linked integration connectors, changing the connectors it is running as needed.

integration group operation

Further information

Each integration group has a unique name. An IntegrationGroup entity with a qualifiedName set to this unique name is created through the Governance Engine OMAS API. This API is also used to create and link the integration connector definitions into the integration group.

The integration group's qualifiedName is configured in the integration daemon.

The open metadata types for this definition are in model 0464 - Dynamic Integration Groups - specifically notice that IntegrationGroup and IntegrationConnector are linked by the RegisteredIntegrationConnector relationship.

Raise an issue or comment below