0461 Governance Engines¶
The governance engine types in this model are used to create a governance engine definition.
GovernanceEngine entity¶
A governance engine is a software capability that is able to run specific services on demand. These services, called governance services, typically implement specific logic that is needed to govern an organization's resources or the metadata associated with them.
Open metadata recognizes three types of governance engine:
- GovernanceActionEngine - Governance action engines and services support the active governance of metadata and the resources they represent. There are different types of governance action engines/services that are defined by the Governance Action Framework (GAF).
- RepositoryGovernanceEngine - Repository governance engines and services support the maintenance of repository level concerns, such as monitoring audit logs and maintaining open metadata archives that are defined in the Open Metadata Repository Services (OMRS).
- SurveyActionEngine - Survey action engines and services support the analysis of digital resources. The results of this analysis are stored in a survey report chained off of the corresponding Asset metadata element. The interfaces for surveys are found in the Survey Action Framework (SAFF).
SupportedGovernanceService relationship¶
The capability of a governance engine is specified via the SupportedGovernanceService relationships.
The requestType attribute in this relationship is the caller's request type (known as the governance request type). The serviceRequestType attribute maps the governance request type to a request type supported by the associated governance service. If serviceRequestType is null, the governance request type is used when calling the governance service.
Each governance request type linked to a specific governance engine must be unique.
The requestParameters provide initial values of the request parameters passed to the governance services when it is called. These are overridden by any request parameters supplied by the caller.
The generateIntegrationReport configures whether an integration report of the metadata creates, updates and deletes performed by a call to this service is created.
GovernanceService entity¶
Governance services are specialist connectors. They are represented in open metadata using the GovernanceService entity which is a specialization of DeployedConnector`. This entity is linked to a Connection entity via a ConnectionToAsset relationship.
A governance service can be linked to multiple governance engines via the SupportedGovernanceService relationship. It can be linked to the same governance engine multiple times as long as each SupportedGovernanceService relationship has a different governance request type.
The subtype of the governance service linked via the SupportedGovernanceService relationship should be consistent with the subtype of the associated governance engine. For example:
- A GovernanceActionService is linked to a GovernanceActionEngine.
- A SurveyActionService is linked to an SurveyActionService.
- A RepositoryGovernanceService is linked to a RepositoryGovernanceEngine.
DeleteMethod enumeration¶
DeleteMethod defines the the type of delete method to use when the connector/governance service deletes an element.
| Enumeration | Value | Name | Description |
|---|---|---|---|
| ARCHIVE | 0 | "Archive Element" | This is the default value. The element is marked with the Memento classification which means it is no longer returned on normal queries. However if the forLineage=true option is used on a query, the element is returned. This mechanism is ued to preserve metadata for lineage graphs. |
| SOFT_DELETE | 1 | "Soft-delete Element" | The element is moved to DELETED status so that is no longer returned on queries. However, it is still in the repository and can be restored into the active repository if it was deleted by accident. |
| LOOK_FOR_LINEAGE | 2 | "Look for Lineage" | If the element is linked into lineage, it is archived, otherwise it is soft-deleted. However, it is still in the repository and can be restored into the active repository if it was deleted by accident. |
| PURGE | 3 | "Purge" | The element is removed from the active repository. It cannot be restored automatically. |
| OTHER | 99 | "Other" | Another type of delete process not supported by Egeria. |
Further information
The Open Metadata Engine Services (OMES) support the implementation of each type of governance engine. They run in an Engine Host OMAG Server and draw their configuration from the GovernanceEngine and the linked GovernanceService elements in the associated metadata server.
Raise an issue or comment below