From 01fc1b8e8013c3d5b726fbe1b3aecb1fb0e9f74e Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Mon, 26 Feb 2024 10:42:12 +0000 Subject: [PATCH] Add zone publisher description Signed-off-by: Mandy Chessell --- ...erations-server-choices-no-description.svg | 3 +- site/docs/concepts/governance-engine-pack.md | 2 +- .../docs/concepts/governance-service-types.md | 1 - site/docs/concepts/governance-service.md | 10 +-- site/docs/concepts/index.md | 4 - site/docs/connectors/connector-catalog.drawio | 71 ++++++++++----- ...-provisioning-governance-action-service.md | 22 ++--- ...emediation-governance-action-service-1.svg | 3 +- ...emediation-governance-action-service-2.svg | 3 +- ...emediation-governance-action-service-3.svg | 3 +- ...emediation-governance-action-service-4.svg | 3 +- ...r-remediation-governance-action-service.md | 14 ++- ...-remediation-governance-action-service.svg | 3 +- ...one-publisher-governance-action-service.md | 86 +++++++++++++++++++ ...ne-publisher-governance-action-service.svg | 4 + site/docs/connectors/index.md | 3 +- .../repository-proxy-embedded-repository.md | 2 - site/docs/frameworks/gaf/overview.md | 2 +- site/docs/guides/admin/egeria-admin.drawio | 12 +-- .../basic-server-properties-section.md | 3 - .../configuring-a-conformance-test-server.md | 1 - site/docs/guides/developer/index.md | 2 +- .../engine-action-status.svg | 2 +- .../metadata-governance/governance-engines.md | 6 +- .../metadata-governance.drawio | 53 +++++++----- site/docs/release-notes/february-2023.md | 2 +- site/docs/services/omas/index.md | 4 +- .../services/omes/event-action/overview.md | 2 +- .../omvs/automated-curation/overview.md | 10 ++- site/docs/types/4/0424-Governance-Zones.md | 2 +- site/docs/types/4/0463-Engine-Actions.md | 27 +++--- site/docs/types/4/0463-Engine-Actions.svg | 2 +- site/docs/types/4/area-4-governance.drawio | 24 +++--- site/mkdocs.yml | 13 +-- .../admin/configuring-local-server-url.md | 17 ---- ...onfiguring-omag-server-basic-properties.md | 28 ++++-- .../admin/configuring-the-local-repository.md | 70 +++++++++------ 37 files changed, 322 insertions(+), 197 deletions(-) create mode 100644 site/docs/connectors/governance-action/zone-publisher-governance-action-service.md create mode 100644 site/docs/connectors/governance-action/zone-publisher-governance-action-service.svg delete mode 100644 site/snippets/admin/configuring-local-server-url.md diff --git a/site/docs/concepts/egeria-operations-server-choices-no-description.svg b/site/docs/concepts/egeria-operations-server-choices-no-description.svg index 7296050be9..e6eb47a9e4 100644 --- a/site/docs/concepts/egeria-operations-server-choices-no-description.svg +++ b/site/docs/concepts/egeria-operations-server-choices-no-description.svg @@ -1,3 +1,4 @@ + -
OMAG Server Platform
OMAG Server Platform
OMAG Server Platform
OMAG Server Platform
OMAG Server Platform
OMAG Server Platform
OMAG Server
OMAG Server
OMAG Server
OMAG Server
OMAG Server
OMAG Server
OMAG Server
OMAG Server
:
:
:...
OMAG Server Platform
OMAG Server Platform
OMAG Server
OMAG Server
OMAG Server Platform
OMAG Server Platform
OMAG Server
OMAG Server
OMAG Server
OMAG Server
OMAG Server
OMAG Server
:
:
:...
OMAG Server
OMAG Server
:
:
:...
:
:
:...
OMAG Server Platform
OMAG Server Platform
OMAG Server
OMAG Server
OMAG Server Platform
OMAG Server Platform
OMAG Server
OMAG Server
A
A
B
B
C
CViewer does not support full SVG 1.1 \ No newline at end of file +
OMAG Server Platform
OMAG Server Platform
OMAG Server Platform
OMAG Server
OMAG Server
OMAG Server
OMAG Server
:
:
OMAG Server Runtime
OMAG Server
OMAG Server Platform
OMAG Server
OMAG Server
OMAG Server
:
:
OMAG Server
:
:
:
:
OMAG Server Runtime
OMAG Server
OMAG Server Runtime
OMAG Server
A
B
C
 \ No newline at end of file diff --git a/site/docs/concepts/governance-engine-pack.md b/site/docs/concepts/governance-engine-pack.md index 094b21fce5..7099f67746 100644 --- a/site/docs/concepts/governance-engine-pack.md +++ b/site/docs/concepts/governance-engine-pack.md @@ -14,7 +14,7 @@ It is used to distribute the governance engine function to different metadata ec * [Building Governance Engine Packs](/guides/developer/open-metadata-archives/creating-governance-engine-packs) * [Building Governance Action Services](/guides/developer/governance-action-services/overview) - * [Building Open Discovery Services](/guides/developer/open-discovery-services/overview) + * [Building Survey Action Services](/guides/developer/survey-action-services/overview) * [Building Repository Governance Services](/guides/developer/repository-governance-services/overview) --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/concepts/governance-service-types.md b/site/docs/concepts/governance-service-types.md index 4adb9c054f..2fa29f6e6e 100644 --- a/site/docs/concepts/governance-service-types.md +++ b/site/docs/concepts/governance-service-types.md @@ -15,7 +15,6 @@ There are ten types of governance services. Related governance services are [pa | [General Governance Action Service](/guides/developer/governance-action-services/overview) | Some form of governance activity. | [Governance Action Engine](/concepts/governance-action-engine) | [Governance Action OMES](/services/omes/governance-action/overview) | | [Event Action Service](/guides/developer/event-action-services/overview) | Event management around [Context Event](/concepts/context-event). | [Event Action Engine](/concepts/event-action-engine) | [Event Action OMES](/services/omes/event-action/overview) | | [Repository Governance Service](/guides/developer/repository-governance-services/overview) | Performs governance for open metadata repositories such as dynamically maintaining [open metadata archives](/concepts/open-metadata-archive). | [Repository Governance Engine](/concepts/repository-governance-engine) | [Repository Governance OMES](/services/omes/repository-governance/overview) | -| [Open Discovery Service](/guides/developer/open-discovery-services/overview) | Analyses the content of an [Asset's](/concepts/asset) real-world counterpart ([digital-resource](/concepts/digital-resource)) in the digital landscape. (For example, if the asset describes a file, the open discovery service analyses the data stored in the file). | [Open Discovery Engine](/concepts/open-discovery-engine) | [Asset Analysis OMES](/services/omes/asset-analysis/overview) | --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/concepts/governance-service.md b/site/docs/concepts/governance-service.md index 1ac975e102..7eae6b1c3c 100644 --- a/site/docs/concepts/governance-service.md +++ b/site/docs/concepts/governance-service.md @@ -7,20 +7,12 @@ A governance service is a specialized [connector](/concepts/connector) that impl --8<-- "docs/concepts/governance-service-types.md" -## Catalog of governance services - -* [Open Discovery Service Catalog](/connectors/#open-discovery-services) -* [Governance Action Service Catalog](/connectors/#governance-action-services) -* [Event Action Catalog](/connectors/#event-action-services) -* [Repository Governance Catalog](/connectors/#repository-governance-services) - ## Implementing your own governance services Instructions for implementing your own governance services are in the developer guide under the following sections: -* [Writing Open Discovery Services](/guides/developer/open-dicovery-services/overview) * [Writing Governance Action Services](/guides/developer/governance-action-services/overview) -* [Writing Engine Action Services](/guides/developer/engine-action-services/overview) +* [Writing Survey Action Services](/guides/developer/survey-action-services/overview) * [Writing Repository Governance Services](/guides/developer/repository-governance-services/overview) ## Support for running governance services diff --git a/site/docs/concepts/index.md b/site/docs/concepts/index.md index d93f9c8e45..14ea06840d 100644 --- a/site/docs/concepts/index.md +++ b/site/docs/concepts/index.md @@ -146,7 +146,6 @@ - [Audit Log Framework (ALF)](/frameworks/alf/overview) - [Open Connector Framework (OCF)](/frameworks/ocf/overview) - [Open Integration Framework (OIF)](/frameworks/oif/overview) - - [Open Discovery Framework (ODF)](/frameworks/odf/overview) - [Governance Action Framework (GAF)](/frameworks/gaf/overview) - [Event Action Framework (EAF)](/frameworks/eaf/overview) - [Survey Action Framework (EAF)](/frameworks/saf/overview) @@ -275,9 +274,6 @@ - [OMRS](/services/omrs) - [OMRS Event Topic](/concepts/cohort-topic) - [Open Connector Framework (OCF)](/frameworks/ocf/overview) -- [Open Discovery Engine](/concepts/open-discovery-engine) -- [Open Discovery Framework (ODF)](/frameworks/odf/overview) -- [Open Discovery Service](/concepts/open-discovery-service) - [Open Integration Framework](/frmeworks/oif/overview) - [Open Metadata and Governance (OMAG)](/introduction/overview) - [Open Metadata Archives](/concepts/open-metadata-archive) diff --git a/site/docs/connectors/connector-catalog.drawio b/site/docs/connectors/connector-catalog.drawio index ec62405289..c3434bec4b 100644 --- a/site/docs/connectors/connector-catalog.drawio +++ b/site/docs/connectors/connector-catalog.drawio @@ -1,6 +1,6 @@ - + - + @@ -2325,7 +2325,7 @@ - + @@ -2854,7 +2854,7 @@ - + @@ -2879,7 +2879,7 @@ - + @@ -2938,17 +2938,17 @@ - - + + - - + + - - + + - - + + @@ -2994,11 +2994,11 @@ - - + + - - + + @@ -3038,11 +3038,11 @@ - - + + - - + + @@ -3056,6 +3056,35 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/connectors/governance-action/move-copy-file-provisioning-governance-action-service.md b/site/docs/connectors/governance-action/move-copy-file-provisioning-governance-action-service.md index 2b3f5e1734..d317f381cb 100644 --- a/site/docs/connectors/governance-action/move-copy-file-provisioning-governance-action-service.md +++ b/site/docs/connectors/governance-action/move-copy-file-provisioning-governance-action-service.md @@ -32,7 +32,7 @@ the lineage may be turned on or off. > **Figure 1:** Operation of the move/copy file provisioning governance action service If lineage is requested, it includes adding a new [DataFile](/types/2/0220-Files-and-Folders) -asset for the new file in the destination folder and creating [LineageMapping](/types/7/0770-Lineage-Mapping) +asset for the new file in the destination folder and creating [DataFlow](/types/7/0750-Data-Passing) relationships between the process that represents this governance action service and both the asset for the original source file and as well as the destination. There are four choices for lineage: @@ -82,11 +82,7 @@ may be triggered. ## Configuration -This connector uses the [Governance Action OMES](/services/omes/governance-action/overview) -running in the [Engine Host](/concepts/engine-host). - -The following configuration properties can be set to control -the behavior of the service on every instance. +The following configuration properties can be set to control the behavior of the service on every instance. - **provisionUncataloguedFiles** - if this property is set to any value, the service may work with files that are not catalogued in open metadata. This is used when processing files that are entering the open metadata ecosystem. @@ -99,21 +95,17 @@ the behavior of the service on every instance. governance action service) with the value that this property is set to. - **lineageWithTopLevelProcessOnly** - if this property is set, lineage mappings are connected to the top level process representing - this + this governance action service. - **lineageToDestinationFolderOnly** - if this property is set, the lineage relationship from the governance action service to the destination is linked to the destination folder rather than the new file in the destination folder. - Without this value, the default behavior is to show lineage from governance action process to file. + Without this value, the default behavior is to show lineage from governance action process to the destination file. - **lineageFromSourceFolderOnly** - if this property is set, the lineage relationship from the source to the governance action service is linked from the source folder rather than the source file. Without this value, the default behavior is to show lineage from source file to governance action process. -This is its connection definition to use when -creating the definition of the governance action service -using the [Governance Engine OMAS](/services/omas/governance-engine). -Remove the configuration properties that are not required. -Replace `{processName}` and `{pattern}` as required. +This is its connection definition to use when creating the definition of the governance action service using the [Open Governance Service](/services/gaf-metadata-management). Remove the configuration properties that are not required. Replace `{{processName}}` and `{{pattern}}` as required. ```json @@ -128,9 +120,9 @@ Replace `{processName}` and `{pattern}` as required. "configurationProperties": { "provisionUncataloguedFiles": "", - "targetFileNamePattern": "{pattern}", + "targetFileNamePattern": "{{pattern}}", "noLineage": "", - "processName": "{processName}", + "processName": "{{processName}}", "lineageWithTopLevelProcessOnly": "", "lineageToDestinationFolderOnly": "", "lineageFromSourceFolderOnly": "" diff --git a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-1.svg b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-1.svg index 60e8d632bc..3d1e49d089 100644 --- a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-1.svg +++ b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-1.svg @@ -1,3 +1,4 @@ + -
Source Asset
Source Asset
Action Target
Action Target
Process
Process
Lineage Mapping
Lineage Mapping
Lineage Mapping
Lineage Mapping
Origin 1
Origin 1
guard=origin-assigned
guard=origin-assigned
Origin 1
Origin 1Viewer does not support full SVG 1.1 \ No newline at end of file +
Source Asset
Action Target
Process
Lineage
relationship
Lineage
relationship
Origin 1
guard=origin-assigned
Origin 1
 \ No newline at end of file diff --git a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-2.svg b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-2.svg index 20fb64b976..8d007d2630 100644 --- a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-2.svg +++ b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-2.svg @@ -1,3 +1,4 @@ + -
Source Asset
Source Asset
Process
Process
Action Target
Action Target
Source Asset
Source Asset
Lineage Mapping
Lineage Mapping
Lineage Mapping
Lineage Mapping
Origin 1
Origin 1
Origin 1
Origin 1
guard=origin-assigned
guard=origin-assigned
Origin 1
Origin 1Viewer does not support full SVG 1.1 \ No newline at end of file +
Source Asset
Process
Action Target
Source Asset
Lineage
relationship
Lineage
relationship
Origin 1
Origin 1
guard=origin-assigned
 \ No newline at end of file diff --git a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-3.svg b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-3.svg index c84a7b72bb..1d51f66fd8 100644 --- a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-3.svg +++ b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-3.svg @@ -1,3 +1,4 @@ + -
Source Asset
Source Asset
Process
Process
Action Target
Action Target
Source Asset
Source Asset
Lineage Mapping
Lineage Mapping
Lineage Mapping
Lineage Mapping
Origin 1
Origin 1
Origin 2
Origin 2
guard=multiple-origins-detected
guard=multiple-origins-detectedViewer does not support full SVG 1.1 \ No newline at end of file +
Source Asset
Process
Action Target
Source Asset
Lineage
relationship
Lineage
relationship
Origin 1
Origin 2
guard=multiple-origins-detected
 \ No newline at end of file diff --git a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-4.svg b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-4.svg index 6877a537b0..e327771563 100644 --- a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-4.svg +++ b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service-4.svg @@ -1,3 +1,4 @@ + -
Source Asset
Source Asset
Process
Process
Action Target
Action Target
Source Asset
Source Asset
Lineage Mapping
Lineage Mapping
Lineage Mapping
Lineage Mapping
guard=no-origins-detected
guard=no-origins-detectedViewer does not support full SVG 1.1 \ No newline at end of file +
Source Asset
Process
Action Target
Source Asset
Lineage
relationship
Lineage
relationship
guard=no-origins-detected
 \ No newline at end of file diff --git a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service.md b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service.md index bd79d08ef0..9a11f7811c 100644 --- a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service.md +++ b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service.md @@ -2,7 +2,7 @@ -# Origin Seeker Remediation Governance Action Service +# Origin Seeker Governance Action Service !!! info "Connector summary" @@ -13,12 +13,12 @@ - Jar File Name: `governance-action-connectors.jar` - ConnectorProviderClassName: `org.odpi.openmetadata.adapters.connectors.governanceactions.remediation.OriginSeekerGovernanceActionProvider` -An asset may have an origin classification attached that documents various properties about its origin. The *Origin Seeker* Remediation Governance Action Service sets up the origin classification on an asset by navigating backwards through the lineage relationships to locate origin classifications attached to the assets in the lineage graph. +An asset may have an origin classification attached that documents various properties about its origin. The *Origin Seeker* Governance Action Service sets up the origin classification on an asset by navigating backwards through the lineage relationships to locate origin classifications attached to the assets in the lineage graph. ![Figure 1](origin-seeker-remediation-governance-action-service.svg) -> **Figure 1:** Operation of the origin seeker remediation governance action service +> **Figure 1:** Operation of the Origin Seeker governance action service -Origin seeker is only able to assign an origin to the asset if at least on of the assets in its lineage has an origin classification, and where there are multiple assets. If one (and only one) is found, it is assigned to the action target asset. +*Origin Seeker* is only able to assign an origin to the asset if at least on of the assets in its lineage has an origin classification, and where there are multiple assets. If one (and only one) is found, it is assigned to the action target asset. Figure 2 shows a simple example of origin seeker finding an origin in a no-branching lineage graph. @@ -42,9 +42,7 @@ Finally the origin is not assigned because there are no origin classifications i ## Configuration -This connector uses the [Governance Action OMES](/services/omes/governance-action/overview) running in the [Engine Host](/concepts/engine-host). - -This is its connection definition to use when creating the definition of the governance action service using the [Governance Engine OMAS](/services/omas/governance-engine/overview). Note that is does not use configuration properties. +This is *Origin Seeker*'s connection definition to use when creating the definition of the governance action service using the [Open Governance Services](/services/gaf-metadata-management). Note that is does not use configuration properties. ```json @@ -81,7 +79,7 @@ These are the responses that origin seeker produces: - `CompletionStatus.ACTIONED` with guard `origin-already-assigned` if the asset already has an origin set up. - `CompletionStatus.INVALID` with guard `multiple-origins-detected` if multiple, different origins are detected in the lineage graph. - `CompletionStatus.INVALID` with guard `no-origins-detected` if no origin classifications are found in the lineage graph. -- `CompletionStatus.FAILED` with guard `no-targets-detected` if there is no asset set up as an action target. +- `CompletionStatus.INVALID` with guard `no-targets-detected` if there is no asset set up as an action target. - `CompletionStatus.FAILED` with guard `multiple-targets-detected` if there are multiple assets set up as action targets. - `CompletionStatus.FAILED` with guard `origin-seeking-failed` for an unrecoverable error such as a not authorized response from the metadata repository. diff --git a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service.svg b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service.svg index 0b47627985..58475a148d 100644 --- a/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service.svg +++ b/site/docs/connectors/governance-action/origin-seeker-remediation-governance-action-service.svg @@ -1,3 +1,4 @@ + -
Engine Host
Engine Host
Governance Action OMES
Governance Action OMES
Origin Seeker
Remediation
Governance Action
Service
Origin Seeker...
Metadata Access Server
Metadata Access Server
Governance Engine OMAS
Governance Engine OMAS
addOrigin
addOrigin
retrieveLineage
retrieveLineageViewer does not support full SVG 1.1 \ No newline at end of file +
Engine Host
Governance Action OMES
Origin Seeker
Governance Action
Service
Metadata Access Server
Governance Engine OMAS
addOrigin
retrieveLineage
 \ No newline at end of file diff --git a/site/docs/connectors/governance-action/zone-publisher-governance-action-service.md b/site/docs/connectors/governance-action/zone-publisher-governance-action-service.md new file mode 100644 index 0000000000..f37dc5600a --- /dev/null +++ b/site/docs/connectors/governance-action/zone-publisher-governance-action-service.md @@ -0,0 +1,86 @@ + + + + +# Zone Publisher Governance Action Service + +!!! info "Connector summary" + + - Connector Category: [Governance Action Service](/concepts/governance-action-service) + - Hosting Service: [Governance Action OMES](/services/omes/governance-action/overview) + - Hosting Server: [Engine Host](/concepts/engine-host) + - Source Module: [governance-action-connectors](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/governance-action-connectors) + - Jar File Name: `governance-action-connectors.jar` + - ConnectorProviderClassName: `org.odpi.openmetadata.adapters.connectors.governanceactions.remediation.ZonePublisherGovernanceActionProvider` + +An asset's [governance zones](/concepts/governance-zone) determines its visibility to callers. Its zone membership is maintained in the [Asset Zone Membership](/types/4/0424-Governance-Zones) classification. + +The *Zone Publisher* Governance Action Service sets the supplied governance zone names into the assets supplied as action targets. + +* If there is at least one asset, their zones are updated, and the output guard is set to zone-assigned. +* If no Assets are passed as action targets the output guard is no-targets-detected. + +![Figure 1](zone-publisher-governance-action-service.svg) +> **Figure 1:** Operation of the Zone Publisher governance action service + + +## Configuration + +This connector uses the [Governance Action OMES](/services/omes/governance-action/overview) running in the [Engine Host](/concepts/engine-host). + +This is its connection definition to use when creating the definition of the governance action service using the [Governance Engine OMAS](/services/omas/governance-engine/overview). +Note that `publishZones` can be specified in either the configuration properties or the request parameters. The value in the request parameters overrides the configuration properties value. + + +```json +{ + "connection" : { + "class" : "Connection", + "connectorType" : + { + "class" : "ConnectorType", + "connectorProviderClassName" : "org.odpi.openmetadata.adapters.connectors.governanceactions.remediation.ZonePublisherGovernanceActionProvider" + }, + "configurationProperties" : + { + "publishZones" : "zone1,zone2" + } + } +} + +``` + +## Governance Action Settings + +When this governance action service is called through an [engine action](/concepts/engine-action) it supports the following options. + +#### Request Types and Parameters + +Origin seeker does not specifically recognize any request types or request parameters. + +#### Action Targets + +The asset that needs an origin classification is linked to the governance action as an action target. The unique identifier (guid) can be passed as a parameter when the governance action or governance action process is initiated. + +#### Completion Status and Guards + +These are the responses that Zone Publisher produces: + +- `CompletionStatus.ACTIONED` with guard `zone-assigned` if the zones are successfully assigned to the assets. +- `CompletionStatus.INVALID` with guard `no-zones-detected` if the `publishZones` property is not set up in either the configuration properties or the request parameters. +- `CompletionStatus.INVALID` with guard `no-targets-detected` if no assets are passed as action targets. + +## Examples of use + +The [Open Metadata Labs](/education/open-metadata-labs/overview): this connector is configured in the `governDL01` engine host server as part of the **automated curation** asset management lab. + +## Related Information + +* See the [Governance Zoning](/features/governance-zoning/overview/) feature for more information on how to use governance zones. +* [Designing a Remediation Governance Action Service](/guides/developer/governance-action-services/overview/#remediation-context-methods). + + + +---- +License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/), +Copyright Contributors to the ODPi Egeria project. diff --git a/site/docs/connectors/governance-action/zone-publisher-governance-action-service.svg b/site/docs/connectors/governance-action/zone-publisher-governance-action-service.svg new file mode 100644 index 0000000000..5023f36a9a --- /dev/null +++ b/site/docs/connectors/governance-action/zone-publisher-governance-action-service.svg @@ -0,0 +1,4 @@ + + + +
Engine Host
Governance Action OMES
Zone Publisher
Governance Action
Service
Metadata Access Server
Governance Engine OMAS
add zone
membership
 \ No newline at end of file diff --git a/site/docs/connectors/index.md b/site/docs/connectors/index.md index 16590be29d..35d88c2934 100644 --- a/site/docs/connectors/index.md +++ b/site/docs/connectors/index.md @@ -104,7 +104,8 @@ The open lineage connectors work with the [Open Lineage standard](/features/line ## Open Metadata Governance Connectors * The [Generic Element Watchdog Governance Action Service](/connectors/governance-action/generic-element-watchdog-governance-action-service) listens for changing metadata elements and initiates governance action processes when certain events occur. -* The [Origin Seeker Remediation Governance Action Service](/connectors/governance-action/origin-seeker-remediation-governance-action-service) walks backwards through the lineage mappings to discover the origin of the data +* The [Origin Seeker Governance Action Service](/connectors/governance-action/origin-seeker-remediation-governance-action-service) walks backwards through the lineage relationships to discover the origin of the data asset. +* The [Zone Publisher Governance Action Service](/connectors/governance-action/zone-publisher-governance-action-service) updates the zone membership on the target action assets. ## Runtime connectors diff --git a/site/docs/connectors/repository/repository-proxy-embedded-repository.md b/site/docs/connectors/repository/repository-proxy-embedded-repository.md index 17488260c5..1733d85fa6 100644 --- a/site/docs/connectors/repository/repository-proxy-embedded-repository.md +++ b/site/docs/connectors/repository/repository-proxy-embedded-repository.md @@ -38,8 +38,6 @@ a [configuration document](/concepts/configuration-document). --8<-- "snippets/admin/configuring-event-bus.md" ---8<-- "snippets/admin/configuring-local-server-url.md" - --8<-- "snippets/admin/configuring-omag-server-basic-properties.md" --8<-- "snippets/admin/configuring-the-audit-log.md" diff --git a/site/docs/frameworks/gaf/overview.md b/site/docs/frameworks/gaf/overview.md index 25122efe1c..7677c4cbe1 100644 --- a/site/docs/frameworks/gaf/overview.md +++ b/site/docs/frameworks/gaf/overview.md @@ -22,7 +22,7 @@ A *governance action service* is a specialized [connector](/concepts/connector) There are five types of governance action services, each of which supports a specialist governance activity (see subsections). -These are often used in conjunction with the [open discovery services](/concepts/open-discovery-service) from the [Open Discovery Framework (ODF)](/frameworks/odf/overview). Collectively they are called the *governance services* and they can be linked together into [governance action processes](/concepts/governance-action-process). +These are often used in conjunction with the [survey action services](/concepts/survey-action-service) from the [Survey Action Framework (SAF)](/frameworks/saf/overview). Collectively they are called the *governance services* and they can be linked together into [governance action processes](/concepts/governance-action-process). Some governance action services invoke functions in external engines that are working with data and related assets. The GAF offers embeddable functions and APIs to simplify the implementation of governance action services, and their integration into the broader digital landscape, whilst being resilient and with good performance. diff --git a/site/docs/guides/admin/egeria-admin.drawio b/site/docs/guides/admin/egeria-admin.drawio index b7be7159ca..c947399083 100644 --- a/site/docs/guides/admin/egeria-admin.drawio +++ b/site/docs/guides/admin/egeria-admin.drawio @@ -1,4 +1,4 @@ - + @@ -3088,7 +3088,7 @@ - + @@ -3109,8 +3109,8 @@ - - + + @@ -3151,13 +3151,13 @@ - + - + diff --git a/site/docs/guides/admin/servers/by-section/basic-server-properties-section.md b/site/docs/guides/admin/servers/by-section/basic-server-properties-section.md index be4a79a4ee..78a84e973e 100644 --- a/site/docs/guides/admin/servers/by-section/basic-server-properties-section.md +++ b/site/docs/guides/admin/servers/by-section/basic-server-properties-section.md @@ -7,7 +7,4 @@ This section is completed for all server types. --8<-- "snippets/admin/configuring-omag-server-basic-properties.md" ---8<-- "snippets/admin/configuring-local-server-url.md" - - --8<-- "snippets/abbr.md" diff --git a/site/docs/guides/admin/servers/by-server-type/configuring-a-conformance-test-server.md b/site/docs/guides/admin/servers/by-server-type/configuring-a-conformance-test-server.md index 615a530888..177c822315 100644 --- a/site/docs/guides/admin/servers/by-server-type/configuring-a-conformance-test-server.md +++ b/site/docs/guides/admin/servers/by-server-type/configuring-a-conformance-test-server.md @@ -9,7 +9,6 @@ A *Conformance Test Server* is configured by creating a [configuration document] ??? info "Configuring the default values used in subsequent configuration commands" --8<-- "snippets/admin/configuring-event-bus.md" - --8<-- "snippets/admin/configuring-local-server-url.md" ??? info "Configuring the basic properties" --8<-- "snippets/admin/configuring-omag-server-basic-properties.md" diff --git a/site/docs/guides/developer/index.md b/site/docs/guides/developer/index.md index 11623b7528..49c135513f 100644 --- a/site/docs/guides/developer/index.md +++ b/site/docs/guides/developer/index.md @@ -171,7 +171,7 @@ Egeria has extended the basic concept of the OCF connector and created specializ | Type of Connector | Description | Documentation | Implementation Examples | |:----------------------------------------------|:---------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Integration Connector | Implements metadata exchange with third party tools. | [Building Integration Connectors](/guides/developer/integration-connectors/overview) | [integration-connectors :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/integration-connectors){ target=gh } | -| Open Discovery Service | Implements automated metadata discovery. | [Building Open Discovery Services](/guides/developer/open-discovery-services/overview) | [discovery-service-connectors :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/discovery-service-connectors){ target=gh } | +| Survey Action Service | Implements automated metadata discovery. | [Building Survey Action Services](/guides/developer/survey-action-services/overview) | [discovery-service-connectors :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/discovery-service-connectors){ target=gh } | | Governance Action Service | Implements automated governance. | [Building Governance Action Services](/guides/developer/governance-action-services/overview) | [governance-action-connectors :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/governance-action-connectors){ target=gh } | | Configuration Document Store | Persists the configuration document for an OMAG Server. | [Configuration Document Store Connectors](/concepts/configuration-document/#storage) | [configuration-store-connectors :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/configuration-store-connectors){ target=gh } | | Platform Security Connector | Manages service authorization for the OMAG Server Platform. | [Metadata Security Connectors](/features/metadata-security) | [open-metadata-security-samples :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-resources/open-metadata-samples/open-metadata-security-samples){ target=gh } | diff --git a/site/docs/patterns/metadata-governance/engine-action-status.svg b/site/docs/patterns/metadata-governance/engine-action-status.svg index ec092c65b0..1778f66a84 100644 --- a/site/docs/patterns/metadata-governance/engine-action-status.svg +++ b/site/docs/patterns/metadata-governance/engine-action-status.svg @@ -1,4 +1,4 @@ -
APPROVED
APPROVED
REQUESTED
REQUESTED
WAITING
WAITING
ACTIVATING
ACTIVATING
IN_PROGRESS
IN_PROGRESS
ACTIONED
ACTIONED
INVALID
INVALID
IGNORED
IGNORED
FAILED
FAILED
Requested by caller
(directly or via
governance action process) 
Requested by caller...
All conditions (such as mandatory
guards defined by a
governance action process)
have been satisfied
All conditions (such as mandatory...
Waiting for start time,
or an Engine Host to pick it up
Waiting for start time,...
Claimed by an Engine
Host, which is starting
up the governance service.
Claimed by an Engine...
Governance service
running in the
Engine Host
Governance service...
Successfully completed.
Successfully completed.
No action taken by
the governance service
since it was
started unnecessarily
(false positive).
No action taken by...
The governance service
was unable to complete
its requested action.
The governance service...
(Guards stored in governance action)
(Guards stored in governance action)Text is not SVG - cannot display \ No newline at end of file +
APPROVED
REQUESTED
WAITING
ACTIVATING
IN_PROGRESS
ACTIONED
INVALID
IGNORED
FAILED
Requested by caller
(directly or via
governance action process) 
All conditions (such as mandatory
guards defined by a
governance action process)
have been satisfied
Waiting for start time,
or an Engine Host to pick it up
Claimed by an Engine
Host, which is starting
up the governance service.
Governance service
running in the
Engine Host
Successfully completed.
No action taken by
the governance
service since it was
started unnecessarily
(false positive).
The governance
service was
unable to complete
its requested action.
(Guards stored in engine action)
CANCELLED
The governance
service was
cancelled by
an external user.
 \ No newline at end of file diff --git a/site/docs/patterns/metadata-governance/governance-engines.md b/site/docs/patterns/metadata-governance/governance-engines.md index 4505f13937..1d075e3a42 100644 --- a/site/docs/patterns/metadata-governance/governance-engines.md +++ b/site/docs/patterns/metadata-governance/governance-engines.md @@ -55,7 +55,7 @@ A governance action process can be run many times with different parameters. It If a desired request type can not be supported by the existing governance services, a developer is asked to extend a governance service implementation or create a new one that can be configured into a governance engine to support the desired governance request type. ??? example "Governance services supplied with Egeria" - * [Governance Action Services](/connectors/#governance-action-services) - * [Open Discovery Services](/connectors/#open-discovery-services) - * [Repository Governance Services](/connectors/#repository-governance-services) + * [Governance Action Services](/concepts/governance-action-service) + * [Survey Action Services](/concept/survey-action-service) + * [Repository Governance Services](/concepts/repository-governance-service) diff --git a/site/docs/patterns/metadata-governance/metadata-governance.drawio b/site/docs/patterns/metadata-governance/metadata-governance.drawio index 7370a8f9cc..8c5bc5590c 100644 --- a/site/docs/patterns/metadata-governance/metadata-governance.drawio +++ b/site/docs/patterns/metadata-governance/metadata-governance.drawio @@ -1,6 +1,6 @@ - + - + @@ -3325,7 +3325,7 @@ - + @@ -3362,59 +3362,70 @@ - + - + - + - + - + - + - - + + - - + + - + - - + + - - + + - - + + - + + + + + + + + + + + + diff --git a/site/docs/release-notes/february-2023.md b/site/docs/release-notes/february-2023.md index 84532d7bc4..662f054c0d 100644 --- a/site/docs/release-notes/february-2023.md +++ b/site/docs/release-notes/february-2023.md @@ -77,7 +77,7 @@ This webinar takes you through Tom's journey to set up and operate Coco Pharmace * Presenters: Mandy Chessell and Dan Wolfson * Time: 15:00 UTC -* [Zoom Conference Link](https://zoom.us/j/523629111) +* [Zoom Conference Link](https://zoom-lfx.platform.linuxfoundation.org/meeting/92563720721?password=6812f50c-c1a6-4d07-ad6d-7aa63e793285) ### Community meetings diff --git a/site/docs/services/omas/index.md b/site/docs/services/omas/index.md index 0bf80c0eb4..24b206bf97 100644 --- a/site/docs/services/omas/index.md +++ b/site/docs/services/omas/index.md @@ -22,13 +22,13 @@ The access services are as follows: | [Data Engine](/services/omas/data-engine/overview) | The Data Engine OMAS provides APIs and events for a data movement/processing engine to record the changes it is making the the data landscape. This information forms a key part of asset lineage. | [Data Engine Proxy Services](/services/data-engine-proxy-services) | | [Data Manager](/services/omas/data-manager/overview) | The Data Manager OMAS provides an integration point to enable technologies that manage collections of data such as database servers, file systems, file managers and content managers to publish metadata to the metadata repositories about the changing structures and content stored in the data platform. It is typically called from the [Database Integrator OMIS](/services/omis/database-integrator/overview) and [Files Integrator OMIS](/services/omis/files-integrator/overview) integration services. | [API Integrator OMIS](/services/omis/api-integrator/overview), [Database Integrator OMIS](/services/omis/database-integrator/overview), [Display Integrator OMIS](/services/omis/display-integrator/overview), [Files Integrator OMIS](/services/omis/files-integrator/overview), [Topic Integrator OMIS](/services/omis/topic-integrator/overview) | | [Data Privacy](/services/omas/data-privacy/overview) | The Data Privacy OMAS supports a privacy officer as they manage data privacy in their organization. This includes managing privacy impact assessments and reviews of software services that use personal data as they move through their development, deployment and use. | | -| [Data Science](/services/omas/data-science/overview) | The Data Science OMAS provides access to metadata for data assets, connections and projects, plus the ability to maintain metadata about data science notebooks and models and log activity during the analytics development process. It is designed for data science and analytics management tools. | [Analytics Integrator OMIS](/services/omis/analytics-integrator/overview), [Event Action OMES](/services/omes/event-action/overview) | +| [Data Science](/services/omas/data-science/overview) | The Data Science OMAS provides access to metadata for data assets, connections and projects, plus the ability to maintain metadata about data science notebooks and models and log activity during the analytics development process. It is designed for data science and analytics management tools. | [Analytics Integrator OMIS](/services/omis/analytics-integrator/overview) | | [Design Model](/services/omas/design-model/overview) | The Design Model OMAS provides the ability to manage information from all types of design models. These models may come from tools or be part of a packaged standard. This content is useful for governance, system integration and software development. | | | [DevOps](/services/omas/dev-ops/overview) | The DevOps OMAS provides services for a DevOps pipeline to query and maintain metadata about systems, processes and software components that are being deployed into the information landscape. | | | [Digital Architecture](/services/omas/digital-architecture/overview) | The Digital Architecture OMAS provides the ability to define information standards, definitions, solution blueprints and models for an organization. It is designed for architecture tools. It is able to support the definition and management of a digital service through concept to deployment. | | | [Digital Service](/services/omas/digital-service/overview) | The Digital Service OMAS provides services for a managing the lifecycle of an Egeria Digital Service. | [Collection Manager OMVS](/services/omvs/collection-manager/overview) | | [Discovery Engine](/services/omas/discovery-engine/overview) | The Discovery Engine OMAS provides an API for a discovery engine to access and store metadata from an open metadata repository (or open metadata repository cohort). | [Asset Analysis OMES](/services/omes/asset-analysis/overview) | -| [Governance Engine](/services/omas/governance-engine/overview) | The Governance Engine OMAS provides APIs and events that retrieve and manage metadata for [governance action services](/concepts/governance-action-service). | [Governance Action OMES](/services/omes/governance-action/overview) | +| [Governance Engine](/services/omas/governance-engine/overview) | The Governance Engine OMAS provides APIs and events that retrieve and manage metadata for [governance action services](/concepts/governance-action-service). | [Governance Action OMES](/services/omes/governance-action/overview), [Event Action OMES](/services/omes/event-action/overview) | | [Governance Program](/services/omas/governance-program/overview) | The Governance Program OMAS provides the ability to maintain a governance program in the open metadata repositories. It is designed for governance and CDO tools. | | | [Governance Server](/services/omas/governance-server/overview) | The Governance Server OMAS supplies the [governance engine definitions](/concepts/governance-engine-definition) to the [engine hosts](/concepts/engine-host) and the and [integration group definitions](/concepts/integration-group) to the [integration daemons](/concepts/integration-daemon). | [Integration Daemon Services](/services/integration-daemon-services), [Engine Host Services](/services/engine-host-services) | | [IT Infrastructure](/services/omas/it-infrastructure/overview) | The IT Infrastructure OMAS provides support for the design and planning of the information infrastructure that supports the data assets. This includes the development of system blueprints that link down to the metadata about real infrastructure components. This metadata helps in the linkage between information governance metadata and IT infrastructure management (ITIL) metadata typically stored in a Configuration Management Database (CMDB). | [Infrastructure Integrator OMIS](/services/omis/infrastructure-integrator/overview) | diff --git a/site/docs/services/omes/event-action/overview.md b/site/docs/services/omes/event-action/overview.md index 17b27cfea0..de5dd6016e 100644 --- a/site/docs/services/omes/event-action/overview.md +++ b/site/docs/services/omes/event-action/overview.md @@ -20,6 +20,6 @@ An event action engine hosts specialized governance services called [event actio The Event Action OMES is capable of hosting one or more [event action engines](/concepts/event-action-engine). -The event action engine services call the [Stewardship Action Open Metadata Access Service (OMAS)](/services/omas/stewardship-action/overview) running in an open metadata server to retrieve information about events and to store the results of the event action services' work. +The event action engine services call the [Governance Engine Open Metadata Access Service (OMAS)](/services/omas/governance-engine/overview) running in an open metadata server to retrieve information about events and to store the results of the event action services' work. --8<-- "snippets/abbr.md" diff --git a/site/docs/services/omvs/automated-curation/overview.md b/site/docs/services/omvs/automated-curation/overview.md index d069cde3f4..9bf8f11754 100644 --- a/site/docs/services/omvs/automated-curation/overview.md +++ b/site/docs/services/omvs/automated-curation/overview.md @@ -15,8 +15,12 @@ The Automated Curation OMVS provides services that can be used to set up and mon * Retrieving information about [deployed_implementation types](/concepts/deployed-implementation-type) with their linked templates and resources. * Setting up [integration connectors](/concepts/integration-connector) in an [Integration Daemon](/concepts/integration-daemon). * Setting up [governance engines](/concepts/governance-engine) for an [Engine Host](/concepts/engine-host). -* Setting up [governance action process](/concepts/governance-action-process) definitions -* Initiating governance action processes and [engine actions](/concepts/engine-action). -* Monitor the outcomes of governance action processes and engine actions. +* Setting up [governance action type](/concepts/governance-action-type) definitions. +* Setting up [governance action process](/concepts/governance-action-process) definitions. +* Initiating governance action types, governance action processes and [engine actions](/concepts/engine-action). +* Monitor the outcomes of engine actions. + +It uses the [Asset Owner OMAS](/services/omas/asset-owner/overview) for its metadata services. + --8<-- "snippets/abbr.md" diff --git a/site/docs/types/4/0424-Governance-Zones.md b/site/docs/types/4/0424-Governance-Zones.md index 974b2c5551..3fe0ba99e2 100644 --- a/site/docs/types/4/0424-Governance-Zones.md +++ b/site/docs/types/4/0424-Governance-Zones.md @@ -8,7 +8,7 @@ hide: # 0424 Governance Zones -A **GovernanceZone** describes a collection of Assets that are used, or processed in a specific way. +A **GovernanceZone** entity describes a collection of Assets that are used, or processed in a specific way. The governance zone definitions define the governance zones in use in the organization and how they are used. It is possible to then attach governance policies and controls to the zone definitions using the [GovernedBy](0401-Governance-Definitions.md) relationship to show how assets assigned diff --git a/site/docs/types/4/0463-Engine-Actions.md b/site/docs/types/4/0463-Engine-Actions.md index 4395f0e429..94ecbf0318 100644 --- a/site/docs/types/4/0463-Engine-Actions.md +++ b/site/docs/types/4/0463-Engine-Actions.md @@ -3,7 +3,7 @@ # 0463 Engine Actions -An [Engine action](/concepts/engine-action) describes some processing that is part of the governance of an organization's asset or the metadata that describes them. +An [Engine action](/concepts/engine-action) describes some processing that is part of the governance of an organization's assets or the metadata that describes them. ![UML](0463-Engine-Actions.svg) @@ -25,18 +25,19 @@ The *EngineActionRequestSource* relationship links the first *EngineAction* enti The *EngineActionStatus* indicates the execution status of the governance action. -| Enumeration | Value | Name | Description | -| --- | --- | --- |-----------------------------------------------------------------------------------------------------| -| REQUESTED | 0 | Requested | The governance action has been created and is pending. | -| APPROVED | 1 | Approved | The governance action is approved to run. | -| WAITING | 2 | Waiting | The governance action is waiting for its start time or the right conditions to run. | -| ACTIVATING | 3 | Activating | The governance service for the governance action is being initialized in the governance engine. | -| IN_PROGRESS | 4 | In Progress| The governance engine is running the associated governance service for the governance action. | -| ACTIONED | 10 | Actioned | The governance service for the governance action has successfully completed processing. | -| INVALID | 11 | Invalid | The governance action has not been run because it is not appropriate (for example, a false positive). | -| IGNORED | 12 | Ignored | The governance action has not been run because a different governance action was chosen. | -| FAILED | 13 | Failed | The governance action service for the governance action failed to execute. | -| OTHER | 99 | Other | Undefined or unknown governance action status. | +| Enumeration | Value | Name | Description | +|-------------|-------|-------------|-------------------------------------------------------------------------------------------------------| +| REQUESTED | 0 | Requested | The engine action has been created and is pending. | +| APPROVED | 1 | Approved | The engine action is approved to run. This means all of the manatory guards have been satisfied. | +| WAITING | 2 | Waiting | The engine action is waiting for its start time or the right conditions to run. | +| ACTIVATING | 3 | Activating | The governance service for the engine action is being initialized in the governance engine. | +| IN_PROGRESS | 4 | In Progress | The governance engine is running the associated governance service for the engine action. | +| ACTIONED | 10 | Actioned | The governance service for the engine action has successfully completed processing. | +| INVALID | 11 | Invalid | The governance engine has not been run because it is not appropriate (for example, a false positive). | +| IGNORED | 12 | Ignored | The governance action has not been run because a different governance action was chosen. | +| FAILED | 13 | Failed | The governance service for the engine action failed to execute. | +| CANCELLED | 14 | Cancelled | The engine action was cancelled by an external caller. | +| OTHER | 99 | Other | Undefined or unknown governance action status. | ## NextEngineAction relationship diff --git a/site/docs/types/4/0463-Engine-Actions.svg b/site/docs/types/4/0463-Engine-Actions.svg index 97eadfd301..2e9e5ddc5b 100644 --- a/site/docs/types/4/0463-Engine-Actions.svg +++ b/site/docs/types/4/0463-Engine-Actions.svg @@ -1,4 +1,4 @@ -
0463 - Engine Actions
0463 - Engine Actions
domainIdentifier : int
displayName : string
description : string
requestType : string
requestParameters : map<string, string>
executorEngineGUID : string
executorEngineName : string
governanceActionTypeGUID : string
governanceActionTypeName : string
processName : string
processStepGUID : string
processStepName : string
mandatoryGuards : array<string>
receivedGuards : array<string>
actionStatus : EngineActionStatus
startDate : date
processingEngineUserId : string
completionDate : date
completionGuards : array<string>
completionMessage: string
domainIdentifier : int...
*
*
actionTargetName : string
status : EngineActionStatus
startDate : date
completionDate : date
completionMessage : string
actionTargetName : string...
identifiedInEngineActions
identifiedInEngin...
«entity»
Referenceable
«entity»...
actionTarget
actionTarget
*
*
*
*
previousActions
previousActions
followOnActions
followOnActions
«entity»
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20style%3D%22edgeStyle%3DorthogonalEdgeStyle%3Brounded%3D0%3Bhtml%3D1%3BexitX%3D1%3BexitY%3D0.5%3BexitDx%3D0%3BexitDy%3D0%3BentryX%3D0%3BentryY%3D0.5%3BentryDx%3D0%3BentryDy%3D0%3BjettySize%3Dauto%3BorthogonalLoop%3D1%3BendArrow%3Dnone%3BendFill%3D0%3B%22%20edge%3D%221%22%20source%3D%223%22%20parent%3D%221%22%3E%3CmxGeometry%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22684%22%20y%3D%22384.5%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%223%22%20value%3D%22%C2%ABentity%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BRequestForAction%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%2291%22%20y%3D%22379%22%20width%3D%22249%22%20height%3D%2250%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%224%22%20value%3D%22%26lt%3Bspan%26gt%3BdiscoveryActivity%20%3A%20string%26lt%3Bbr%26gt%3B%26lt%3B%2Fspan%26gt%3B%26lt%3Bspan%26gt%3BactionRequested%20%3A%20string%26lt%3B%2Fspan%26gt%3B%26lt%3Bbr%26gt%3B%26lt%3Bspan%26gt%3BactionProperties%20%3A%20map%26amp%3Blt%3Bstring%2C%20string%26amp%3Bgt%3B%26lt%3Bbr%26gt%3B%26lt%3B%2Fspan%26gt%3B%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dleft%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%2292%22%20y%3D%22429%22%20width%3D%22247%22%20height%3D%2259%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%225%22%20value%3D%22%22%20style%3D%22edgeStyle%3DorthogonalEdgeStyle%3Brounded%3D0%3Bhtml%3D1%3BendArrow%3Dnone%3BendFill%3D0%3BjettySize%3Dauto%3BorthogonalLoop%3D1%3BexitX%3D0%3BexitY%3D0.5%3B%22%20edge%3D%221%22%20source%3D%227%22%20target%3D%223%22%20parent%3D%221%22%3E%3CmxGeometry%20relative%3D%221%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%226%22%20value%3D%22%C2%ABentity%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BDataFieldAnnotation%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22136.5%22%20y%3D%22257.5%22%20width%3D%22160%22%20height%3D%2250%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%227%22%20value%3D%22%22%20style%3D%22triangle%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dcenter%3Brotation%3D-90%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22207.5%22%20y%3D%22305.5%22%20width%3D%2217%22%20height%3D%2221%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%228%22%20value%3D%22%22%20style%3D%22endArrow%3Dnone%3Bdashed%3D1%3Bhtml%3D1%3BentryX%3D1%3BentryY%3D0.5%3BentryDx%3D0%3BentryDy%3D0%3B%22%20edge%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22638%22%20y%3D%22234%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22567.5%22%20y%3D%22234%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%229%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22636.5%22%20y%3D%22325.5%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2210%22%20value%3D%22identifiedActions%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22543%22%20y%3D%22325.5%22%20width%3D%22104%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2211%22%20value%3D%22discoveryActivity%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22341.5%22%20y%3D%22381.5%22%20width%3D%22106%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2212%22%20value%3D%22requestForAction%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22571%22%20y%3D%22384%22%20width%3D%22113%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2213%22%20value%3D%22%C2%ABrelationship%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BDiscoveryActivity%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22393.5%22%20y%3D%22486%22%20width%3D%22206%22%20height%3D%2253%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2214%22%20value%3D%22%22%20style%3D%22endArrow%3Dnone%3Bdashed%3D1%3Bhtml%3D1%3B%22%20edge%3D%221%22%20target%3D%2213%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22496%22%20y%3D%22407%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22543.5%22%20y%3D%22515%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2215%22%20value%3D%22description%20%3A%20string%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dleft%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22393.5%22%20y%3D%22538.5%22%20width%3D%22206%22%20height%3D%2231%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2216%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22643.5%22%20y%3D%22361.5%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2217%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22341.5%22%20y%3D%22405%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3EngineAction
«entity»...
«relationship»
NextEngineAction
«relationship»...
«relationship»
TargetForAction
«relationship»...
«enumeration»
EngineActionStatus
«enumeration»...
REQUESTED = 0
APPROVED = 1
WAITING = 2
ACTIVATING = 3
IN_PROGRESS = 4
ACTIONED = 10
INVALID = 11
IGNORED = 12
FAILED = 13
OTHER = 99
REQUESTED = 0...
*
*
identifiedActions
identifiedActions
sourceActivity
sourceActivity
originGovernanceService : string
originGovernanceEngine : string
requestSourceName : string
originGovernanceService : string...
*
*
«relationship»
EngineActionRequestSource
«relationship»...
«entity»
OpenMetadataRoot
«entity»...
guard : string
mandatoryGuard : boolean
guard : string...
*
*
«entity»
Action
«entity»...Text is not SVG - cannot display \ No newline at end of file +
0463 - Engine Actions
domainIdentifier : int
displayName : string
description : string
requestType : string
requestParameters : map<string, string>
executorEngineGUID : string
executorEngineName : string
governanceActionTypeGUID : string
governanceActionTypeName : string
processName : string
processStepGUID : string
processStepName : string
mandatoryGuards : array<string>
receivedGuards : array<string>
actionStatus : EngineActionStatus
startDate : date
processingEngineUserId : string
completionDate : date
completionGuards : array<string>
completionMessage: string
*
actionTargetName : string
status : EngineActionStatus
startDate : date
completionDate : date
completionMessage : string
identifiedInEngineActions
«entity»
Referenceable
actionTarget
*
*
previousActions
followOnActions
«entity»
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20style%3D%22edgeStyle%3DorthogonalEdgeStyle%3Brounded%3D0%3Bhtml%3D1%3BexitX%3D1%3BexitY%3D0.5%3BexitDx%3D0%3BexitDy%3D0%3BentryX%3D0%3BentryY%3D0.5%3BentryDx%3D0%3BentryDy%3D0%3BjettySize%3Dauto%3BorthogonalLoop%3D1%3BendArrow%3Dnone%3BendFill%3D0%3B%22%20edge%3D%221%22%20source%3D%223%22%20parent%3D%221%22%3E%3CmxGeometry%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22684%22%20y%3D%22384.5%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%223%22%20value%3D%22%C2%ABentity%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BRequestForAction%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%2291%22%20y%3D%22379%22%20width%3D%22249%22%20height%3D%2250%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%224%22%20value%3D%22%26lt%3Bspan%26gt%3BdiscoveryActivity%20%3A%20string%26lt%3Bbr%26gt%3B%26lt%3B%2Fspan%26gt%3B%26lt%3Bspan%26gt%3BactionRequested%20%3A%20string%26lt%3B%2Fspan%26gt%3B%26lt%3Bbr%26gt%3B%26lt%3Bspan%26gt%3BactionProperties%20%3A%20map%26amp%3Blt%3Bstring%2C%20string%26amp%3Bgt%3B%26lt%3Bbr%26gt%3B%26lt%3B%2Fspan%26gt%3B%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dleft%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%2292%22%20y%3D%22429%22%20width%3D%22247%22%20height%3D%2259%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%225%22%20value%3D%22%22%20style%3D%22edgeStyle%3DorthogonalEdgeStyle%3Brounded%3D0%3Bhtml%3D1%3BendArrow%3Dnone%3BendFill%3D0%3BjettySize%3Dauto%3BorthogonalLoop%3D1%3BexitX%3D0%3BexitY%3D0.5%3B%22%20edge%3D%221%22%20source%3D%227%22%20target%3D%223%22%20parent%3D%221%22%3E%3CmxGeometry%20relative%3D%221%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%226%22%20value%3D%22%C2%ABentity%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BDataFieldAnnotation%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22136.5%22%20y%3D%22257.5%22%20width%3D%22160%22%20height%3D%2250%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%227%22%20value%3D%22%22%20style%3D%22triangle%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dcenter%3Brotation%3D-90%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22207.5%22%20y%3D%22305.5%22%20width%3D%2217%22%20height%3D%2221%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%228%22%20value%3D%22%22%20style%3D%22endArrow%3Dnone%3Bdashed%3D1%3Bhtml%3D1%3BentryX%3D1%3BentryY%3D0.5%3BentryDx%3D0%3BentryDy%3D0%3B%22%20edge%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22638%22%20y%3D%22234%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22567.5%22%20y%3D%22234%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%229%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22636.5%22%20y%3D%22325.5%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2210%22%20value%3D%22identifiedActions%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22543%22%20y%3D%22325.5%22%20width%3D%22104%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2211%22%20value%3D%22discoveryActivity%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22341.5%22%20y%3D%22381.5%22%20width%3D%22106%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2212%22%20value%3D%22requestForAction%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22571%22%20y%3D%22384%22%20width%3D%22113%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2213%22%20value%3D%22%C2%ABrelationship%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BDiscoveryActivity%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22393.5%22%20y%3D%22486%22%20width%3D%22206%22%20height%3D%2253%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2214%22%20value%3D%22%22%20style%3D%22endArrow%3Dnone%3Bdashed%3D1%3Bhtml%3D1%3B%22%20edge%3D%221%22%20target%3D%2213%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22496%22%20y%3D%22407%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22543.5%22%20y%3D%22515%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2215%22%20value%3D%22description%20%3A%20string%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dleft%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22393.5%22%20y%3D%22538.5%22%20width%3D%22206%22%20height%3D%2231%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2216%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22643.5%22%20y%3D%22361.5%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2217%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22341.5%22%20y%3D%22405%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3EngineAction
«relationship»
NextEngineAction
«relationship»
TargetForAction
«enumeration»
EngineActionStatus
REQUESTED = 0
APPROVED = 1
WAITING = 2
ACTIVATING = 3
IN_PROGRESS = 4
ACTIONED = 10
INVALID = 11
IGNORED = 12
FAILED = 13
CANCELLED = 14
OTHER = 99
*
identifiedActions
sourceActivity
originGovernanceService : string
originGovernanceEngine : string
requestSourceName : string
*
«relationship»
EngineActionRequestSource
«entity»
OpenMetadataRoot
guard : string
mandatoryGuard : boolean
*
«entity»
Action
 \ No newline at end of file diff --git a/site/docs/types/4/area-4-governance.drawio b/site/docs/types/4/area-4-governance.drawio index bab64069bf..567ffb9ebe 100644 --- a/site/docs/types/4/area-4-governance.drawio +++ b/site/docs/types/4/area-4-governance.drawio @@ -1,6 +1,6 @@ - + - + @@ -209,7 +209,7 @@ - + @@ -335,7 +335,7 @@ - + @@ -458,7 +458,7 @@ - + @@ -591,7 +591,7 @@ - + @@ -620,7 +620,7 @@ - + @@ -741,7 +741,7 @@ - + @@ -849,7 +849,7 @@ - + @@ -2734,7 +2734,7 @@ - + @@ -2805,8 +2805,8 @@ - - + + diff --git a/site/mkdocs.yml b/site/mkdocs.yml index 54e69c8a4f..e5dbaa74aa 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -45,18 +45,20 @@ nav: - Files: - Any File: - Read File Contents: connectors/resource/basic-file-resource-connector.md + - Move/Copy File Provisioning: connectors/governance-action/move-copy-file-provisioning-governance-action-service.md - File Folders (directories): - Read Files: connectors/resource/basic-folder-resource-connector.md - Catalog Files: connectors/integration/data-files-monitor-integration-connector.md + - Watch Folders: connectors/governance-action/generic-folder-watchdog-governance-action-service.md - CSV Files: - Read File Contents: connectors/resource/csv-file-resource-connector.md - Data Folders: - - Read files: connectors/resource/data-folder-resource-connector.md - - Monitor files: connectors/integration/data-folder-monitor-integration-connector.md + - Read File Contents: connectors/resource/data-folder-resource-connector.md + - Maintain Last Update: connectors/integration/data-folder-monitor-integration-connector.md - Open Metadata Archive Files: - Read OMArchive Files: connectors/runtime/file-based-open-metadata-archive-store-runtime-connector.md - Relational Databases: - - JDBC DataSource: connectors/resource/jdbc-resource-connector.md + - JDBC DataSource API: connectors/resource/jdbc-resource-connector.md - Catalog JDBC Database: connectors/integration/jdbc-integration-connector.md - Apache Kafka: - JSON Plain Text Events: connectors/resource/kafka-open-metadata-topic-connector.md @@ -71,9 +73,8 @@ nav: - Catalog: connectors/integration/apache-atlas-catalog-integration-connector.md - Governance Actions: - Generic Element Watchdog: connectors/governance-action/generic-element-watchdog-governance-action-service.md - - Generic Folder Watchdog: connectors/governance-action/generic-folder-watchdog-governance-action-service.md - - Move/Copy File Provisioning: connectors/governance-action/move-copy-file-provisioning-governance-action-service.md - - Origin Seeker Remediation: connectors/governance-action/origin-seeker-remediation-governance-action-service.md + - Origin Seeker: connectors/governance-action/origin-seeker-remediation-governance-action-service.md + - Zone Publisher: connectors/governance-action/zone-publisher-governance-action-service.md - Open APIs: - Catalog APIs via Swagger: connectors/integration/open-api-monitor-integration-connector.md - Egeria Infrastructure: diff --git a/site/snippets/admin/configuring-local-server-url.md b/site/snippets/admin/configuring-local-server-url.md deleted file mode 100644 index fd389b1fd7..0000000000 --- a/site/snippets/admin/configuring-local-server-url.md +++ /dev/null @@ -1,17 +0,0 @@ - - - -## Set the server URL root - -Configure the `targetPlatformURLRoot` with the [platform URL Root](/concepts/omag-server/#platform-url-root) value of where the OMAG Server Platform will run. -This may not be the same as `platformURLRoot` if the configuration document will be deployed to a different OMAG Server Platform from the one used to maintain it. - -!!! post "POST - set server URL root" - ``` - {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-url-root?url={{targetPlatformURLRoot}} - ``` - -??? question "What is the difference between {{platformURLRoot}} and {{targetPlatformURLRoot}}?" - The `{{targetPlatformURLRoot}}` gives the location of the OMAG Server Platform on which this configured service is intended to run, while the `{{platformURLRoot}}` gives the location of the OMAG Server Platform in which this configuration document is maintained. - - They could be, but do not need to be, the same location. diff --git a/site/snippets/admin/configuring-omag-server-basic-properties.md b/site/snippets/admin/configuring-omag-server-basic-properties.md index 0de5b4aa90..8e5e7339c0 100644 --- a/site/snippets/admin/configuring-omag-server-basic-properties.md +++ b/site/snippets/admin/configuring-omag-server-basic-properties.md @@ -5,14 +5,14 @@ The basic server properties are used in logging and events originating from the server. They help to document the purpose of the server (which helps with problem determination) and enable performance improvements by allowing the server to ignore activity or metadata that is not relevant to its operation. -| Property | Description | -|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| *localServerDescription* | Description for the server. This is useful information for the administrator to understand the role of the server. The default value is `null`. | -| *organizationName* | Descriptive name for the organization that owns the local server/repository. This is useful when the open metadata repository cluster consists of metadata servers from different organizations, or different departments of an enterprise. The default value is `null`. | -| *localServerUserId* | UserId to use for server-initiated REST calls. The default is `OMAGServer`. | -| *localServerPassword* | Password to use for server-initiated REST calls. The default is `null`. This means that only the userId is sent in the HTTP header. | -| *localServerType* | Descriptive type name for the server. Again this is useful information for the administrator to understand the role of the server. The default value is `null` which means that the [server operation services](/services/server-operations) will populate it automatically based on the services that are configured for the server. | -| *maxPageSize* | The maximum page size that can be set on requests to the server. The default value is `1000`. A value of zero means unlimited page size. Although supported, the zero value is not recommended because it provides no protection from a large request denial of service attack. | +| Property | Description | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| *localServerDescription* | Description for the server. This is useful information for the administrator to understand the role of the server. The default value is `null`. | +| *organizationName* | Descriptive name for the organization that owns the local server/repository. This is useful when the open metadata repository cluster consists of metadata servers from different organizations, or different departments of an enterprise. The default value is `null`. | +| *localServerUserId* | UserId to use for server-initiated REST calls. The default is `OMAGServer`. | +| *localServerPassword* | Password to use for server-initiated REST calls. The default is `null`. This means that only the userId is sent in the HTTP header. | +| *localServerURL* | The URL of the platform where the server is to be deployed. It should be the value used by external services to call the server since its broadcast across an [open metadata repository cohort](/concepts/cohort-member) and used when deploying the server's configuration document to the correct platform. | +| *maxPageSize* | The maximum page size that can be set on requests to the server. The default value is `1000`. A value of zero means unlimited page size. Although supported, the zero value is not recommended because it provides no protection from a large request denial of service attack. | Typically, these values are set up in a single command. @@ -44,6 +44,18 @@ Alternatively, you can set these properties one at a time. POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-user-password?password="{{serverUserPassword}}" ``` +??? post "setServerURLRoot" + Configure the `targetPlatformURLRoot` with the [platform URL Root](/concepts/omag-server/#platform-url-root) value of where the OMAG Server Platform will run. + This may not be the same as `platformURLRoot` if the configuration document will be deployed to a different OMAG Server Platform from the one used to maintain it. + ``` + POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-url-root?url={{targetPlatformURLRoot}} + ``` + + ??? question "What is the difference between {{platformURLRoot}} and {{targetPlatformURLRoot}}?" + The `{{targetPlatformURLRoot}}` gives the location of the OMAG Server Platform on which this configured service is intended to run, while the `{{platformURLRoot}}` gives the location of the OMAG Server Platform in which this configuration document is maintained. + + They could be, but do not need to be, the same location. + ??? post "setMaxPageSize" The maximum page size value sets an upper limit on the number of results that a caller can request on any paging REST API to this server. Setting maximum page size helps to prevent a denial of service attack that uses very large requests to overwhelm the server. A value of `0` means no limit, and leaves the server open to such attacks. ``` diff --git a/site/snippets/admin/configuring-the-local-repository.md b/site/snippets/admin/configuring-the-local-repository.md index 866c73f457..c103c1ea52 100644 --- a/site/snippets/admin/configuring-the-local-repository.md +++ b/site/snippets/admin/configuring-the-local-repository.md @@ -3,7 +3,7 @@ ## Configure the native repository connector -A [metadata access store](/concepts/metadata-access-store) supports a metadata repository that has native support for the [open metadata types and instances](/types). This is enabled by adding a native metadata repository connector to the server's configuration document. +A [Metadata Access Store](/concepts/metadata-access-store) supports a metadata repository that has native support for the [open metadata types and instances](/types). This is enabled by adding a native metadata repository connector to the server's configuration document. ### Add a repository connector implementation @@ -15,53 +15,69 @@ Egeria provides a number of implementations of such a repository -- only one of This native metadata repository is currently the [highest-performing, most fully-functional repository](/connectors/repository/xtdb/performance) for Egeria, supporting all metadata operations including historical metadata as well as being [highly-available through clustered deployment](/connectors/repository/xtdb/#high-availability). - !!! post "POST - enable the bi-temporal graph repository" + !!! post "Enable the bi-temporal graph repository (XTDB)" + This in memory version of the XTDB repository is designed for testing. + ``` - {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository/mode/plugin-repository/connection + POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository/mode/xtdb-in-memory-repository ``` - ```json - { - "class": "Connection", - "connectorType": { - "class": "ConnectorType", - "connectorProviderClassName": "org.odpi.egeria.connectors.juxt.xtdb.repositoryconnector.XtdbOMRSRepositoryConnectorProvider" - } - } + This command sets up XTDB with RocksDB KV store to provide a local high performance historical metadata repository. It only supports one instance of the server ans so can not be used in a horizontal scale-out HA deployment + ``` + POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository/mode/xtdb-local-kv-repository + ``` + + This command allows you to specify different XTDB back ends so it can be run in a HA context with multiple versions of the same server deployed to the same repository. ``` + POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository/mode/xtdb-local-repository + ``` + The request body is a map of property names to values that are passed directly to XTDB when the sever starts up. + + ??? info "For Egeria releases before version 5.0 ... + The XTDB connector is located in its own git repository [egeria-connector-xtdb.git](https://github.com/odpi/egeria-connector-xtdb). The JAR file needs to be built from this repository and placed the OMAG Server Platform's class path. It is configured in the Metadata Access Store using the follwoing command: + ``` + POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository/mode/plugin-repository/connection + ``` + + ```json + { + "class": "Connection", + "connectorType": { + "class": "ConnectorType", + "connectorProviderClassName": "org.odpi.egeria.connectors.juxt.xtdb.repositoryconnector.XtdbOMRSRepositoryConnectorProvider" + } + } + ``` !!! attention "May require additional driver libraries" Note that depending on the persistence you configure, you may need to [obtain additional driver libraries for your back-end service](/connectors/repository/xtdb/#pluggable-persistence), as not every driver is embedded in the XTDB connector itself. === "non-temporal graph" - This command enables a JanusGraph-based native metadata repository that is embedded in the metadata server - and uses the local disk to store the metadata, but does not manage any historical metadata. + This command enables a JanusGraph-based native metadata repository that is embedded in the metadata server. + This repository does not maintain historical versions of metadata. - !!! post "POST - enable the graph repository" + !!! post "Enable the JanusGraph repository" ``` - {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository/mode/local-graph-repository + POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository/mode/local-graph-repository ``` + + If no request body is used, metadata will be stored on the local disk. It is possible to pass a set of storage properties to JanusGraph to enalbe it to use a different persistance service. However, the repository uses local transactions and is does not support multiple instances of the same server/repository to be active at one time. === "in-memory" The in-memory native repository maintains an in-memory store of metadata. It is useful for demos and testing. - No metadata is kept if the metadata access server is shutdown. It should not be used in a production environment. + No metadata is kept if the Metadata Access Server is shutdown. It should not be used in a production environment. - !!! post "POST - enable the in-memory repository" + !!! post "Enable the in-memory repository" ``` - {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository/mode/in-memory-repository + POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository/mode/in-memory-repository ``` === "read-only" - The read-only native repository connector provides a compliant implementation of a local - repository that can be configured into a metadata server. - It does not support the interfaces for create, update, delete. - However, it does support the search interfaces and is able to cache metadata. - - This means it can be loaded with metadata from an [open metadata archive](/concepts/open-metadata-archive) - and connected to a cohort. + The read-only native repository connector provides a compliant implementation of a local repository that can be configured into a Metadata Access Store. It does not support the interfaces for create, update, delete. + However, it does support the search interfaces and is able to cache metadata. This means it can be loaded with metadata from an [open metadata archive](/concepts/open-metadata-archive) and connected to a cohort. The content from the archive will be shared with other members of the cohort. !!! post "POST - enable the read-only repository" @@ -73,7 +89,7 @@ Egeria provides a number of implementations of such a repository -- only one of This command removes all configuration for the local repository. This includes the [local metadata collection id](/services/omrs/metdata-repositories/#metadata-collection-id). If a new local repository is added, it will have a new local metadata collection id and will not be able to automatically re-register with its cohort(s). -!!! delete "DELETE - remove the local repository" +!!! delete "Remove the local repository" ``` - {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository + DELETE {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/local-repository ```