From 9a65cd510bbe8a325b852a73a2ca36f340d494fc Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Sun, 3 Mar 2024 09:51:40 +0000 Subject: [PATCH] Updates to V5.0 release notes and supporting pages. Signed-off-by: Mandy Chessell --- .../governance-action-process-lifecycle.svg | 4 +- .../governance-action-processes.drawio | 1475 +++++++++++++++++ site/docs/concepts/governance-engines.drawio | 465 +----- site/docs/concepts/index.md | 1 + site/docs/concepts/request-for-action.md | 10 + ...che-atlas-catalog-integration-connector.md | 1 + .../apache-atlas-rest-connector.md | 1 + .../apache-atlas-survey-action-service.md | 2 +- site/docs/connectors/connector-catalog.drawio | 58 +- ...-provisioning-governance-action-service.md | 8 +- ...one-publisher-governance-action-service.md | 12 +- .../any-file-survey-action-service.svg | 4 + .../any-file-survey-action-survey-report.svg | 4 + .../csv-file-survey-action-service.svg | 4 + .../csv-file-survey-action-survey-report.svg | 4 + .../folder-survey-action-service.svg | 4 + .../folder-survey-action-survey-report.svg | 4 + site/docs/demos/sample-configs.drawio | 72 + site/docs/demos/sample-servers.svg | 4 + site/docs/frameworks/odf/overview.md | 1 - site/docs/frameworks/saf/overview.md | 26 +- .../saf/survey-action-request-for-action.svg | 2 +- site/docs/frameworks/saf/survey-action.drawio | 653 ++++---- .../governance-action-services/overview.md | 2 +- .../operations/kubernetes/charts/overview.md | 2 +- .../operations/kubernetes/charts/server.md | 4 +- .../guides/operations/kubernetes/operator.md | 55 +- .../operations/operate-omag-server-starter.md | 12 +- site/docs/release-notes/5-0.md | 104 +- site/docs/release-notes/5-1.md | 10 +- site/docs/types/1/0130-Projects.md | 4 + site/docs/types/1/0130-Projects.svg | 2 +- site/docs/types/1/0137-Actions.md | 5 +- site/docs/types/1/0137-Actions.svg | 2 +- site/docs/types/1/area-1-collaboration.drawio | 224 +-- .../4/0462-Governance-Action-Processes.md | 7 +- .../4/0462-Governance-Action-Processes.svg | 2 +- site/docs/types/4/area-4-governance.drawio | 82 +- site/docs/types/5/0545-Reference-Data.svg | 2 +- .../types/5/area-5-models-and-schema.drawio | 196 +-- site/docs/types/6/0690-Request-for-Action.md | 16 +- site/docs/types/6/0690-Request-for-Action.svg | 2 +- site/docs/types/6/area-6-discovery.drawio | 48 +- site/mkdocs.yml | 9 +- 44 files changed, 2418 insertions(+), 1191 deletions(-) create mode 100644 site/docs/concepts/governance-action-processes.drawio create mode 100644 site/docs/concepts/request-for-action.md create mode 100644 site/docs/connectors/survey-action/any-file-survey-action-service.svg create mode 100644 site/docs/connectors/survey-action/any-file-survey-action-survey-report.svg create mode 100644 site/docs/connectors/survey-action/csv-file-survey-action-service.svg create mode 100644 site/docs/connectors/survey-action/csv-file-survey-action-survey-report.svg create mode 100644 site/docs/connectors/survey-action/folder-survey-action-service.svg create mode 100644 site/docs/connectors/survey-action/folder-survey-action-survey-report.svg create mode 100644 site/docs/demos/sample-configs.drawio create mode 100644 site/docs/demos/sample-servers.svg diff --git a/site/docs/concepts/governance-action-process-lifecycle.svg b/site/docs/concepts/governance-action-process-lifecycle.svg index 8740f1a6b3..702189bcbc 100644 --- a/site/docs/concepts/governance-action-process-lifecycle.svg +++ b/site/docs/concepts/governance-action-process-lifecycle.svg @@ -1,4 +1,4 @@ - + -
Governance Engine Pack
Governance Engine Pack
Governance Engine Definition
Governance Engine Definition
Defines the governance services and
the governance request types that they map to.
Defines the governance services and...
Governance Service
Java Archive
(JAR) file
Governance Service...
Defines configuration properties, request types,
request parameters, guards,
types of action targets
for each governance service.
Defines configuration properties, request typ...
Governance Action Process Assembly
Governance Action Pr...
Open Metadata Ecosystem
Open Metadata Ecosystem
Initiate governance
action process
Initiate governance...
Governance
Action
Governance...
Engine Host
Engine Host
Governance Service
Governance Serv...
Governance
Professional
Gover...Text is not SVG - cannot display \ No newline at end of file +
Governance Engine Pack
Governance Engine Definition
Defines the governance services and
the governance request types that they map to.
Governance Service
Java Archive
(JAR) file
ConnectorProvider.getConnectorType() documents
configuration properties, request types, request
parameters, guards, types of action targets
for each governance service.
Governance Action Process Assembly
Open Metadata Ecosystem
Initiate governance
action process
Engine
Action
Engine Host
Governance Service
Governance
Team
Implementation of
one or more
governance services.
 \ No newline at end of file diff --git a/site/docs/concepts/governance-action-processes.drawio b/site/docs/concepts/governance-action-processes.drawio new file mode 100644 index 0000000000..245e55a10b --- /dev/null +++ b/site/docs/concepts/governance-action-processes.drawio @@ -0,0 +1,1475 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/concepts/governance-engines.drawio b/site/docs/concepts/governance-engines.drawio index dce5cc56b1..2784eefc26 100644 --- a/site/docs/concepts/governance-engines.drawio +++ b/site/docs/concepts/governance-engines.drawio @@ -1,6 +1,6 @@ - + - + @@ -94,415 +94,8 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -543,13 +136,13 @@ - + - + - - + + @@ -561,7 +154,7 @@ - + @@ -599,7 +192,7 @@ - + @@ -617,14 +210,14 @@ - - + + - + @@ -886,62 +479,62 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/site/docs/concepts/index.md b/site/docs/concepts/index.md index 14ea06840d..f20d44837e 100644 --- a/site/docs/concepts/index.md +++ b/site/docs/concepts/index.md @@ -337,6 +337,7 @@ - [Repository Proxy](/concepts/repository-proxy) - [Repository Services](/services/omrs) - [Repository Validator](/concepts/repository-validator) +- [Request For Action (RfA)](/concepts/request-for-action.md) - [Resource](/concepts/resource) - [ResourceUse](/concepts/resource-use) - [Resource Connector](/concepts/digital-resource-connector) diff --git a/site/docs/concepts/request-for-action.md b/site/docs/concepts/request-for-action.md new file mode 100644 index 0000000000..1f9aad1ca3 --- /dev/null +++ b/site/docs/concepts/request-for-action.md @@ -0,0 +1,10 @@ + + + +# Request for Action + +A Request For Action (RfA) identifies an issue detected by a [Survey Action Service](/concepts/survey-action-service) while it is running. For example, the Survey Action Service may perform a test on some data (such as a quality rule) or discovers an anomaly in the data landscape compared to its metadata. + +The requested action may be an automated [governance action](/concepts/governance-action) or, more typically, requires a steward to resolve. It is not the responsibility of the Survey Action Service to find the means to resolve the issue - it is only responsible for reporting it. + +--8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/connectors/apache-atlas/apache-atlas-catalog-integration-connector.md b/site/docs/connectors/apache-atlas/apache-atlas-catalog-integration-connector.md index a3adcdfd88..ae19ce3afb 100644 --- a/site/docs/connectors/apache-atlas/apache-atlas-catalog-integration-connector.md +++ b/site/docs/connectors/apache-atlas/apache-atlas-catalog-integration-connector.md @@ -11,6 +11,7 @@ - Hosting Server: [Integration Daemon](/concepts/integration-daemon) - Source Module: [apache-atlas-connectors :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/system-connectors/atlas-integration-connector){ target=gh } - Jar File Name: `apache-atlas-connectors.jar` + - Connector Provider Class Name: `org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.ApacheAtlasIntegrationProvider` ## Overview diff --git a/site/docs/connectors/apache-atlas/apache-atlas-rest-connector.md b/site/docs/connectors/apache-atlas/apache-atlas-rest-connector.md index 1ce4f92e40..c9a75dffbe 100644 --- a/site/docs/connectors/apache-atlas/apache-atlas-rest-connector.md +++ b/site/docs/connectors/apache-atlas/apache-atlas-rest-connector.md @@ -9,6 +9,7 @@ - Jar File Name: `apache-atlas-connectors.jar` - Supported Asset Type: [SoftwareServer](/types/0/0040-Software-Servers) - Deployed Implementation Type: *Apache Atlas Server* + - Connector Provider Class Name: `org.odpi.openmetadata.adapters.connectors.apacheatlas.resource.ApacheAtlasRESTProvider` Apache Atlas has a REST API that allows external callers to query and create both types and instances. This connector provides a simple Java API to this REST API. diff --git a/site/docs/connectors/apache-atlas/apache-atlas-survey-action-service.md b/site/docs/connectors/apache-atlas/apache-atlas-survey-action-service.md index 405769c021..58f33c7e14 100644 --- a/site/docs/connectors/apache-atlas/apache-atlas-survey-action-service.md +++ b/site/docs/connectors/apache-atlas/apache-atlas-survey-action-service.md @@ -11,7 +11,7 @@ - Hosting Server: [Engine Host](/concepts/engine-host) - Source Module: [apache-atlas-connectors :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/system-connectors/apache-atlas-connectors){ target=gh } - Jar File Name: `apache-atlas-connectors.jar` - - Connector Provider Class Name: `org.odpi.openmetadata.adapters.connectors.appacheatlas.survey.SurveyApacheAtlasProvider` + - Connector Provider Class Name: `org.odpi.openmetadata.adapters.connectors.apacheatlas.survey.SurveyApacheAtlasProvider` ## Overview diff --git a/site/docs/connectors/connector-catalog.drawio b/site/docs/connectors/connector-catalog.drawio index c3434bec4b..faf2bc3d18 100644 --- a/site/docs/connectors/connector-catalog.drawio +++ b/site/docs/connectors/connector-catalog.drawio @@ -1,6 +1,6 @@ - + - + @@ -3057,7 +3057,7 @@ - + @@ -3746,7 +3746,7 @@ - + @@ -4199,6 +4199,15 @@ + + + + + + + + + @@ -4209,15 +4218,15 @@ - + - - + + @@ -4225,7 +4234,7 @@ - + @@ -4233,7 +4242,7 @@ - + @@ -4241,7 +4250,7 @@ - + @@ -4249,7 +4258,7 @@ - + @@ -4257,7 +4266,7 @@ - + @@ -4265,10 +4274,31 @@ - + - + + + + + + + + + + + + + + + + + + + + + + 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 d317f381cb..0bcf713e8c 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 @@ -83,18 +83,15 @@ may be triggered. ## Configuration 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. - **targetFileNamePattern** - pattern to construct the name of the destination file. If this is not set, the source file name is used. - **noLineage** - if this property is set to any value, do not produce lineage as part of the provisioning process. -- **processName** - if this property is set, it overrides the default process name (ie the name of this +- **topLeveProcessQualifiedName** - if this property is set, it overrides the default process name (ie the name of this 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 +- **topLevelProcessLineageOnly** - if this property is set, lineage mappings are connected to the top level process representing this governance action service. - **lineageToDestinationFolderOnly** - if this property is set, the lineage relationship from the @@ -119,7 +116,6 @@ This is its connection definition to use when creating the definition of the gov }, "configurationProperties": { - "provisionUncataloguedFiles": "", "targetFileNamePattern": "{{pattern}}", "noLineage": "", "processName": "{{processName}}", 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 index f37dc5600a..34ee627ceb 100644 --- a/site/docs/connectors/governance-action/zone-publisher-governance-action-service.md +++ b/site/docs/connectors/governance-action/zone-publisher-governance-action-service.md @@ -17,8 +17,8 @@ An asset's [governance zones](/concepts/governance-zone) determines its visibili 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. +* If there is at least one asset, their zones are updated, and the output guard is set to `zones-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 @@ -56,18 +56,18 @@ When this governance action service is called through an [engine action](/concep #### Request Types and Parameters -Origin seeker does not specifically recognize any request types or request parameters. +The `publishZones` request parameter/configuration property provides Zone Publisher with list of zones to add to the action target assets. #### 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. +The assets that needs their zones updated are linked to the governance action as an action target. #### 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.ACTIONED` with guard `zones-assigned` if the zones are successfully assigned to the assets. +- `CompletionStatus.ACTIONED` with guard `no-zones-detected` if the `publishZones` property is not set up in either the configuration properties or the request parameters. Any AssetZoneMembership classification is removed from the action target asset(s). - `CompletionStatus.INVALID` with guard `no-targets-detected` if no assets are passed as action targets. ## Examples of use diff --git a/site/docs/connectors/survey-action/any-file-survey-action-service.svg b/site/docs/connectors/survey-action/any-file-survey-action-service.svg new file mode 100644 index 0000000000..ed6faac2cf --- /dev/null +++ b/site/docs/connectors/survey-action/any-file-survey-action-service.svg @@ -0,0 +1,4 @@ + + + +
