Skip to content

This component is complete and can be used. The interfaces will be supported until the function is removed from the project via the deprecation process. There will be ongoing extensions to this function, but it will be done to ensure backward compatibility as far as possible. If there is a need to break backward compatibility, this will be discussed and reviewed in the community, with a documented timeline.

Governance Engine Open Metadata Access Service (OMAS)

The Governance Engine OMAS supports the implementation of a governance program by providing the metadata services for defining and running governance engines as well as setting up integration groups.

Governance Engines

A governance engine is a collection of related governance services that provide pluggable governance functions. The governance services are implemented as specialist connectors that are defined by:

The governance services run in the Engine Host OMAG Server supported by the Open Metadata Engine Services (OMES). They are triggered via governance actions.

The Governance Engine OMAS has the following capabilities to support governance engines:

Java Interface Description
GovernanceEngineConfiguration Creating the definitions for governance engines and their governance services.
GovernanceEngineEventInterface Providing the events that enable the Engine Host OMAG Server to be notified of any changes to governance actions, governance engines and governance services. It also provides support for the watchdog events.
GovernanceProcessingInterface Providing the APIs that enable the Engine Host OMAG Server to retrieve the definitions of the governance engines and services.
GovernanceActionProcessInterface Creating the definitions for governance action processes that control the sequencing of [engine actions](/concepts/engine-action.
GovernanceProcessingInterface Providing APIs to initiate engine actions and governance action processes explicitly.
GovernanceEngineEventListener Notification of new engine actions to the Engine Host OMAG Servers that then invoke the appropriate governance services to action them.
MetadataElementInterface Supporting the metadata requirements for many of the engine services.
GovernanceEngineConfiguration Providing APIs to query the status of the governance capabilities implemented through the governance engines.
SpecialGovernanceActionInterface Providing specialized governance remediation APIs such as linking duplicates.

Behind the scenes, Governance Engine OMAS handles the choreography of governance actions based on the process definition provided by a governance action process.

Further documentation

The documentation for writing governance services is located in the developer guide:

  • Open Discovery Services for metadata discovery.
  • Governance Action Services for the Governance Action Services: Watchdog Governance Services, Triage Governance Services, Verification Governance Services, Remediation Governance Services and Provisioning Governance Services.

Integration Groups

An integration group is a collection of integration connector definitions intended to run in one or more integration daemons. The Governance Engine OMAS provides the API to maintain the integration group and integration connector definitions. The integration daemon then loads the definitions from the integration group and runs the requested integration connectors. This is an alternative method to configure the integration daemon from adding the integration connectors directly into the integration daemon's configuration document. The advantage of this approach is that new integration connectors can be added without restarting the integration daemon.

integration group operation

The Governance Engine OMAS supports the creation and maintenance of the metadata that makes up an integration pack. At the root is the IntegrationGroup. Linked to it are the IntegrationConnector entities - one for each integration connector that is to run. Each have a connection attached that is used to initialize the integration connector. Optionally, the integration connector can be linked to existing metadata elements via the CatalogTarget relationship. This guides the integration connector on which elements to update - rather than creating new elements. For example, if the integration connector is cataloguing a specific database and its Database entity has already been created, it would be linked to the IntegrationConnector entity via the CatalogTarget relationship. The integration connector is able to retrieve the catalog target via its context.

integration group example

General metadata governance

The Governance Engine OMAS supports the standard Open Metadata Store interfaces.

Raise an issue or comment below