From 738052114d106b20169982957bb94142c353efe3 Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Wed, 24 Jan 2024 09:48:08 +0000 Subject: [PATCH] Fix formatting and typos in release notes Signed-off-by: Mandy Chessell --- .../governance-action-process-intro.md | 8 +-- site/docs/concepts/governance-action-type.md | 5 +- site/docs/concepts/guard.md | 2 +- site/docs/concepts/index.md | 2 +- .../discovery-and-stewardship/overview.md | 2 +- .../features/lineage-management/overview.md | 2 +- .../synchronized-access-control/overview.md | 2 +- ...onfiguring-omag-server-basic-properties.md | 56 ++++++++++--------- .../governance-action-services/overview.md | 2 +- site/docs/release-notes/5-0.md | 22 +++++--- .../omas/governance-engine/overview.md | 6 +- .../omes/repository-governance/overview.md | 2 +- site/docs/types/0/0021-Collections.md | 2 +- .../4/0462-Governance-Action-Processes.md | 2 +- site/mkdocs.yml | 2 + 15 files changed, 65 insertions(+), 52 deletions(-) diff --git a/site/docs/concepts/governance-action-process-intro.md b/site/docs/concepts/governance-action-process-intro.md index cccf1fd435..e347cec7de 100644 --- a/site/docs/concepts/governance-action-process-intro.md +++ b/site/docs/concepts/governance-action-process-intro.md @@ -2,7 +2,7 @@ -A *governance action process* is a predefined sequence of [engine actions](/concepts/engine-action that are coordinated by the [Governance Engine OMAS](/services/omas/governance-engine/overview). +A *governance action process* is a predefined sequence of [engine actions](/concepts/engine-action) that are coordinated by the [Governance Engine OMAS](/services/omas/governance-engine/overview). The steps in a governance action process are defined by linked [governance action process steps](/concepts/governance-action-process-step) stored in the open metadata ecosystem. Each governance action process step provides the specification of the governance action to run. The links between them show which [guards](/concepts/guard) cause the next step to be chosen and hence, the governance action to run. @@ -31,13 +31,13 @@ Example 2 shows an [open discovery service](/concepts/open-discovery-service) am ## Capturing lineage for a governance action process -The [engine actions](/concepts/engine-action generated when a governance action process runs provide a complete audit trace of the governance services that ran and their results. The [Governance Action Open Lineage Integration Connector](/connectors/integration/governance-action-open-lineage-integration-connector) is able to monitor the operation of the governance actions and produce [OpenLineage events](/features/lineage-management/overview/#the-openlineage-standard) to provide operational lineage for governance action processes. Egeria is also able to [capture these events](/connectors/#capturing-and-publishing-lineage) (along with OpenLineage events from other technologies) for later analysis. +The [engine actions](/concepts/engine-action) generated when a governance action process runs provide a complete audit trace of the governance services that ran and their results. The [Governance Action Open Lineage Integration Connector](/connectors/integration/governance-action-open-lineage-integration-connector) is able to monitor the operation of the governance actions and produce [OpenLineage events](/features/lineage-management/overview/#the-openlineage-standard) to provide operational lineage for governance action processes. Egeria is also able to [capture these events](/connectors/#capturing-and-publishing-lineage) (along with OpenLineage events from other technologies) for later analysis. ## Governance Action Process Lifecycle The diagram below shows a governance action process assembly tool taking in information from a [governance engine pack](/concepts/governance-engine-pack) to build a governance action process flow. This is shared with the open metadata ecosystem either through direct called to the [Governance Engine OMAS](/services/omas/governance-engone/overview) or via a [open metadata archive](/concepts/open-metadata-archive) (possibly the archive that holds the governance engine definition. -Once the definition of the governance action process is available, an instance of the process can be started, either by a [watchdog governance action service](/concepts/governance-action-service) or through a direct call to the Governance Engine OMAS. Whichever mechanism is used, it results in the Governance Engine OMAS using the definition to choreograph the creation of [engine action](/concepts/engine-action entities that drive the execution of the governance services in the [Engine Host](/concepts/engine-host). +Once the definition of the governance action process is available, an instance of the process can be started, either by a [watchdog governance action service](/concepts/governance-action-service) or through a direct call to the Governance Engine OMAS. Whichever mechanism is used, it results in the Governance Engine OMAS using the definition to choreograph the creation of [engine action](/concepts/engine-action) entities that drive the execution of the governance services in the [Engine Host](/concepts/engine-host). ![Lifecycle](/concepts/governance-action-process-lifecycle.svg) @@ -45,6 +45,6 @@ Once the definition of the governance action process is available, an instance o !!! education "Further information" - The [0462 Governance Action Processes](/types/4/0462-Governance-Action-Processes) model shows how the governance action process flow is built out of [governance action process steps](/concepts/governance-action-process-step). - Governance action processes may be created using the [Governance Engine OMAS](/services/omas/governance-engine/overview) API. - - The [Open Metadata Engine Services (OMES)](/services/omes) provide the mechanisms that support the different types of [governance engines](/concepts/governance-engine). These engines run the [governance services](/concepts/governance-service) that execute the [engine actions](/concepts/engine-action defined by the governance action process. + - The [Open Metadata Engine Services (OMES)](/services/omes) provide the mechanisms that support the different types of [governance engines](/concepts/governance-engine). These engines run the [governance services](/concepts/governance-service) that execute the [engine actions](/concepts/engine-action) defined by the governance action process. diff --git a/site/docs/concepts/governance-action-type.md b/site/docs/concepts/governance-action-type.md index 0b94e298d4..55b7f76307 100644 --- a/site/docs/concepts/governance-action-type.md +++ b/site/docs/concepts/governance-action-type.md @@ -4,6 +4,9 @@ # Governance Action Type -Governance Action Type has been renamed to [Governance Action Process Step](/concepts/governance-action-process-step) +A *Governance Action Type* is a template that describes a call to a [governance engine](/concepts/governance-engine). Through the [open governance service](/services/gaf-metadata-management), it is possible to use the governance action type to initiate the specified call to the governance engine. The result is the creation of an [engine action](/concepts/engine-action) that controls the execution of the call. + +!!! education "Properties of a governance action type" + The open metadata type definition for the governance action type is in model [0462 Governance Action Processes](/types/4/0462-Governance-Action-Processes). --8<-- "snippets/abbr.md" diff --git a/site/docs/concepts/guard.md b/site/docs/concepts/guard.md index 7006f48430..0b6860f77e 100644 --- a/site/docs/concepts/guard.md +++ b/site/docs/concepts/guard.md @@ -6,7 +6,7 @@ Guards are labels that are created by [governance services](/concepts/governance-service) and are used by the [Governance Engine OMAS](/services/omas/governance-engine/overview) to -determine which [engine action](/concepts/engine-action to run next. +determine which [engine action](/concepts/engine-action) to run next. --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/concepts/index.md b/site/docs/concepts/index.md index 4cf382d04d..18caea9b91 100644 --- a/site/docs/concepts/index.md +++ b/site/docs/concepts/index.md @@ -156,7 +156,7 @@ - [Glossary](/practices/common-data-definitions/anatomy-of-a-glossary) - [Glossary Category](/practices/common-data-definitions/anatomy-of-a-glossary/#glossary-categories) - [Glossary Term](/practices/common-data-definitions/anatomy-of-a-glossary/#inside-a-glossary-term) -- [Governance Action](/concepts/engine-action) +- [Governance Action](/concepts/governance-action) - [Governance Action Engine](/concepts/governance-action-engine) - [Governance Action OMES](/service/omes/governance-action/overview) - [Governance Action Framework (GAF)](/frameworks/gaf/overview) diff --git a/site/docs/features/discovery-and-stewardship/overview.md b/site/docs/features/discovery-and-stewardship/overview.md index 5827fa5913..1e23d32f56 100644 --- a/site/docs/features/discovery-and-stewardship/overview.md +++ b/site/docs/features/discovery-and-stewardship/overview.md @@ -55,7 +55,7 @@ Schema extraction uses the [schema analysis annotation](/types/6/0615-Schema-Ext ![Open discovery schema extraction](/guides/developer/open-discovery-services/open-discovery-schema-extraction.svg) -The schema of the data in the digital resource is defined in a *SchemaType* linked from the digital resource's asset using the *AssetSchemaType* relationship. This may be established before the open discovery service runs, or may be derived by an [engine action](/concepts/engine-action once the open discovery service has run. +The schema of the data in the digital resource is defined in a *SchemaType* linked from the digital resource's asset using the *AssetSchemaType* relationship. This may be established before the open discovery service runs, or may be derived by an [engine action](/concepts/engine-action) once the open discovery service has run. If the schema is defined, the open discovery service that creates the data fields may maintain relationships between the schema and the data fields: diff --git a/site/docs/features/lineage-management/overview.md b/site/docs/features/lineage-management/overview.md index badd273dd7..b3f79b51da 100644 --- a/site/docs/features/lineage-management/overview.md +++ b/site/docs/features/lineage-management/overview.md @@ -257,7 +257,7 @@ The numbers on the diagram refer to the notes below. 3. The [OpenLineage Event Receiver](/connectors/integration/open-lineage-event-receiver-integration-connector) integration connector is receiving OpenLineage events from the Kafka topic. It passes them to the Lineage Integrator OMIS's context manager via its own context. -4. The [Governance Action OpenLineage](/connectors/integration/governance-action-open-lineage-integration-connector) integration connector has registered a listener to receive events about the [engine actions](/concepts/engine-action that are being processed in the open metadata ecosystem. +4. The [Governance Action OpenLineage](/connectors/integration/governance-action-open-lineage-integration-connector) integration connector has registered a listener to receive events about the [engine actions](/concepts/engine-action) that are being processed in the open metadata ecosystem. 5. The Governance Action OpenLineage integration connector creates OpenLineage events to represent the processing by the governance actions and passes them to the Lineage Integrator OMIS's context manager via its own context. diff --git a/site/docs/features/synchronized-access-control/overview.md b/site/docs/features/synchronized-access-control/overview.md index ee9e3d283a..5a93d1179c 100644 --- a/site/docs/features/synchronized-access-control/overview.md +++ b/site/docs/features/synchronized-access-control/overview.md @@ -16,7 +16,7 @@ There are many factors that influence who should have access to a digital servic Egeria enables all of this information to be assembled and linked together at multiple levels - for example a database column may be linked to a glossary term called employee-salary that is in turn classified as sensitive personal information (SPI). -Security managers, such as Apache Ranger, however just needs to know that the column is SPI. So [engine actions](/concepts/engine-action convert this complex model into something much more operationally-focused in the form of *security tags*. The security tags attached to the schemas are all that needs to be distributed to the security managers. +Security managers, such as Apache Ranger, however just needs to know that the column is SPI. So [engine actions](/concepts/engine-action) convert this complex model into something much more operationally-focused in the form of *security tags*. The security tags attached to the schemas are all that needs to be distributed to the security managers. ## Representing security tags diff --git a/site/docs/guides/admin/servers/configuring-omag-server-basic-properties.md b/site/docs/guides/admin/servers/configuring-omag-server-basic-properties.md index 3096180ad4..8af557dd46 100644 --- a/site/docs/guides/admin/servers/configuring-omag-server-basic-properties.md +++ b/site/docs/guides/admin/servers/configuring-omag-server-basic-properties.md @@ -31,33 +31,35 @@ The server type name should be set to something that describes the OMAG Server's If you have no specific value to set the server type name to, we recommend that you set the server type name to null. This will cause the server start up process will derive a standard server type name based on the rest of the configuration for the server. -!!! post "POST - setBasicServerProperties" -``` -{{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-properties" -``` -The request body contains the properties to set. - -| Property | Description | -|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| *localServerDescription* | Description for the server. This is useful information for the administrator to understand the role of the server. The default value is `null`. | -| *organizationName* | Descriptive name for the organization that owns the local server/repository. This is useful when the open metadata repository cluster consists of metadata servers from different organizations, or different departments of an enterprise. The default value is `null`. | -| *localServerURL* | The *platformURLRoot* for the platform where this server is to run. For example `https://localhost:9443`. It is used if the server connects to a [cohort](/concepts/cohort-member). | -| *localServerUserId* | UserId to use for server-initiated REST calls. The default is `OMAGServer`. | -| *localServerPassword* | Password to use for server-initiated REST calls. The default is `null`. This means that only the userId is sent in the HTTP header. | -| *maxPageSize* | The maximum page size that can be set on requests to the server. The default value is `1000`. A value of zero means unlimited page size. Although supported, the zero value is not recommended because it provides no protection from a large request denial of service attack. | - -For example: - -```json -{ - "localServerDescription" : "This server supports the governance teams", - "organizationName" : "Coco Pharmaceuticals", - "localServerURL" : "https://localhost:9443", - "localServerUserId" : "cocomds2npa", - "localServerPassword" : "secret", - "maxPageSize" : 600 -} -``` +???+ post "POST - setBasicServerProperties" + ``` + {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-properties" + ``` + The request body contains the properties to set. + + | Property | Description | + |--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | *localServerDescription* | Description for the server. This is useful information for the administrator to understand the role of the server. The default value is `null`. | + | *organizationName* | Descriptive name for the organization that owns the local server/repository. This is useful when the open metadata repository cluster consists of metadata servers from different organizations, or different departments of an enterprise. The default value is `null`. | + | *localServerURL* | The *platformURLRoot* for the platform where this server is to run. For example `https://localhost:9443`. It is used if the server connects to a [cohort](/concepts/cohort-member). | + | *localServerUserId* | UserId to use for server-initiated REST calls. The default is `OMAGServer`. | + | *localServerPassword* | Password to use for server-initiated REST calls. The default is `null`. This means that only the userId is sent in the HTTP header. | + | *maxPageSize* | The maximum page size that can be set on requests to the server. The default value is `1000`. A value of zero means unlimited page size. Although supported, the zero value is not recommended because it provides no protection from a large request denial of service attack. | + + For example: + + ```json + { + "localServerDescription" : "This server supports the governance teams", + "organizationName" : "Coco Pharmaceuticals", + "localServerURL" : "https://localhost:9443", + "localServerUserId" : "cocomds2npa", + "localServerPassword" : "secret", + "maxPageSize" : 600 + } + ``` + +Alternatively, you can set these properties one at a time. ### Set server description diff --git a/site/docs/guides/developer/governance-action-services/overview.md b/site/docs/guides/developer/governance-action-services/overview.md index ab79d8628c..ac3774822f 100644 --- a/site/docs/guides/developer/governance-action-services/overview.md +++ b/site/docs/guides/developer/governance-action-services/overview.md @@ -106,7 +106,7 @@ The connector provider for your governance action service provides the factory m Below is the implementation of the connector provider for the [Move Copy File Provisioning Governance Action Service](/connectors/governance-action/move-copy-file-provisioning-governance-action-service). This is a highly configurable governance action service that can be instructed to move, copy or delete a file, and has different styles of lineage it can create. The action it performs is supplied in the governance request type. The source file and destination folder can be supplied either through the request parameters or as action targets. There are two guards: "provisioning-complete" for success and "provisioning-failed" if something went wrong. -The methods of the connector provider enables a tool that is configuring [engine actions](/concepts/engine-action or [governance action processes](/concepts/governance-action-process) to query the capabilities of the corresponding governance action service. +The methods of the connector provider enables a tool that is configuring [engine actions](/concepts/engine-action) or [governance action processes](/concepts/governance-action-process) to query the capabilities of the corresponding governance action service. ```java public class MoveCopyFileGovernanceActionProvider extends GovernanceActionServiceProviderBase diff --git a/site/docs/release-notes/5-0.md b/site/docs/release-notes/5-0.md index 6e0dda3759..302fde1677 100644 --- a/site/docs/release-notes/5-0.md +++ b/site/docs/release-notes/5-0.md @@ -7,11 +7,11 @@ _**These are DRAFT release notes. The notes will be updated until & when 5.0 is Release 5.0 is a major functional release focused on usability, both from the point of view of the first-time user of Egeria, and developers of the code. It has six themes: -* *Simplified up and running* - improvements to the OMAG Server Platform and administration services to make it easier to set up and run, plus new sample server configurations, and a python client for administration calls. +* *Simplified up and running* - improvements to the OMAG Server Platform and administration services to make it easier to set up and run, plus new sample server configurations, and a python client for basic administration calls. * *Content pack of connector metadata* - metadata to pre-configure the connectors supplied with Egeria, and provide valid value sets describing technology types and file types. * *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 infrastructure to understand its contents before embarking on wholesale cataloguing and governance. +* *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. @@ -29,8 +29,8 @@ Release 5.0 is a major functional release focused on usability, both from the po * There are new lineage relationships called [*UltimateSource*](/types/7/0755-Ultimate-Source-Destination) and [*UltimateDestination*](/types/7/0755-Ultimate-Source-Destination) can be used to capture the size and edges of an element's lineage graph have been added. * The *GroupedMedia* relationship is deprecated in favour of [*DataContentForDataSet*](/types/2/0210-Data-Stores). * The [*DataFile*](/types/2/0220-Files-and-Folders) type has a attribute called *fileExtension*. New types that inherit from *DataFile* have been defined for a wide range of file types: [*SpreadsheetFile*](/types/2/0220-Files-and-Folders), [*XMLFile*](/types/2/0220-Files-and-Folders), [*AudioFile*](/types/2/0221-Document-Stores), [*VideoFile*](/types/2/0221-Document-Stores), [*3DImageFile*](/types/2/0221-Document-Stores), [*RasterFile*](/types/2/0221-Document-Stores), [*VectorFile*](/types/2/0221-Document-Stores), [*SourceCodeFile*](/types/2/0280-Software-Development-Assets), [*ExecutableFile*](/types/2/0280-Software-Development-Assets), [*ScriptFile*](/types/2/0280-Software-Development-Assets), [*BuildInstructionFile*](/types/2/0280-Software-Development-Assets), [*YAMLFile*](/types/2/0280-Software-Development-Assets), [*PropertiesFile*](/types/2/0280-Software-Development-Assets), and [*ArchiveFile*](/types/2/0226-Archive-Files). There is also a new relationship called [*ArchiveFileContents*](/types/2/0226-Archive-Files) to identify the contents of an archive file. - * There are new attribute called *isCaseSensitive* and *category* for [*ValidValueDefinition*](/types/5/0545-Reference-Data) that provides additional information used to match valid values. In addition, there are two new types of valid value relationship: *ValidValueAssociation* and *ConsistentValidValues*. - * The [*ConnectorType*](/types/2/0201-Connectors-and-Connections) entity has new attribute called *deployedImplementationType* to allow a connector writer to record the [deployed implementation type](/concepts/deployed-implementation-type) that the connector works with. + * There are new attributes called *isCaseSensitive* and *category* for [*ValidValueDefinition*](/types/5/0545-Reference-Data) that provides additional information used to match valid values. In addition, there are two new types of valid value relationship: *ValidValueAssociation* and *ConsistentValidValues*. + * The [*ConnectorType*](/types/2/0201-Connectors-and-Connections) entity has a new attribute called *deployedImplementationType* to allow a connector writer to record the [deployed implementation type](/concepts/deployed-implementation-type) that the connector works with. ??? warning "XTDB repository connector are now in egeria.git" The XTDB repository connector is now located in the core Egeria git repository which means it is always available in the containers and distributions. This change is in recognition that XTDB is our premier metadata repository. There are three new administration commands to simplify the configuration of an XTDB repository. @@ -39,7 +39,7 @@ Release 5.0 is a major functional release focused on usability, both from the po * Configure XTDB with a local file-based key-value store * Configure XTDB with a connection, allowing more complex configurations to be set up - 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. + 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. @@ -52,13 +52,13 @@ Release 5.0 is a major functional release focused on usability, both from the po 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 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*, and *maxPageSize*. The new called are described in the [Administration Guide](/guides/admin/servers/configuring-a-metadata-access-store/#set-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 called are described in the [Administration Guide](/guides/admin/servers/configuring-a-metadata-access-store/#set-basic-server-properties). ??? 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. ??? 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. + 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. @@ -148,9 +148,15 @@ Release 5.0 is a major functional release focused on usability, both from the po 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). + 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 "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. +??? functional "IntelliJ HTTP Client" + The `omag-server-platform` assembly created during an egeria build now includes script files that exercise Egeria's REST API services using IntelliJ's HTTP Client. These mirror the Postman collections that are also found in the assembly. + +??? 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. + --8<-- "snippets/abbr.md" diff --git a/site/docs/services/omas/governance-engine/overview.md b/site/docs/services/omas/governance-engine/overview.md index cc60d3e45f..3c467f704e 100644 --- a/site/docs/services/omas/governance-engine/overview.md +++ b/site/docs/services/omas/governance-engine/overview.md @@ -26,9 +26,9 @@ The Governance Engine OMAS has the following capabilities to support governance | [GovernanceEngineConfiguration](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceEngineConfiguration.html) | Creating the definitions for [governance engines](/concepts/governance-engine) and their [governance services](/concepts/governance-service). | | [GovernanceEngineEventInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceEngineEventInterface.html) | Providing the events that enable the Engine Host OMAG Server to be notified of any changes to governance actions, governance engines and governance services. It also provides support for the watchdog events. | | [GovernanceProcessingInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceProcessingInterface.html) | Providing the APIs that enable the Engine Host OMAG Server to retrieve the definitions of the governance engines and services. | -| [GovernanceActionProcessInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceActionProcessInterface.html) | Creating the definitions for [governance action processes](/concepts/governance-action-process) that control the sequencing of [engine actions](/concepts/engine-action. | -| [GovernanceProcessingInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceProcessingInterface.html) | Providing APIs to initiate [engine actions](/concepts/engine-action and [governance action processes](/concepts/governance-action-process) explicitly. | -| [GovernanceEngineEventListener](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceEngineEventListener.html) | Notification of new [engine actions](/concepts/engine-action to the Engine Host OMAG Servers that then invoke the appropriate governance services to action them. | +| [GovernanceActionProcessInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceActionProcessInterface.html) | Creating the definitions for [governance action processes](/concepts/governance-action-process) that control the sequencing of [engine actions](/concepts/engine-action. | +| [GovernanceProcessingInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceProcessingInterface.html) | Providing APIs to initiate [engine actions](/concepts/engine-action) and [governance action processes](/concepts/governance-action-process) explicitly. | +| [GovernanceEngineEventListener](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceEngineEventListener.html) | Notification of new [engine actions](/concepts/engine-action) to the Engine Host OMAG Servers that then invoke the appropriate governance services to action them. | | [MetadataElementInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/commonservices/gaf/api/MetadataElementInterface.html) | Supporting the metadata requirements for many of the [engine services](/services/omes). | | [GovernanceEngineConfiguration](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceEngineConfiguration.html) | Providing APIs to query the status of the governance capabilities implemented through the governance engines. | | [SpecialGovernanceActionInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/SpecialGovernanceActionInterface.html) | Providing specialized governance remediation APIs such as linking duplicates. | diff --git a/site/docs/services/omes/repository-governance/overview.md b/site/docs/services/omes/repository-governance/overview.md index 69f37f19df..b47fe919f6 100644 --- a/site/docs/services/omes/repository-governance/overview.md +++ b/site/docs/services/omes/repository-governance/overview.md @@ -22,6 +22,6 @@ The definitions for both the repository governance engines and their linked serv When the Repository Governance OMES is configured in the engine host, a list of repository governance engine names is supplied. These names are used to retrieve the governance engine definitions for the archive engines in order to configure the Repository Governance OMES. -The Repository Governance OMES is responsible for initializing the repository governance engines and providing the context and runtime environment for the repository services when they are requested through the [engine action](/concepts/engine-action processing of the [Governance Engine OMAS](/services/omas/governance-engine/overview). +The Repository Governance OMES is responsible for initializing the repository governance engines and providing the context and runtime environment for the repository services when they are requested through the [engine action](/concepts/engine-action) processing of the [Governance Engine OMAS](/services/omas/governance-engine/overview). --8<-- "snippets/abbr.md" diff --git a/site/docs/types/0/0021-Collections.md b/site/docs/types/0/0021-Collections.md index 49ba3c1df3..ea90dce822 100644 --- a/site/docs/types/0/0021-Collections.md +++ b/site/docs/types/0/0021-Collections.md @@ -97,7 +97,7 @@ The values for the *MembershipStatus* enumeration are: * *Obsolete* - The membership must no longer be used. * *Other* - Another membership status that is set up in the *userDefinedStatus* attribute. -They can be used to support a simple stewardship workflow. For example, consider an [engine action](/concepts/engine-action that scans through the [assets](/concepts/asset) examining each one's [Retention](/types/4/0422-Governance-Action-Classifications) classification. If the values in the classification indicate that the [resource](/concepts/resource) that it represents should be archived, it may link the asset into a collection. +They can be used to support a simple stewardship workflow. For example, consider an [engine action](/concepts/engine-action) that scans through the [assets](/concepts/asset) examining each one's [Retention](/types/4/0422-Governance-Action-Classifications) classification. If the values in the classification indicate that the [resource](/concepts/resource) that it represents should be archived, it may link the asset into a collection. ![Candidate assets for archive](archive-candidate-collection.svg) diff --git a/site/docs/types/4/0462-Governance-Action-Processes.md b/site/docs/types/4/0462-Governance-Action-Processes.md index c59e1bd44b..7ecb04918a 100644 --- a/site/docs/types/4/0462-Governance-Action-Processes.md +++ b/site/docs/types/4/0462-Governance-Action-Processes.md @@ -8,7 +8,7 @@ The types on this page describe how to create reusable "templates" that are used * A [governance action type](/concepts/governance-action-type) describes a single step action. * A [governance action process](/concepts/governance-action-process) describes a sequence of steps in a process flow. The process flow is defined in open metadata so that it can be shared with processing engines throughout the open metadata ecosystem. -In Egeria, the [Governance Engine OMAS](/services/omas/governance-engine/overview) provides services for defining governance action types and process flows and is responsible for converting each step in the flow into an [engine action](/concepts/engine-action) when the process executes. +In Egeria, the [Open Governance Service](/services/gaf-metadata-management) provides services for defining governance action types and process flows and is responsible for converting each step in the flow into an [engine action](/concepts/engine-action) when the process executes. ![UML](0462-Governance-Action-Processes.svg) diff --git a/site/mkdocs.yml b/site/mkdocs.yml index 613a518a5d..35fd3d937a 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -709,10 +709,12 @@ nav: - File Type: concepts/file-type.md - Glossary Term: practices/common-data-definitions/anatomy-of-a-glossary.md - GUID: concepts/guid.md + - Governance Action: concepts/governance-action.md - Governance Action Engine: concepts/governance-action-engine.md - Governance Action Process: concepts/governance-action-process.md - Governance Action Process Step: concepts/governance-action-process-step.md - Governance Action Service: concepts/governance-action-service.md + - Governance Action Type: concepts/governance-action-type.md - Governance Domain: concepts/governance-domain.md - Governance Engine: concepts/governance-engine.md - Governance Engine Definition: concepts/governance-engine-definition.md