Engine Host
Survey Action OMES
Survey Action Engine
File
 Survey Service
Metadata Access Server
Stewardship Action OMAS
Read
File
metadata
Read asset and
connection metadata
Build Survey Report
 \ No newline at end of file diff --git a/site/docs/connectors/survey-action/any-file-survey-action-survey-report.svg b/site/docs/connectors/survey-action/any-file-survey-action-survey-report.svg new file mode 100644 index 0000000000..7cf2d2e5bc --- /dev/null +++ b/site/docs/connectors/survey-action/any-file-survey-action-survey-report.svg @@ -0,0 +1,4 @@ + + + +
Discovery Analysis
Report
DataFile
file
Connection
Basic
File Store
 Connection
ConectorType
Endpoint
AssetConnection
Survey Report
DataSource
Measurements Annotation
ReportedAnnotations
 \ No newline at end of file diff --git a/site/docs/connectors/survey-action/csv-file-survey-action-service.svg b/site/docs/connectors/survey-action/csv-file-survey-action-service.svg new file mode 100644 index 0000000000..86a1619828 --- /dev/null +++ b/site/docs/connectors/survey-action/csv-file-survey-action-service.svg @@ -0,0 +1,4 @@ + + + +
Engine Host
Survey Action OMES
Survey Action Engine
CSV File
 Survey Service
Metadata Access Server
Stewardship Action OMAS
Read
File content
and metadata
Read asset and
connection metadata
Build Survey Report
 \ No newline at end of file diff --git a/site/docs/connectors/survey-action/csv-file-survey-action-survey-report.svg b/site/docs/connectors/survey-action/csv-file-survey-action-survey-report.svg new file mode 100644 index 0000000000..aee2a35007 --- /dev/null +++ b/site/docs/connectors/survey-action/csv-file-survey-action-survey-report.svg @@ -0,0 +1,4 @@ + + + +
Discovery Analysis
Report
Data Profile
Annotation
Data Profile
Annotation
Data Profile
Annotation
Data Profile
Annotation
CSVFile
file.csv
Connection
CSV
File Store
 Connection
ConectorType
Endpoint
AssetConnection
Survey Report
DataSource
Measurements Annotation
Tabular
SchemaType
Entity Data Field
Entity Data Field
Entity Data Field
Entity Data Field
Entity Data Field
Tablular
Column
Data Profile
Annotation
Data Profile
Annotation
Schema Analysis Annotation
AssetSchemaType
ReportedAnnotations
ReportedAnnotations
 \ No newline at end of file diff --git a/site/docs/connectors/survey-action/folder-survey-action-service.svg b/site/docs/connectors/survey-action/folder-survey-action-service.svg new file mode 100644 index 0000000000..8477b1ac81 --- /dev/null +++ b/site/docs/connectors/survey-action/folder-survey-action-service.svg @@ -0,0 +1,4 @@ + + + +
Engine Host
Survey Action OMES
Survey Action Engine
Folder
 Survey Service
Metadata Access Server
Stewardship Action OMAS
Read
Folder
metadata
Read asset and
connection metadata
Build Survey Report
 \ No newline at end of file diff --git a/site/docs/connectors/survey-action/folder-survey-action-survey-report.svg b/site/docs/connectors/survey-action/folder-survey-action-survey-report.svg new file mode 100644 index 0000000000..45b31e7051 --- /dev/null +++ b/site/docs/connectors/survey-action/folder-survey-action-survey-report.svg @@ -0,0 +1,4 @@ + + + +
Discovery Analysis
Report
FileFolder
folder
Connection
Basic
File Store
 Connection
ConectorType
Endpoint
AssetConnection
Survey Report
Profile of
File Extensions
ReportedAnnotations
Data Profile Annotations
Profile Log of
File Names
Profile of
File Types
Profile of
Asset Type Names
Profile of
Deployed Implementation Types
Profile of
Readable Files
Profile of
Writable Files
Profile of
Executable Files
Profile of
Hidden Files
Profile of
SymLinks
Request For Action
on Missing File Reference Data
 \ No newline at end of file diff --git a/site/docs/demos/sample-configs.drawio b/site/docs/demos/sample-configs.drawio new file mode 100644 index 0000000000..a659067773 --- /dev/null +++ b/site/docs/demos/sample-configs.drawio @@ -0,0 +1,72 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/demos/sample-servers.svg b/site/docs/demos/sample-servers.svg new file mode 100644 index 0000000000..9ee0327142 --- /dev/null +++ b/site/docs/demos/sample-servers.svg @@ -0,0 +1,4 @@ + + + +
active-metadata-store
integration-daemon
engine-host
Survey Action
Services
Integration
Connectors
Metadata
Repository
simple-metadata-store



Metadata
Repository
XTDB (KV)
Kafka Event Bus
Open
Connector
Archive
Open
Connector
Archive
 \ No newline at end of file diff --git a/site/docs/frameworks/odf/overview.md b/site/docs/frameworks/odf/overview.md index 260409ed36..a4a0767748 100644 --- a/site/docs/frameworks/odf/overview.md +++ b/site/docs/frameworks/odf/overview.md @@ -75,7 +75,6 @@ Some discovery annotations refer to an entire asset and others refer to a data f | Quality annotation | Document calculated quality scores on different dimensions. | | Schema analysis annotation | Document the structure of the data (schema) inside the asset. | | Semantic annotation | Documents suggested meanings for this data based on the values and name of the field. | -| Suspect duplicate annotation | Identifies other asset definitions that seem to point to the same physical asset. | The open metadata types for a discovery annotations are described in [area 6](/types/6) of the model. diff --git a/site/docs/frameworks/saf/overview.md b/site/docs/frameworks/saf/overview.md index 98a0460216..ccf4216576 100644 --- a/site/docs/frameworks/saf/overview.md +++ b/site/docs/frameworks/saf/overview.md @@ -34,18 +34,18 @@ An *annotation* describes one or more related properties about an [asset](/conce Different types of annotations provide different types of information. -| Annotation type | Description | -|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Classification annotation | Captures a recommendation of which classifications to attach to this asset. It can be made at the asset or data field level. | -| Data class annotation | Captures a recommendation of which data class this data field closely represents. | -| Data profile annotation | Capture the characteristics of the data values stored in a specific data field in a data source. | -| Data profile log annotation | Capture the names of the log files where profile characteristics of the data values stored in a specific data field. This is used when the profile results are too large to store in open metadata. | -| Data source measurement annotation | Collect arbitrary properties about a data source. | -| Data source physical status annotation | Documents the physical characteristics of a data source asset. | -| Relationship advice annotation | Document a recommended relationship that should be established with the asset. | -| Quality annotation | Document calculated quality scores on different dimensions. | -| Semantic annotation | Documents suggested meanings for this data based on the values and name of the field. | -| Suspect duplicate annotation | Identifies other asset definitions that seem to point to the same physical asset. | +| Annotation type | Description | +|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Classification annotation | Captures a recommendation of which classifications to attach to this asset. It can be made at the asset or data field level. | +| Data class annotation | Captures a recommendation of which data class this data field closely represents. | +| Data profile annotation | Captures the characteristics of the data values stored in a specific data field in a data source. | +| Data profile log annotation | Captures the names of the log files where profile characteristics of the data values stored in a specific data field. This is used when the profile results are too large to store in open metadata. | +| Data source measurement annotation | Collects arbitrary properties about a data source. | +| Data source physical status annotation | Documents the physical characteristics of a data source asset. | +| Relationship advice annotation | Documents a recommended relationship that should be established with the asset. | +| Quality annotation | Documents the calculated quality scores on different dimensions. | +| Semantic annotation | Documents suggested meanings for this data based on the values and name of the field. | +| Semantic annotation | Documents details of an issue or situation that needs a steward's attention. | #### Schema extraction @@ -118,7 +118,7 @@ The measurement annotations capture a snapshot of the physical dimensions and ac #### Requesting stewardship action -A RequestForAction entity (RfA) is used when a survey action service performs a test on the data (such as a [quality rule](/features/data-quality/overview)) or has discovered an anomaly in the data landscape compared to its metadata that potentially needs a steward or a curator's action. +A RequestForAction (RfA) annotation is used when a survey action service performs a test on the data (such as a [quality rule](/features/data-quality/overview)) or has discovered an anomaly in the data landscape compared to its metadata that potentially needs a steward or a curator's action. The anomaly typically refers to the elements within the asset being surveyed. However, it may be in other data used in the survey process. In either case, it is possible to use a *RequestForActionTarget* relationship to identify where action is required. ![Request for action](survey-action-request-for-action.svg) diff --git a/site/docs/frameworks/saf/survey-action-request-for-action.svg b/site/docs/frameworks/saf/survey-action-request-for-action.svg index 77a95d9ddd..333ca0674c 100644 --- a/site/docs/frameworks/saf/survey-action-request-for-action.svg +++ b/site/docs/frameworks/saf/survey-action-request-for-action.svg @@ -1,4 +1,4 @@ -
Survey Report
Survey Report
Annotation
Annotation
RequestForAction
RequestForAction
RequestForAction
Annotation
RequestForAction...
Schema Attribute
Schema Attribute
AssociatedAnnotation
AssociatedAnnotation
Asset
Asset
AssociatedAnnotation
AssociatedAnnotationText is not SVG - cannot display \ No newline at end of file +
Survey Report
Annotation
RequestForAction
RequestForAction
Annotation
Schema Attribute
AssociatedAnnotation
Asset
AssociatedAnnotation
RequestForAction
Annotation
Asset
Target For Action
 \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action.drawio b/site/docs/frameworks/saf/survey-action.drawio index 7762c49551..34beabd904 100644 --- a/site/docs/frameworks/saf/survey-action.drawio +++ b/site/docs/frameworks/saf/survey-action.drawio @@ -1,6 +1,6 @@ - + - + @@ -206,7 +206,7 @@ - + @@ -300,7 +300,7 @@ - + @@ -369,7 +369,7 @@ - + @@ -421,25 +421,25 @@ - + - + - + - + - + @@ -456,17 +456,17 @@ - + - + - + @@ -490,7 +490,7 @@ - + @@ -499,14 +499,14 @@ - + - + @@ -538,22 +538,22 @@ - + - + - + - + @@ -580,33 +580,33 @@ - + - + - + - + - + - + - + @@ -633,33 +633,33 @@ - + - + - + - + - + - + - + @@ -703,33 +703,33 @@ - + - + - + - + - + - + - + @@ -764,33 +764,33 @@ - + - + - + - + - + - + - + @@ -817,28 +817,45 @@ - + - + - + - + - + - + + + + + + + + + + + + + + + + + + @@ -872,31 +889,31 @@ - + - + - + - + - + - + - + - + @@ -905,204 +922,204 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1110,7 +1127,7 @@ - + @@ -1120,10 +1137,10 @@ - + - + @@ -1132,37 +1149,37 @@ - + - + - + - + - + - + - + - + - + - + - + @@ -1171,48 +1188,48 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1221,176 +1238,176 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1399,266 +1416,266 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1667,17 +1684,17 @@ - + - + - + @@ -1787,7 +1804,7 @@ - + @@ -1851,74 +1868,4 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/site/docs/guides/developer/governance-action-services/overview.md b/site/docs/guides/developer/governance-action-services/overview.md index 88772cad85..2adaef322d 100644 --- a/site/docs/guides/developer/governance-action-services/overview.md +++ b/site/docs/guides/developer/governance-action-services/overview.md @@ -75,7 +75,7 @@ The methods in red are additional services offered to governance action services * classifyMetadataElement * reclassifyMetadataElement * updateClassificationStatus - * unclassifyMetadataElement + * declassifyMetadataElement * Working with relationships (links) between metadata elements diff --git a/site/docs/guides/operations/kubernetes/charts/overview.md b/site/docs/guides/operations/kubernetes/charts/overview.md index a6c546a70f..f312843da6 100644 --- a/site/docs/guides/operations/kubernetes/charts/overview.md +++ b/site/docs/guides/operations/kubernetes/charts/overview.md @@ -13,7 +13,7 @@ See [Helm](../helm.md) for information on configuring Helm to be able to access * [odpi-egeria-lab](lab.md) - Demo scenario for 'Coco Pharmaceuticals'. Multiple platorms, metadata repositories, cohorts. Demonstration script via Juypter notebooks. Includes both the Ecosystem UI & business UI . * [cts](cts.md) - Supports testing repository connectors using our Conformance Test Suite. Can be configured to support other repositories via simple values. * [pts](pts.md) - Performance test suite to aid in measuring the performance of repository connectors. -* [server](server.md) - Demonstrates simple OMAG Server Starter configuration and deployment. +* [server](server.md) - Demonstrates simple OMAG Server Runtime configuration and deployment. ## Issues & Advanced usage: diff --git a/site/docs/guides/operations/kubernetes/charts/server.md b/site/docs/guides/operations/kubernetes/charts/server.md index d861f68261..d266b95ebf 100644 --- a/site/docs/guides/operations/kubernetes/charts/server.md +++ b/site/docs/guides/operations/kubernetes/charts/server.md @@ -1,9 +1,9 @@ -# Egeria Server Starter chart (egeria-server) +# OMAG Server Runtime chart (egeria-server) -Egeria Server Starter helm chart defines minimal deployment resources to demonstrate simple single OMAG Server Kubernetes deployment scenario. +OMAG Server Runtime helm chart defines minimal deployment resources to demonstrate simple single OMAG Server Kubernetes deployment scenario. It produces following resources: diff --git a/site/docs/guides/operations/kubernetes/operator.md b/site/docs/guides/operations/kubernetes/operator.md index ad1043d1a6..3a03c7fa0c 100644 --- a/site/docs/guides/operations/kubernetes/operator.md +++ b/site/docs/guides/operations/kubernetes/operator.md @@ -3,10 +3,11 @@ # What is an Operator? -- An operator is a way of extending [Kubernetes](k8s.md) with application specific capababilities. -- The notion of 'operator' comes from managing an application through it's lifecycle, just as a human operator would, but here we do it automatically. +- An operator is a way of extending [Kubernetes](k8s.md) with application specific capabilities. +- The notion of 'operator' comes from managing an application through its lifecycle, just as a human operator would, but here we do it automatically. Operator functionality could include: + - deploying an application - upgrading an applications, perhaps migrating data - taking backups @@ -21,6 +22,7 @@ Kubernetes has many standard resource definitions, such as for pods, services, d [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#custom-resources) Definitions (**CRD**s) extend Kubernetes to allow anything to be represented, such as the intended state of an application stack. They are defined in yaml. Resource definitions include: + - apiVersion - consider this the namespace - metadata - useful for searching, selecting - spec - the intended state we are describing @@ -32,7 +34,7 @@ An instance of a CRD is known as a Custom Resource (**CR**) There is no intrinsic behaviour associated with a custom resource - it is purely a document with a defined schema. The behaviour is defined by the [Controller](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#custom-controllers), which is code running within the Kubernetes cluster. -The controller's objective is to make reality match the configured Custom Resource. It will watch particular resource types - the primary being the CRD above - and as changes are observed will do whatever is needed to configure application to match the desired intent. It is primarily a reconcilation loop. +The controller's objective is to make reality match the configured Custom Resource. It will watch particular resource types - the primary being the CRD above - and as changes are observed will do whatever is needed to configure application to match the desired intent. It is primarily a reconciliation loop. The controller will likely use a combination of Kubernetes APIs, perhaps defining and updating other resources, as well as interacting directly with application code within, or external to the cluster. @@ -44,13 +46,13 @@ The controller will likely use a combination of Kubernetes APIs, perhaps definin # How does it differ from Helm? -[Helm](helm.md) is a popular way of installing an application stack through charts, and sometimes upgrading. However at it's core, Helm is a templating engine. It takes templates, runs them through a processor to expand variables (across multiple documents). It then submits the documents to the Kubernetes API server just the same as if they'd be created standalone. +[Helm](helm.md) is a popular way of installing an application stack through charts, and sometimes upgrading. However, at it's core, Helm is a templating engine. It takes templates, runs them through a processor to expand variables (across multiple documents). It then submits the documents to the Kubernetes API server just the same as if they'd be created standalone. Helm charts can be stored in a repository, and make putting together a complex stack relatively easy. (we already use them successfully for Egeria). More complex behaviour can be done by deploying additional containers, jobs etc. This is **very** different to an operator. Rather than create standard Kubernetes resources, with an operator we are trying to model our application, define it's intended state, and then have active code **always** running to monitor and achieve this. Operators are thus much more sophisticated, but also complex. -Operators and custom resources can themselves be deployed using Helm - so we don't think of the Operators are replacing Helm, rather they are very complementary techniques which can be used together. For example, whist an operator might focus on a single application, a helm chart may deploy a demonstation environment. +Operators and custom resources can themselves be deployed using Helm - so we don't think of the Operators are replacing Helm, rather they are very complementary techniques which can be used together. For example, whist an operator might focus on a single application, a helm chart may deploy a demonstration environment. # Operator Lifecycle Manager @@ -58,17 +60,18 @@ The [Operator Lifecycle Manager](https://github.com/operator-framework/operator- OLM is [standard in Red Hat OpenShift](https://docs.openshift.com/container-platform/4.8/operators/understanding/olm/olm-understanding-olm.html) -**OLM is not necessary to use operators** - and unlike operators themselves, the framework **is not present in all Kubernetes distibutions**. +**OLM is not necessary to use operators** - and unlike operators themselves, the framework **is not present in all Kubernetes distributions**. # Catalogs -A catalog of operators can be found on [OperatorHub](https://operatorhub.io) and authors can [submit their own operator](https://operatorhub.io/contribute) to help with findability. +A catalog of operators can be found on [OperatorHub](https://operatorhub.io) and authors can [submit their own operator](https://operatorhub.io/contribute) to help others locate their work. # Building an operator -Operators can be built in any language than can support making API calls to Kubernetes. For example it would be possible to write a Java based operator. This is complex, and uses low level APIs, with few examples published. +Operators can be built in any language than can support making API calls to Kubernetes. For example, it would be possible to write a Java based operator. This is complex, and uses low level APIs, with few examples published. The [Operator Framework](https://operatorframework.io) is a toolkit to make it easier to develop an operator by including higher level APIs, and tools for code generation. It supports: + * [Helm](https://helm.sh) - this wraps up a Helm chart as an operator, but as such it only delivers install/upgrade capability. They can be managed and catalogued as an operator. * [Ansible](https://www.ansible.com) - an ansible operator can respond to events & run ansible scripts accordingly. This makes them significantly more flexible * [Go](https://www.golangprograms.com) - These are full 'native' operators with full access to the Kubernetes API. Kubernetes itself is written in Go. They are therefore very flexible, though more complex to develop. They do however represent the majority of development in this area, providing also the best scope for help from peers. @@ -82,29 +85,30 @@ Egeria is implementing a Go operator, using the Operator Framework. This is the # Egeria Operator Development The Egeria operator is being developed at https://github.com/odpi/egeria-k8s-operator - see here for + * [Issues](https://github.com/odpi/egeria-k8s-operator) -* prereqs/dependencies -* feedback, getting involved -* build, install, and usage instructions +* Prerequisites/dependencies +* Feedback, getting involved +* Build, install, and usage instructions ## Design considerations ### Egeria configurations -Custom Resource definitions allow for a very detailed specification of what we want our Egeria deployment to be. However Egeria itself already has a sophisticated approach to configuration - some elements of which are still evolving. +Custom Resource definitions allow for a very detailed specification of what we want our Egeria deployment to be. However, Egeria itself already has a sophisticated approach to configuration - some elements of which are still evolving. -It could be possible to try and fully expose this configuration as a CRD. However due to the complexity, fluidity, and duplication the Operator instead will add k8s deployment specific information around existing Egeria configurations. +It could be possible to try and fully expose this configuration as a CRD. However, due to the complexity, fluidity, and duplication the Operator instead will add k8s deployment specific information around existing Egeria configurations. -It's therefore imperative we keep the **Authoring** of server configuration distinct from **Deployment**. The deployment environment will be different in a Kubernetes environment (hostnames, service names etc) +It's therefore imperative we keep the **Authoring** of server configuration distinct from **Deployment**. The deployment environment will be different in a Kubernetes environment (hostnames, service names, etc.) -Initially the egeria config document will be used verbatim, however if processing is needed, a [Admission Webhook](https://sdk.operatorframework.io/docs/building-operators/golang/webhook/) could be used to validate ([validating](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#validatingadmissionwebhook)) & convert ([mutating](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#mutatingadmissionwebhook)) the config before storing in k8s. This approach could also be used for CR validation. +Initially the egeria config document will be used verbatim, however if processing is needed, an [Admission Webhook](https://sdk.operatorframework.io/docs/building-operators/golang/webhook/) could be used to validate ([validating](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#validatingadmissionwebhook)) & convert ([mutating](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#mutatingadmissionwebhook)) the config before storing in k8s. This approach could also be used for CR validation. [Example server configuration documents](https://github.com/odpi/egeria-k8s-operator/tree/main/samples/server) ### Scaling & failover -Kubernetes is a useful container solution that scales from a raspberry pi to huge cloud deployments. As such it may be used for anything from development to full enterprise production - and this is a strong part of it's appeal. So the operator must support everything from a small development environment, through to a scalable, reliable cloud environment. +Kubernetes is a useful container solution that scales from a raspberry pi to huge cloud deployments. As such it may be used for anything from development to full enterprise production - and this is a strong part of its appeal. So the operator must support everything from a small development environment, through to a scalable, reliable cloud environment. #### Egeria Platform @@ -136,13 +140,13 @@ This has also resulted in the OMAG Server Platform being the first-class resourc ### Stateful set vs Deployment -A Deployment manages scaling of a set of containers (such as egeria platform) across multiple pods. A Statefulset extends this to provide a unique identity which can be used for unique service definitions, or for maintaining an association with dedicated storage. +A Deployment manages scaling of a set of containers (such as egeria platform) across multiple pods. A *Statefulset* extends this to provide a unique identity which can be used for unique service definitions, or for maintaining an association with dedicated storage. In the current Egeria helm chart we use a stateful set that that persistent storage can be allocated uniquely to each pod & retained across restarts. -However the assumption in the operator environment is that Egeria is stateless (beyond the config & CR), and that any persistent state is managed -via the connections to metadata storage etc, and that a unique service address is not needed. This latter point may need to be revisited if the Egeria operator needs to actively interact with the individual replicas for control/config, but this is not yet the case, hence the choice of a simpler deployment initially. +However, the assumption in the operator environment is that Egeria is stateless (beyond the config & CR), and that any persistent state is managed +via the connections to metadata storage etc., and that a unique service address is not needed. This latter point may need to be revisited if the Egeria operator needs to actively interact with the individual replicas for control/config, but this is not yet the case, hence the choice of a simpler deployment initially. ### Configuration updates @@ -164,9 +168,9 @@ Note: At this point, the deployment of XTDB itself is outside the scope of the o ### Connectors -Much of the capability in Egeria is pluggable. For example we have a connector to the message bus, which could be kafka, but equally +Much of the capability in Egeria is pluggable. For example, we have a connector to the message bus, which could be kafka, but equally may be RabbitMQ (if a connector were written). We have connectors that understand data sources such as for Postgres. These are -implemented as java jars, and are added into the classpath of the egeria platform. Thus the platform can provide a certain capability +implemented as java jars, and are added into the classpath of the egeria platform. Thus, the platform can provide a certain capability with these additional connectors, but it is the server which defines which ones to use (and refers to the class name to locate) An Egeria server configuration document therefore contains many references to connectors. The references libraries must be available in the runtime environment ie platform. This is done by ensuring they are pointed to within the spring loader's 'LOADER_PATH' environment variable. @@ -175,19 +179,21 @@ Several approaches are possible: * Build a custom container image based on the [Egeria docker image](https://github.com/odpi/egeria/tree/main/open-metadata-resources/open-metadata-deployment/docker/egeria) including the desired connectors, and either placing the required additional files into /deployments/server/lib, or placing them elsewhere in the image and ensuring LOADER_PATH is set * Dynamically download or mount the required libraries - and dependencies - when the server platform is set up by the operator, for example through an init job. -Currently the operator takes the former, simpler approach. Therefore specifying a custom container image as part of the platform configuration will often be required. +Currently, the operator takes the former, simpler approach. Therefore, specifying a custom container image as part of the platform configuration will often be required. -Connectors also often tend to refer to endpoints - for example the location of a Kafka message bus, a server's own address. Currently the server configuration document -passed to the operator must have correct addresses. As yet there is no manipulation or templating of these addresses, though this may change in future. +Connectors also often tend to refer to endpoints - for example the location of a Kafka message bus, a server's own address. Currently, the server configuration document +passed to the operator must have correct addresses. As yet there is no manipulation or templating of these addresses, though this may change in the future. ## Operator Development ### Prerelease + - deploy Egeria platforms with a list of servers - uses Kubernetes [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) to store individual server configuration - requires the user to use repositories capable of supporting replication (like XTDB) ### Still to do for an initial release + - Helm chart to deploy a complete demo environment (coco pharma) with Egeria operator & XTDB backend. - working through the full server authoring lifecycle (alongside Server Author UI & View Services) - including templating of connections which contain host:ip from the authoring environment - Evaluating alternative stores of server configuration (at a minimum may need to be a [secret](https://kubernetes.io/docs/concepts/configuration/secret/) as we include auth info - but decided to use ConfigMaps initially for clarity during initial design) @@ -197,6 +203,7 @@ passed to the operator must have correct addresses. As yet there is no manipulat ### Future enhancements + - [Operator Lifecycle Manager](https://github.com/operator-framework/operator-lifecycle-manager) integration - publish on [Operator Hub](https://operatorhub.io) - refinement of configurations (consolidation, admission webhooks) diff --git a/site/docs/guides/operations/operate-omag-server-starter.md b/site/docs/guides/operations/operate-omag-server-starter.md index 49f5c1cafb..b711b7053d 100644 --- a/site/docs/guides/operations/operate-omag-server-starter.md +++ b/site/docs/guides/operations/operate-omag-server-starter.md @@ -1,14 +1,14 @@ -# Operate OMAG Server Starter +# Operate OMAG Server Runtime This guide focuses on providing instructions for running the server as standalone application process. This deployment option gives you a low level control over the application runtime and requires direct interaction with your IT infrastructure. -With OMAG Server Starter, each server runs in its own dedicated JVM process. All the required parameters required to start a server are always pre-defined and delivered to the application as configuration properties. This approach is key to achieving an immutable configuration state when running containerised deployments. +With OMAG Server Runtime, each server runs in its own dedicated JVM process. All the required parameters required to start a server are always pre-defined and delivered to the application as configuration properties. This approach is key to achieving an immutable configuration state when running containerised deployments. > Quick jump to installation steps (coming soon) -## Running OMAG Server Starter +## Running OMAG Server Runtime -To run the OMAG Server Starter application, execute the command in this format: +To run the OMAG Server Runtime application, execute the command in this format: `java -jar omag-server-{release}.jar ` @@ -54,7 +54,7 @@ Considering that the starter application is implemented using Spring Boot, we ca !!! info "Spring application external config" If you want to know more about how external configuration works, you can read more about it in the Spring Boot [Core Features](https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config){ target=_blank } . -OMAG Server Starter already has default [`application.properties`](https://github.com/odpi/egeria/blob/main/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties){ target=gh } packaged within the jar distribution. These properties can always be overridden if provided externally to the application. +OMAG Server Runtime already has default [`application.properties`](https://github.com/odpi/egeria/blob/main/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties){ target=gh } packaged within the jar distribution. These properties can always be overridden if provided externally to the application. Below are reference properties that define the behaviour of the application. @@ -65,7 +65,7 @@ Below are reference properties that define the behaviour of the application. |`omag.server-config-file`|`OMAG_SERVERCONFIGFILE`| The OMAG server configuration file that defines all subsystems and their connectors. It should be valid [Configuration Document Structure](/concepts/configuration-document/#configuration-document-structure). Can be written in .json or .yaml file format. | See [samples](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/samples){ target=gh } | !!! tip "Creating configuration document" - The configuration document can be created by hand if you have a good understanding of [Configuration Document Structure](/concepts/configuration-document/#configuration-document-structure). A safe option is to use the OMAG server platform deployment and create the configuration document using the admin services. See the [Admin Guide](/guides/admin/servers) to configure different types of servers. Finally, you can [retrieve](/guides/admin/servers/#retrieving-the-configuration) the valid document created for use with the Server Starter. + The configuration document can be created by hand if you have a good understanding of [Configuration Document Structure](/concepts/configuration-document/#configuration-document-structure). A safe option is to use the OMAG server platform deployment and create the configuration document using the admin services. See the [Admin Guide](/guides/admin/servers) to configure different types of servers. Finally, you can [retrieve](/guides/admin/servers/#retrieving-the-configuration) the valid document created for use with the OMAG Server Runtime. ### Additional Libraries diff --git a/site/docs/release-notes/5-0.md b/site/docs/release-notes/5-0.md index 8e096e5a3a..d2ee0969e0 100644 --- a/site/docs/release-notes/5-0.md +++ b/site/docs/release-notes/5-0.md @@ -1,7 +1,7 @@ -## Release 5.0 (Expected February 2024) +## Release 5.0 (Expected March 2024) _**These are DRAFT release notes. The notes will be updated until & when 5.0 is released**_ @@ -12,7 +12,7 @@ Release 5.0 is a major functional release focused on usability, both from the po * *UI back-end consolidation* - updates to the view server to allow both Egeria UIs to connect to it whether it is running in the OMAG Server Platform or OMAG Server Runtime. This eliminates the need to run the Egeria UI application. * *Digital Product Support* - new APIs for creating a digital product catalog. * *Survey Support* - new framework, services and report utility to support the surveying of digital resources to understand its contents before embarking on wholesale cataloguing and governance. -* *Reduction of technical debt* - there has been internal code changes to remove deprecated code, remove the duplication of type information and bug fixes. +* *Reduction of technical debt* - there has been internal code changes to remove deprecated code, remove the duplication of type information, and many bug fixes :). ??? functional "Open Metadata Types" @@ -21,7 +21,9 @@ Release 5.0 is a major functional release focused on usability, both from the po * The [*Collection*](/types/0/0021-Collections) entity has a new attribute called *collectionType* that can be used to identify the concept that the collection represents. * A new supertype called [*Action*](/types/1/0137-Actions) has been added to the [*ToDo*](/types/1/0137-Actions) and [*EngineAction*](/types/4/0463-Engine-Actions). * The [*Actions*](/types/1/0137-Actions) relationship now links an [*Action*](/types/1/0137-Actions) to a [*Referenceable*](/types/0/0010-Base-Model). - * A new classification called [*PersonalProject*](/types/1/0130-Projects) can be added to a project entity to indicate that this is an informal project that have been created by an individual to help them organize their work. + * The [*ToDo*](/types/1/0137-Actions) entity has a new property called *lastReviewTime*. + * A new classification called [*PersonalProject*](/types/1/0130-Projects) can be added to a project entity to indicate that it is an informal project that have been created by an individual to help them organize their work. + * A new classification called [*StudyProject*](/types/1/0130-Projects) can be added to a project entity to indicate that it is a focused analysis of a topic, person, object or situation. * A new classification called [*DataScope*](/types/2/0210-Data-Stores) can be added to a referenceable entity (typically a DataStore or DataSet) to define the scope of the associated data resource in space and time. * Although not yet implemented in the [Engine Host](/concepts/engine-host), there are types for a new type of governance engine called the [*EventActionEngine*](/types/4/0461-Governance-Engines) and its corresponding governance service called [*EventActionService*](/types/4/0461-Governance-Engines). This new engine is for managing context events, scheduling and associated actions. * A new entity called a [*ContextEvent*](/types/4/0475-Context-Events) plus associated elements has been added to provide a means to capture significant events that impact users, data, services, etcetera, to be recorded and used to explain why blips occurred in the past, or plan and take action to mitigate against blips in the future. @@ -42,52 +44,53 @@ Release 5.0 is a major functional release focused on usability, both from the po The java package name of the integrated version of the connector has changed from `org.odpi.egeria.connectors.juxt.xtdb.repositoryconnector.XtdbOMRSRepositoryConnectorProvider` to `org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.XTDBOMRSRepositoryConnectorProvider` so it is possible to continue to run the original version of the XTDB connector in V5.0. -??? danger "XTDB hang, or platform exit due to mismatch crypto library" - On the latest level of the MacOs operating system we have experienced hangs during server startup, or the OMAG Server Platform exiting with a message complaining about the unsafe load of a cryptographic library. A question has been raised with the XTDB community to find out more about this library. In the meantime, there is a workaround if you see this issue: set the following environment variables before starting your OMAG Server Platform. This switches XTDB to using its own cryptography libraries. + ??? danger "XTDB hang, or platform exit due to mismatch crypto library" + On the latest level of the MacOs operating system we have experienced hangs during server startup, or the OMAG Server Platform exiting with a message complaining about the unsafe load of a cryptographic library. A question has been raised with the XTDB community to find out more about this library. In the meantime, there is a workaround if you see this issue: set the following environment variables before starting your OMAG Server Platform. This switches XTDB to using its own cryptography libraries. - ```properties - XTDB_DISABLE_LIBCRYPTO=True;XTDB_ENABLE_BYTEUTILS_SHA1=True - ``` + ```properties + XTDB_DISABLE_LIBCRYPTO=True;XTDB_ENABLE_BYTEUTILS_SHA1=True + ``` -??? warning "Open Lineage Services and Open Lineage Server renamed to Lineage Warehouse Services and Lineage Warehouse respectively" - Our use of the term "open lineage" for our lineage governance server has been causing confusion with the newer Open Lineage standard and project. As a result, the Egeria *Open Lineage Services* are now called the [*Lineage Warehouse Services*](/services/lineage-warehouse-services) and the OMAG Server they run is called the [Lineage Warehouse](/concepts/lineage-warehouse). The new name is more descriptive and avoiding clashing names is desirable. The change has been made cleanly both to the code and the document site (ie no backward compatible deprecated methods) to ensure the name clashing is completely removed. Every should work as before, except that when migrating an open lineage server to version 5.0, it is necessary to reconfigure what was the open lineage services section to the new lineage warehouse services section. The structure is the same, but the class name has changed from `OpenLineageConfig` to `LineageWarehouseConfig`, and the `connectorProviderClassName` of the JanusGraph connector has changed from `org.odpi.openmetadata.openconnectors.governancedaemonconnectors.openlineageconnectors.janusconnector.graph.LineageGraphConnectorProvider` to `org.odpi.openmetadata.openconnectors.governancedaemonconnectors.lineagewarenouseconnectors.janusconnector.graph.LineageGraphConnectorProvider`. Full details of this change are describes in the [Administration Guide](/guides/admin/servers/configuring-a-lineage-warehouse-server). +??? warning "Improved/changed terminology" + The following concepts have been renamed to improve the clarity of their function, particularly in the documentation. -??? functional "Support for default configuration documents" - There is a new `application.properties` property supported by the OMAG Server Platform that allows a default [configuration document](/concepts/configuration-document) to be set up for the configuration document store. This provides the initial content for each new server configuration created on the platform. The new property is called `platform.default.config.document` and is described in the [Administration Guide](/guides/admin/configuring-the-omag-server-platform/#configuring-the-default-configuration-document). + ??? warning "Open Lineage Services and Open Lineage Server renamed to Lineage Warehouse Services and Lineage Warehouse respectively" + Our use of the term "open lineage" for our lineage governance server has been causing confusion with the newer Open Lineage standard and project. As a result, the Egeria *Open Lineage Services* are now called the [*Lineage Warehouse Services*](/services/lineage-warehouse-services) and the OMAG Server they run is called the [Lineage Warehouse](/concepts/lineage-warehouse). The new name is more descriptive and avoiding clashing names is desirable. The change has been made cleanly both to the code and the document site (ie no backward compatible deprecated methods) to ensure the name clashing is completely removed. Every should work as before, except that when migrating an open lineage server to version 5.0, it is necessary to reconfigure what was the open lineage services section to the new lineage warehouse services section. The structure is the same, but the class name has changed from `OpenLineageConfig` to `LineageWarehouseConfig`, and the `connectorProviderClassName` of the JanusGraph connector has changed from `org.odpi.openmetadata.openconnectors.governancedaemonconnectors.openlineageconnectors.janusconnector.graph.LineageGraphConnectorProvider` to `org.odpi.openmetadata.openconnectors.governancedaemonconnectors.lineagewarenouseconnectors.janusconnector.graph.LineageGraphConnectorProvider`. Full details of this change are describes in the [Administration Guide](/guides/admin/servers/configuring-a-lineage-warehouse-server). -??? functional "New administration commands for basic server properties" - The administration services support new commands to set up, retrieve and clear the basic server properties in a server's [configuration document](/concepts/configuration-document) in one operation. These properties are *serverDescription*, *organizationName*, *localServerUserId*, *localServerPassword* and *maxPageSize*. The new calls are described in the [Administration Guide](/guides/admin/servers/by-section/basic-server-properties-section). + ??? tip "*Governance Action* is renamed to *Engine Action*" + If you have been using Egeria for a while, you may be familiar with the term *Governance Action* as the mechanism used to control the execution of automated actions in the [Engine Hosts](/concepts/engine-host). In release 5.0, *Governance Action* is renamed to *Engine Action* to create a greater name differentiation between the concepts that are used to define the governance behaviour and those used to control the execution of this behaviour. The term *Governance Action* is now used as a general term for a [Governance Action Process](/concepts/governance-action-process) or a [Governance Action Type](/concepts/governance-action-type). There is also a differentiation between a Governance Action Type that is used to initiate a standalone Engine Action and a specialized Governance Action Type called a [Governance Action Process Step](/concepts/governance-action-process-step) that describes a single step in a Governance Action Process. -??? functional "New administration command to retrieve the metadata collection name" - The administration services support a new command to retrieve the metadata collection name set up for a repository in a [cohort member](/concepts/cohort-member) server. This complements the calls to set up the metadata collection name and metadata collection id, and retrieve the metadata collection id. +??? functional "New Python client called pyegeria" + A new python client called `pyegeria` for Egeria's administrative, platform and server operational services is available on `pypi`. Future plans include coverage of all view services and the metadata highway and governance server operational services. -??? functional "New administration commands for the Engine Host" - The administration services support new commands to simplify the configuration of an [engine host](/concepts/engine-host). It is no longer necessary to match the type of the engines you are configuring with the associated engine service. You can now specify a single list of governance engine that you want to run in the engine host and Egeria will work out which engine service to manage each of them. See the [Administration Guide](/guides/admin/servers/configuring-an-engine-host) for more information. +??? functional "Improved administration" + ??? functional "New administration commands for basic server properties" + The administration services support new commands to set up, retrieve and clear the basic server properties in a server's [configuration document](/concepts/configuration-document) in one operation. These properties are *serverDescription*, *organizationName*, *localServerUserId*, *localServerPassword* and *maxPageSize*. The new calls are described in the [Administration Guide](/guides/admin/servers/by-section/basic-server-properties-section). + + ??? functional "New administration command to retrieve the metadata collection name" + The administration services support a new command to retrieve the metadata collection name set up for a repository in a [cohort member](/concepts/cohort-member) server. This complements the calls to set up the metadata collection name and metadata collection id, and retrieve the metadata collection id. + + ??? functional "New administration commands for the Engine Host" + The administration services support new commands to simplify the configuration of an [engine host](/concepts/engine-host). It is no longer necessary to match the type of the engines you are configuring with the associated engine service. You can now specify a single list of governance engine that you want to run in the engine host and Egeria will work out which engine service to manage each of them. See the [Administration Guide](/guides/admin/servers/configuring-an-engine-host) for more information. + + ??? functional "New administration commands for the Integration Daemon" + The administration services support new commands to simplify the configuration of an [integration daemon](/concepts/integration-daemon). It is now possible to configure all the integration services in a single call. There are also new methods to work with all the configuration in the *integration daemon services* as a single request. See the [Administration Guide](/guides/admin/servers/configuring-an-integration-daemon) for more information. + + ??? functional "New administration commands for the View Server" + The administration services support new commands to simplify the configuration of an [view server](/concepts/view-server). It is now possible to configure all the view services in a single call. See the [Administration Guide](/guides/admin/servers/configuring-a-view-server) for more information. + + ??? functional "Placeholder variables supported in the configuration document" + It is possible to add placeholders in string properties of an OMAG Server's [configuration document](/concepts/configuration-document). The replacement values are configured either by a REST API call (OMAG Server Platform only), or, more typically in the `application.properties` for either the OMAG Server Platform or OMAG Server Runtime. The placeholders are replaced by these values each time the server starts. This means that the server can be run in different environments without reconfiguring the server. Full details can be found in the [Configuration Document](/concepts/configuration-document) documentation. -??? functional "New administration commands for the Integration Daemon" - The administration services support new commands to simplify the configuration of an [integration daemon](/concepts/integration-daemon). It is now possible to configure all the integration services in a single call. There are also new methods to work with all the configuration in the *integration daemon services* as a single request. See the [Administration Guide](/guides/admin/servers/configuring-an-integration-daemon) for more information. + ??? functional "Support for default configuration documents" + There is a new `application.properties` property supported by the OMAG Server Platform that allows a default [configuration document](/concepts/configuration-document) to be set up for the configuration document store. This provides the initial content for each new server configuration created on the platform. The new property is called `platform.default.config.document` and is described in the [Administration Guide](/guides/admin/configuring-the-omag-server-platform/#configuring-the-default-configuration-document). -??? functional "New administration commands for the View Server" - The administration services support new commands to simplify the configuration of an [view server](/concepts/view-server). It is now possible to configure all the view services in a single call. See the [Administration Guide](/guides/admin/servers/configuring-a-view-server) for more information. - -??? functional "Placeholder variables supported in the configuration document" - It is possible to add placeholders in string properties of an OMAG Server's [configuration document](/concepts/configuration-document). The replacement values are configured either by a REST API call (OMAG Server Platform only), or, more typically in the `application.properties` for either the OMAG Server Platform or OMAG Server Runtime. The placeholders are replaced by these values each time the server starts. This means that the server can be run in different environments without reconfiguring the server. Full details can be found in the [Configuration Document](/concepts/configuration-document) documentation. ??? functional "Placeholder properties supported in metadata templates" - It is possible to add placeholders to properties in metadata elements that . The replacement values are configured either by a REST API call (OMAG Server Platform only), or, more typically in the `application.properties` for either the OMAG Server Platform or OMAG Server Runtime. The placeholders are replaced by these values each time the server starts. This means that the server can be run in different environments without reconfiguring the server. Full details can be found in the [Configuration Document](/concepts/configuration-document) documentation. - -??? danger "Removal of the Anonymous Repository Services" - The anonymous versions to the OMRS Metadata Collection REST APIs have been removed from Egeria's runtimes since they do not include - caller information, and therefore provide opportunities for a denial of service attack. - * getMetadataCollectionId - * getEntity - * getRelationship + It is possible to add placeholders to properties in metadata elements that are used as [templates](/features/templated-cataloguing/overview) when creating new metadata elements. The replacement values are supplied on the request to create the new element from the template. -??? tip "*Governance Action* is renamed to *Engine Action*" - If you have been using Egeria for a while, you may be familiar with the term *Governance Action* as the mechanism used to control the execution of automated actions in the [Engine Hosts](/concepts/engine-host). In release 5.0, *Governance Action* is renamed to *Engine Action* to create a greater name differentiation between the concepts that are used to define the governance behaviour and those used to control the execution of this behaviour. The term *Governance Action* is now used as a general term for a [Governance Action Process](/concepts/governance-action-process) or a [Governance Action Type](/concepts/governance-action-type). There is also a differentiation between a Governance Action Type that is used to initiate a standalone Engine Action and a specialized Governance Action Type called a [Governance Action Process Step](/concepts/governance-action-process-step) that describes a single step in a Governance Action Process. - -??? functional "New framework services" - The framework services provide common services to the [Open Metadata Access Services (OMASs)](/services/omas). The [Governance Action Framework Service](/services/gaf-metadata-management) includes a new ser of services called the `Open Governance Service` that provides services to define governance actions such as [governance action processes](/concepts/governance-action-process) and [governance action types](/concepts/governance-action-type), and the initiation of [engine actions](/concepts/engine-action) either directly or via a governance action process or governance action type. +??? functional "Improved framework services" + The framework services provide common services to the [Open Metadata Access Services (OMASs)](/services/omas). The [Governance Action Framework Service](/services/gaf-metadata-management) includes a new set of services called the `Open Governance Service` that provides services to define governance actions such as [governance action processes](/concepts/governance-action-process) and [governance action types](/concepts/governance-action-type), and the initiation of [engine actions](/concepts/engine-action) either directly or via a governance action process or governance action type. All OMASs now have clients for the Connected Asset Service, Open Metadata Store, Open Governance Service and the Open Integration Service. @@ -98,21 +101,21 @@ Release 5.0 is a major functional release focused on usability, both from the po The survey action services run in the [Engine Host](/concepts/engine-host). There is a new Open Metadata Engine Service (OMES) to support survey action services. It is called the [Survey Action OMES](/services/omes/survey-action/overview). -??? deprecation "Open Discovery Framework (ODF) is now deprecated" - The function of the Survey Action Framework (SAF) is based on the [Open Discovery Framework (ODF)](/frameworks/odf/overview), which has now been deprecated. The reason for this is two-fold. Firstly the use of the term "discovery" in the framework's name is unfortunate since it is not the only mechanism that Egeria has for discovering metadata. This makes the descriptions about metadata discovery confusing. Secondly, the Open Discovery Framework has some usability issues relating to the discovery of schemas that have now been fixed in the Survey Action Framework. The Open Discovery Framework will remain in the codebase for at least 6 months to allow time for the existing open discovery services to move to the Survey Action Framework. It is recommended that all new implementations use the Survey Action Framework. + ??? deprecation "Open Discovery Framework (ODF) is now deprecated" + The function of the Survey Action Framework (SAF) is based on the [Open Discovery Framework (ODF)](/frameworks/odf/overview), which has now been deprecated. The reason for this is two-fold. Firstly the use of the term "discovery" in the framework's name is unfortunate since it is not the only mechanism that Egeria has for discovering metadata. This makes the descriptions about metadata discovery confusing. Secondly, the Open Discovery Framework has some usability issues relating to the discovery of schemas that have now been fixed in the Survey Action Framework. The Open Discovery Framework will remain in the codebase for at least 6 months to allow time for the existing open discovery services to move to the Survey Action Framework. It is recommended that all new implementations use the Survey Action Framework. + +??? functional "New Apache Atlas Survey Action Service" + There is a new [survey action service](/concepts/survey-action-service) that provides a report on the content of an Apache Atlas server. It is called the [Apache Atlas Survey Service](/connectors/apache-atlas/apache-atlas-survey-action-service). This survey action services complements the [Apache Atlas Integration Connector](/connectors/apache-atlas/apache-atlas-catalog-integration-connector) that exchanges metadata between the open metadata ecosystem and an Apache Atlas server. ??? functional "Extended support for file system monitoring" The context for all the [Open Metadata Integration Services (OMIS)](/services/omis) has been updated to support a file system listener. This means that [integration connectors](/concepts/integraiton-connector) can easily monitor changing files and directories. This can be useful for situations where new information is being exchanged with open metadata using files such as CSV files and spreadsheets. -??? functional "New View Service: Collection Manager OMVS" - [Collection Manager OMVS](/services/omvs/collection-manager/overview) supports the organizing and browsing of metadata in collections. Collections can themselves be organized hierarchically. An example of its use is in managing the collections of assets that make up digital products. +??? functional "New View Service: Automated Curation OMVS" + [Automated Curation OMVS](/services/omvs/automated-curation/overview) is a new view service in design that supports UIs that enable the user to set up integration connectors in an integration daemon, run engine actions and governance action processes. ??? functional "Improved anchor support" Anchor classifications now include the type name of the anchor entity. This allows the Anchor classification to be used to search for string values in any element that is anchored to a particular type of element. -??? functional "New Apache Atlas Connector" - There is a new [open discovery service](/concepts/open-discovery-service) that provides a report on the content of an Apache Atlas server. It is called the [Apache Atlas Open Discovery Service](/connectors/discovery/apache-atlas-discovery-service). - ??? functional "Consolidation of UI Backend Services" Today there are two approaches to providing the backend services for a UI: @@ -173,8 +176,8 @@ Release 5.0 is a major functional release focused on usability, both from the po ??? functional "Integration Connector Providers can now list catalog target types" The developer of an [integration connector](/concepts/integration-connector) can provide information about the third party technology it exchanges metadata with through [catalog target types](/concepts/catalog-target). -??? functional "Governance Service Providers can now list action target types" - The developer of a [governance service](/concepts/governance-service) can provide information about the third party technology it exchanges metadata with through [action target types](/concepts/action-target). +??? functional "Governance Service Providers can now export their specification" + The developer of a [governance service](/concepts/governance-service) can provide information about the request types, request parameters and [action target types](/concepts/action-target) it consumes and produces making it easier for consumers creating [governance engine definitions](/concepts/governance-engine-definition), [governance action types](/concepts/governance-action-type) and [governance action processes](/concepts/governance-action-process) to incorporate the governance service into their work. ??? functional "Extension to the OpenConnectorArchive" The `OpenMetadataArchive.omarchive` (was `OpenMetadataArchive.json`) now contains reference data for many [file types](/concepts/file-type) and [deployed implementation types](/concepts/deployed-implementation-type). The deployed implementation types include details of Egeria's runtimes and services and how they link together. The deployed implementation types are also linked to details of the connectors that work with the associated technology. This is to assist someone setting up new automated curation and governance activities in the open metadata ecosystem. @@ -188,4 +191,11 @@ Release 5.0 is a major functional release focused on usability, both from the po ??? info "Management of open metadata type definitions" As the Egeria code base evolved, sets of definitions for the unique identifiers and type names of the open metadata types appeared in multiple modules. There was a set in the open metadata archive helper, the generic handlers, multiple OMASs and the Governance Action Framework. This was in addition to the original definitions in the open metadata type archive itself. In release 5.0, these copies of the open metadata type identifiers have been consolidated into one set found in the Governance Action Framework. There is still work to change the type definitions in the open metadata type archive to use the definitions from the GAF. This change removes the inconsistencies and gaps in the definitions. It also makes it easier to discover where a particular open metadata type is used. +??? danger "Removal of the Anonymous Repository Services" + The anonymous versions to the OMRS Metadata Collection REST APIs have been removed from Egeria's runtimes since they do not include caller information, and therefore provide opportunities for a denial of service attack. These services were deprecated in version 2 of Egeria. + + * getMetadataCollectionId + * getEntity + * getRelationship + --8<-- "snippets/abbr.md" diff --git a/site/docs/release-notes/5-1.md b/site/docs/release-notes/5-1.md index 5ce6a62665..ce17cf9225 100644 --- a/site/docs/release-notes/5-1.md +++ b/site/docs/release-notes/5-1.md @@ -1,21 +1,21 @@ -## Release 5.1 (Expected April 2024) +## Release 5.1 (Expected June 2024) _**These are DRAFT release notes. The notes will be updated until & when 5.1 is released**_ -??? functional "New View Service: Automated Curation OMVS" - [Automated Curation OMVS](/services/omvs/automated-curation/overview) is a new view service in design that supports UIs that enable the user to set up integration connectors in an integration daemon, run engine actions and governance action processes. - ??? functional "New View Service: Notification Manager OMVS" [Notification Manager OMVS](/services/omvs/notification-manager/overview) supports the management and querying of [Context Events](/concepts/context-event). ??? functional "New Engine Service: Event Action OMES" [Event Action OMES](/services/omes/event-action/overview) supports the running of [event-action-services](/concepts/event-action-service). +??? functional "New View Service: Collection Manager OMVS" + [Collection Manager OMVS](/services/omvs/collection-manager/overview) supports the organizing and browsing of metadata in collections. Collections can themselves be organized hierarchically. An example of its use is in managing the collections of assets that make up digital products. + + - diff --git a/site/docs/types/1/0130-Projects.md b/site/docs/types/1/0130-Projects.md index 9d6d8cade2..1470b1d36f 100644 --- a/site/docs/types/1/0130-Projects.md +++ b/site/docs/types/1/0130-Projects.md @@ -33,6 +33,10 @@ The *PersonalProject* classification is attached to a *Project* entity to indica Personal projects do not typically have a [Project Manager](#projectmanagement-relationship) assigned. +## StudyProject classification + +The *StudyProject* classifies a project that is a focused analysis of a topic, person, object or situation. + ## ProjectHierarchy relationship Projects can be broken down into smaller projects that can be executed by different teams on different timelines with different project manager(s) and a specific slice of the budget. The projects that are broken down in this way are linked together using the *ProjectHierarchy* relationship. diff --git a/site/docs/types/1/0130-Projects.svg b/site/docs/types/1/0130-Projects.svg index af1a6a026e..2c203f7dc4 100644 --- a/site/docs/types/1/0130-Projects.svg +++ b/site/docs/types/1/0130-Projects.svg @@ -1,4 +1,4 @@ -
0130 - Projects
0130 - Projects
«entity»
Project
«entity»...
identifier : string
name : string
description : string
startDate : date
plannedEndDate : date
projectStatus : string
identifier : string...
«classification»
Task
«classification»...
«entity»
Referenceable
«entity»...
managedProjects
managedProjects
*
*
managingProject
managingProject
0..1
0..1
«relationship»
ProjectHierarchy
«relationship»...
«classification»
Campaign
«classification»...
dependentProjects
dependentProjects
*
*
dependsOnProjects
dependsOnProjects
*
*
«relationship»
ProjectDependency
«relationship»...
dependencySummary : string
dependencySummary : string
«entity»
Actor
«entity»...
«relationship»
ProjectTeam
«relationship»...
teamRole : string
teamRole : string
*
*
*
*
projectFocus
projectFocus
supportingActors
supportingActors
projectsManaged
projectsManaged
*
*
projectManagers
projectManagers
*
*
«relationship»
ProjectManagement
«relationship»...
«entity»
ProjectManager
«entity»...
«entity»
PersonRole
«entity»...
«classification»
PersonalProject
«classification»...Text is not SVG - cannot display \ No newline at end of file +
0130 - Projects
«entity»
Project
identifier : string
name : string
description : string
startDate : date
plannedEndDate : date
projectStatus : string
«classification»
Task
«entity»
Referenceable
managedProjects
*
managingProject
0..1
«relationship»
ProjectHierarchy
«classification»
Campaign
dependentProjects
*
dependsOnProjects
*
«relationship»
ProjectDependency
dependencySummary : string
«entity»
Actor
«relationship»
ProjectTeam
teamRole : string
*
*
projectFocus
supportingActors
projectsManaged
*
projectManagers
*
«relationship»
ProjectManagement
«entity»
ProjectManager
«entity»
PersonRole
«classification»
PersonalProject
«classification»
StudyProject
 \ No newline at end of file diff --git a/site/docs/types/1/0137-Actions.md b/site/docs/types/1/0137-Actions.md index 433ee516f7..ddcef7d738 100644 --- a/site/docs/types/1/0137-Actions.md +++ b/site/docs/types/1/0137-Actions.md @@ -3,14 +3,14 @@ # 0137 Actions for People -In an ideal world, most governance activity is automated by the [Governance Engines](/types/4/0461-Governance-Engines/#governanceengines). However, there are inevitably actions that require a person, or an external agent, to perform. These actions may be simply be to read some information, or to approve a change or something more substantial. +In an ideal world, most governance activity is automated by the [Governance Actions](/concepts/governance-action). However, there are inevitably actions that require a person, or an external agent, to perform. These actions may be simply be to read some information, or to approve a change or something more substantial. ![UML](0137-Actions.svg "Describing an action for a person") ## Action entity -The *Action* entity provides a common base class for the *ToDo* entity and the [*EngineAction*](/types/4/0463-Egnine-Actions) entity. +The *Action* entity provides a common base class for the *ToDo* entity and the [*EngineAction*](/types/4/0463-Egnine-Actions) entity. It indicates an action that either needs to be taken, is in progress, or has been taken. ## ToDo entity @@ -24,6 +24,7 @@ The additional attributes are: * creationTime - When the requested action was identified. * priority - How urgent is this action? * dueTime - When the requested action needs to be completed. +* lastReviewTime - When the requested action was last reviewed. * status - How complete is the action? (See ToDoStatus) * completionTime - When the requested action was completed. diff --git a/site/docs/types/1/0137-Actions.svg b/site/docs/types/1/0137-Actions.svg index 5b6241017a..d7c3bf4acb 100644 --- a/site/docs/types/1/0137-Actions.svg +++ b/site/docs/types/1/0137-Actions.svg @@ -1,4 +1,4 @@ -
0137 - Actions for People
0137 - Actions for People
«entity»
ToDo
«entity»...
name : string
description : string
toDoType : string
creationTime : date
priority : int
dueTime : date
completionTime : date
status : ToDoStatus
name : string...
«relationship»
Actions
«relationship»...
*
*
*
*
«entity»
Referenceable
«entity»...
actionCause
actionCause
relatedActions
relatedActions
«entity»
Actor
«entity»...
«relationship»
ActionAssignment
«relationship»...
*
*
*
*
toDoList
toDoList
assignedActors
assignedActors
«enumeration»
ToDoStatus
«enumeration»...
OPEN = 0
IN_PROGRESS = 1
WAITING = 2
COMPLETE = 3
ABANDONED = 99
OPEN = 0...
0..1
0..1
actionSource
actionSource
actions
actions
*
*
«relationship»
ToDoSource
«relationship»...
«entity»
Referenceable
«entity»...
«relationship»
ActionTarget
«relationship»...
actionTargetName : string
status : ToDoStatus
startDate : date
completionDate : date
completionMessage : string
actionTargetName : string...
*
*
*
*
identifiedToDoActions
identifiedToDoActions
elementsToWorkOn
elementsToWorkOn
«entity»
Action
«entity»...Text is not SVG - cannot display \ No newline at end of file +
0137 - Actions for People
«entity»
ToDo
name : string
description : string
toDoType : string
creationTime : date
priority : int
dueTime : date
lastReviewTime : date
completionTime : date
status : ToDoStatus
«relationship»
Actions
*
*
«entity»
Referenceable
actionCause
relatedActions
«entity»
Actor
«relationship»
ActionAssignment
*
*
toDoList
assignedActors
«enumeration»
ToDoStatus
OPEN = 0
IN_PROGRESS = 1
WAITING = 2
COMPLETE = 3
ABANDONED = 99
0..1
actionSource
actions
*
«relationship»
ToDoSource
«entity»
Referenceable
«relationship»
ActionTarget
actionTargetName : string
status : ToDoStatus
startDate : date
completionDate : date
completionMessage : string
*
*
identifiedToDoActions
elementsToWorkOn
«entity»
Action
 \ No newline at end of file diff --git a/site/docs/types/1/area-1-collaboration.drawio b/site/docs/types/1/area-1-collaboration.drawio index d0452a0e41..a84a0c8ef9 100644 --- a/site/docs/types/1/area-1-collaboration.drawio +++ b/site/docs/types/1/area-1-collaboration.drawio @@ -1,6 +1,6 @@ - + - + @@ -633,7 +633,7 @@ - + @@ -644,7 +644,7 @@ - + @@ -655,115 +655,115 @@ - + - + - + - + - + - - + + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - + - + @@ -775,36 +775,35 @@ - + - + - + - + - + - + - + - + - - + @@ -815,22 +814,33 @@ - - + + - - - - - + + - + + + + + + + + + + + + + + + @@ -892,7 +902,7 @@ - + @@ -902,147 +912,147 @@ - + - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - - + + - + - - + + - + - + - + - + - + - + - + diff --git a/site/docs/types/4/0462-Governance-Action-Processes.md b/site/docs/types/4/0462-Governance-Action-Processes.md index 7ecb04918a..644afbb31f 100644 --- a/site/docs/types/4/0462-Governance-Action-Processes.md +++ b/site/docs/types/4/0462-Governance-Action-Processes.md @@ -21,7 +21,11 @@ The properties of a *GovernanceActionType* entity are: * *domainIdentifier* links the action to a specific [governance domain](/concepts/governance-domain). * *displayName* - human-readable name for messages and user interfaces. * *description* - description of the governance action that is taken. -* *producedGuards* - lists the possible guards produced by the called governance service when it completes. This is used to help the individual/tool to understand the possible outcomes. +* *requiredRequestParameters* - lists the required request parameters that should be supplied by the caller when the governance action type is used to initiate an engine action, along with its description. +* *producedActionTargets* - lists the required action targets that should be supplied by the caller when the governance action type is used to initiate an engine action, along with its description. +* *producedRequestParameters* - lists the required request parameters that should be supplied by the caller when the governance action type is used to initiate an engine action, along with its description. +* *producedActionTargets* - lists the required action targets that should be supplied by the caller when the governance action type is used to initiate an engine action, along with its description. +* *producedGuards* - lists the possible guards produced by the called governance service when it completes along with a description of the guard. This is used to help the individual/tool to understand the possible outcomes. * *waitTime* - the minimum number of minutes that the engine action should wait before starting. ## GovernanceActionExecutor relationships @@ -65,5 +69,6 @@ The follow-on action runs when all of its mandatory guards are produced by previ ???+ deprecated "Deprecated types" The *ignoreMultipleTriggers* attribute in the *NextGovernanceProcessStep* has been deprecated. It is now located in the *GovernanceActionType* entity. + The *supportedGuards* attribute in the *GovernanceActionType* has been deprecated in favour of the *producedGuards* entity. --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/types/4/0462-Governance-Action-Processes.svg b/site/docs/types/4/0462-Governance-Action-Processes.svg index 98319ac9ae..fd4258daa2 100644 --- a/site/docs/types/4/0462-Governance-Action-Processes.svg +++ b/site/docs/types/4/0462-Governance-Action-Processes.svg @@ -1,4 +1,4 @@ -
0462 - Governance Action Processes
0462 - Governance Action Processes
ignoreMultipleTriggers : boolean
ignoreMultipleTriggers : boolean
«entity»
Referenceable
«entity»...
guard : string
mandatoryGuard : boolean
guard : string...
*
*
*
*
dependedOnProcessSteps
dependedOnProcessSteps
followOnProcessSteps
followOnProcessSteps
«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%3EGovernanceActionProcessStep
«entity»...
«relationship»
NextGovernanceActionProcessStep
«relationship»...
*
*
requestType : string
requestParameters : map<string, string>
requestParameterFilter : array<string>
requestParameterMap : map<string, string>
actionTargetFilter : array<string>
actionTargetMap : map<string, string>
requestType : string...
0..1
0..1
«relationship»
GovernanceActionExecutor
«relationship»...
«entity»
Process
«entity»...
«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%3EGovernanceActionProcess
«entity»...
domainIdentifier : int
domainIdentifier : int
guard : string
guard : string
«relationship»
GovernanceActionProcessFlow
«relationship»...
firstStep
firstStep
triggeredFrom
triggeredFrom
0..1
0..1
*
*
«entity»
GovernanceEngine
«entity»...
«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%3EGovernanceActionType
«entity»...
domainIdentifier : int
displayName : string
description : string
producedGuards : array<string>
waitTime : int
domainIdentifier : int...
governanceActionExecutor
governanceActionE...
supportsGovernanceActions
supportsGovernanceA...Text is not SVG - cannot display \ No newline at end of file +
0462 - Governance Action Processes
ignoreMultipleTriggers : boolean
«entity»
Referenceable
guard : string
mandatoryGuard : boolean
*
*
dependedOnProcessSteps
followOnProcessSteps
«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%3EGovernanceActionProcessStep
«relationship»
NextGovernanceActionProcessStep
*
requestType : string
requestParameters : map<string, string>
requestParameterFilter : array<string>
requestParameterMap : map<string, string>
actionTargetFilter : array<string>
actionTargetMap : map<string, string>
0..1
«relationship»
GovernanceActionExecutor
«entity»
Process
«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%3EGovernanceActionProcess
domainIdentifier : int
guard : string
«relationship»
GovernanceActionProcessFlow
firstStep
triggeredFrom
0..1
*
«entity»
GovernanceEngine
«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%3EGovernanceActionType
domainIdentifier : int
displayName : string
description : string
requiredRequestParameters : map<string, string>
requiredActionTargets : map<string, string>
producedRequestParameters : map<string, string>
producedActionTargets : map<string, string>
producedGuards : map<string, string>
waitTime : int
governanceActionExecutor
supportsGovernanceActions
 \ 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 567ffb9ebe..c7d74722ee 100644 --- a/site/docs/types/4/area-4-governance.drawio +++ b/site/docs/types/4/area-4-governance.drawio @@ -1,6 +1,6 @@ - + - + @@ -2325,7 +2325,7 @@ - + @@ -2336,99 +2336,99 @@ - + - + - + - + - + - + - + - + - + - + - + - + - - + + - + - + - + - + - - + + - + - + - + - + - + - + - + @@ -2441,33 +2441,33 @@ - - + + - + - - + + - + - + - - + + - + @@ -2477,7 +2477,7 @@ - + diff --git a/site/docs/types/5/0545-Reference-Data.svg b/site/docs/types/5/0545-Reference-Data.svg index 07592659ea..7f7e390928 100644 --- a/site/docs/types/5/0545-Reference-Data.svg +++ b/site/docs/types/5/0545-Reference-Data.svg @@ -1,4 +1,4 @@ -
0545 - Reference Data
0545 - Reference Data
«entity»
ValidValueDefinition
«entity»...
name : string
description : string
category : string
usage : string
scope : string
preferredValue : string
isDeprecated : boolean
isCaseSensitive : boolean
name : string...
«entity»
Referenceable
«entity»...
«entity»
Referenceable
«entity»...
«relationship»
ValidValuesImplementation
«relationship»...
symbolicName : string
implementationValue : string
additionalValues : map<string, string>
symbolicName : string...
*
*
*
*
validValues
validValues
validValueImplementations
validValueImplementations
«classification»
ReferenceData
«classification»...
«entity»
ValidValuesSet
«entity»...
«relationship»
ValidValuesAssignment
«relationship»...
strictRequirement : boolean
strictRequirement : boolean
memberOfValidValuesSet
memberOfValidVa...
validValuesSet
validValuesSet
validValuesConsumer
validValuesCons...
validValues
validValues
*
*
*
*
*
*
0..1
0..1
«relationship»
ValidValueMember
«relationship»...
isDefaultValue : boolean
isDefaultValue : boolean
matchingValue
matchingValue
matchingValue
matchingValue
«relationship»
ValidValuesMapping
«relationship»...
associationDescription : string
confidence : int
steward : string
stewardTypeName : string
stewardPropertyName : string
notes : string
associationDescription : string...
*
*
*
*
*
*
*
*
«relationship»
ReferenceValueAssignment
«relationship»...
attributeName : string
confidence : int
steward : string
stewardTypeName : string
stewardPropertyName : string
notes : string
attributeName : string...
assignedItem
assignedItem
referenceValue
referenceVal...
consistentValue
consistentVa...
consistentValue
consistentValue
«relationship»
ConsistentValidValues
«relationship»...
*
*
*
*
*
*
*
*
associatedValues1
associatedValues1
associatedValues2
associatedValues2
«relationship»
ValidValueAssociation
«relationship»...
associationName : string
associationType : string
additionalProperties : map<string, string>
associationName : string...
«entity»
Asset
«entity»...Text is not SVG - cannot display \ No newline at end of file +
0545 - Reference Data
«entity»
ValidValueDefinition
name : string
description : string
category : string
usage : string
dataType : string
scope : string
preferredValue : string
isDeprecated : boolean
isCaseSensitive : boolean
«entity»
Referenceable
«entity»
Referenceable
«relationship»
ValidValuesImplementation
symbolicName : string
implementationValue : string
additionalValues : map<string, string>
*
*
validValues
validValueImplementations
«classification»
ReferenceData
«entity»
ValidValuesSet
«relationship»
ValidValuesAssignment
strictRequirement : boolean
memberOfValidValuesSet
validValuesSet
validValuesConsumer
validValues
*
*
*
0..1
«relationship»
ValidValueMember
isDefaultValue : boolean
matchingValue
matchingValue
«relationship»
ValidValuesMapping
associationDescription : string
confidence : int
steward : string
stewardTypeName : string
stewardPropertyName : string
notes : string
*
*
*
*
«relationship»
ReferenceValueAssignment
attributeName : string
confidence : int
steward : string
stewardTypeName : string
stewardPropertyName : string
notes : string
assignedItem
referenceValue
consistentValue
consistentValue
«relationship»
ConsistentValidValues

*
*
*
*
associatedValues1
associatedValues2
«relationship»
ValidValueAssociation
associationName : string
associationType : string
additionalProperties : map<string, string>
«entity»
Asset
 \ No newline at end of file diff --git a/site/docs/types/5/area-5-models-and-schema.drawio b/site/docs/types/5/area-5-models-and-schema.drawio index 1dde38e10b..8026a37c8b 100644 --- a/site/docs/types/5/area-5-models-and-schema.drawio +++ b/site/docs/types/5/area-5-models-and-schema.drawio @@ -1,6 +1,6 @@ - + - + @@ -2698,7 +2698,7 @@ - + @@ -2712,168 +2712,168 @@ - + - - + + - + - + - + - - + + - + - + - + - + - + - + - + - + - + - + - - + + - + - + - + - + - + - + - + - + - + - + - - + + - + - - - + + + - + - + - + - - + + - - - + + + - + - + - + - + - + - + - - + + - + - + - + - + @@ -2883,8 +2883,8 @@ - - + + @@ -2892,82 +2892,82 @@ - - + + - - - + + + - + - + - + - - + + - + - + - + - + - + - - + + - - + + - - + + - - + + - - + + - - + + - + - - + + - - + + - + - - + + - - + + diff --git a/site/docs/types/6/0690-Request-for-Action.md b/site/docs/types/6/0690-Request-for-Action.md index e6d5689f42..4667bf6d20 100644 --- a/site/docs/types/6/0690-Request-for-Action.md +++ b/site/docs/types/6/0690-Request-for-Action.md @@ -1,18 +1,18 @@ ---- -hide: -- toc ---- - # 0690 Request for Action -A RequestForAction entity (RfA) is used to trigger the [Stewardship Action OMAS](/services/omas/stewardship-action/overview). +A [Request For Action (RfA)](/concepts/request-for-action) identifies an issue detected by a [Survey Action Service](/concepts/survey-action-service) while it is running. -It is used when a [survey action service](/concepts/survey-action-service) performs a test on the data (such as a quality rule) or has discovered an anomaly in the data landscape compared to its metadata that potentially needs a steward or a curator's action. +![UML](0690-Request-for-Action.svg) +## RequestForAction entity -![UML](0690-Request-for-Action.svg) +The *RequestForAction* entity is a type of [DataFieldAnnotation](/types/6/0610-Annotations) that requests some form of follow on action. This action may be an automated [governance action](/concepts/governance-action) or, more typically, requires a steward to resolve. It is not the responsibility of the Survey Action Service to find the means to resolve the issue - it is only responsible for reporting it. + +## RequestForActionTarget relationship + +The *RequestForActionTarget* relationship identifies the [Referenceable](/types/0/0010-Base-Model) entity that needs work. It may be the asset being surveyed, or a different element. --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/types/6/0690-Request-for-Action.svg b/site/docs/types/6/0690-Request-for-Action.svg index eb6d2a51e9..25092a5950 100644 --- a/site/docs/types/6/0690-Request-for-Action.svg +++ b/site/docs/types/6/0690-Request-for-Action.svg @@ -1,4 +1,4 @@ -
0690 - Request For Action
0690 - Request For Action
«entity»
RequestForAction
«entity»...
actionSourceName : string
actionRequested : string
actionProperties : map<string, string>
actionSourceName : string...
«entity»
DataFieldAnnotation
«entity»...Text is not SVG - cannot display \ No newline at end of file +
0690 - Request For Action
«entity»
RequestForAction
actionSourceName : string
actionRequested : string
actionProperties : map<string, string>
«entity»
DataFieldAnnotation
*
actionTargetName : string
identifiedInRequestForActions
«entity»
Referenceable
requestForActionTargets
«relationship»
RequestForActionTarget
*
 \ No newline at end of file diff --git a/site/docs/types/6/area-6-discovery.drawio b/site/docs/types/6/area-6-discovery.drawio index 87a732d7ec..9ebd058c3a 100644 --- a/site/docs/types/6/area-6-discovery.drawio +++ b/site/docs/types/6/area-6-discovery.drawio @@ -1,6 +1,6 @@ - + - + @@ -569,7 +569,7 @@ - + @@ -631,7 +631,7 @@ - + @@ -1204,7 +1204,7 @@ - + @@ -1214,7 +1214,7 @@ - + @@ -1226,6 +1226,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/mkdocs.yml b/site/mkdocs.yml index e5dbaa74aa..f12fe33190 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -70,7 +70,7 @@ nav: - Apache Atlas Server: - Call API: connectors/apache-atlas/apache-atlas-rest-connector.md - Survey: connectors/apache-atlas/apache-atlas-survey-action-service.md - - Catalog: connectors/integration/apache-atlas-catalog-integration-connector.md + - Catalog: connectors/apache-atlas/apache-atlas-catalog-integration-connector.md - Governance Actions: - Generic Element Watchdog: connectors/governance-action/generic-element-watchdog-governance-action-service.md - Origin Seeker: connectors/governance-action/origin-seeker-remediation-governance-action-service.md @@ -170,7 +170,7 @@ nav: - Migration: guides/migration/migrating-configuration-documents.md - Operations: - Operate OMAG Server Platform: guides/operations/overview.md - - Operate OMAG Server Starter: guides/operations/operate-omag-server-starter.md + - Operate OMAG Server Runtime: guides/operations/operate-omag-server-starter.md - Egeria in Kubernetes: - Egeria in Kubernetes: guides/operations/kubernetes/index.md - Introduction to Kubernetes: guides/operations/kubernetes/k8s.md @@ -183,7 +183,7 @@ nav: - Coco Pharmaceuticals Lab: guides/operations/kubernetes/charts/lab.md - CTS Chart: guides/operations/kubernetes/charts/cts.md - PTS Chart: guides/operations/kubernetes/charts/pts.md - - Server Starter Chart: guides/operations/kubernetes/charts/server.md + - OMAG Server Runtime Chart: guides/operations/kubernetes/charts/server.md - Container Images: guides/operations/kubernetes/container-images.md - Custom Deployment: guides/operations/kubernetes/custom-deployment.md - Egeria Operator: guides/operations/kubernetes/operator.md @@ -281,7 +281,7 @@ nav: - Overview: getting-started/dojo/egeria-dojo-day-1-3-1-platform-set-up-and-configuration.md - Prerequisites: getting-started/dojo/egeria-dojo-day-1-3-1-1-platform-set-up-prerequisites.md - Configuring the Platform: getting-started/dojo/egeria-dojo-day-1-3-1-2-configuring-the-platform.md - - Confiiguring a Server: getting-started/dojo/egeria-dojo-day-1-3-1-3-configuring-a-server.md + - Configuring a Server: getting-started/dojo/egeria-dojo-day-1-3-1-3-configuring-a-server.md - Running Metadata Access Servers: - Overview: getting-started/dojo/egeria-dojo-day-1-3-2-running-metadata-servers.md - Starting Server: getting-started/dojo/egeria-dojo-day-1-3-2-1-starting-the-server.md @@ -814,6 +814,7 @@ nav: - Repository Helper: concepts/repository-helper.md - Repository Proxy: concepts/repository-proxy.md - Repository Validator: concepts/repository-validator.md + - Request For Action: concepts/request-for-action.md - Resource: concepts/resource.md - Resource Use: concepts/resource-use.md - REST client connector: concepts/rest-client-connector.md