Skip to content

Commit

Permalink
Merge pull request #909 from mandy-chessell/code2024
Browse files Browse the repository at this point in the history
Update SAF annotaiton names
  • Loading branch information
mandy-chessell committed Mar 8, 2024
2 parents d7b18d3 + 36e600c commit e8f8896
Show file tree
Hide file tree
Showing 52 changed files with 164 additions and 413 deletions.
1 change: 0 additions & 1 deletion site/docs/concepts/asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ Some examples:
| [Asset Consumer OMAS](/services/omas/asset-consumer/overview) | provides a service for accessing the content of an asset, extracting additional information that is known about the asset and providing feedback about the asset. It is designed for tools that consume assets to support the work of their users. These users can provide feedback on the asset description and the resource that it describes. |
| [Asset Manager OMAS](/services/omas/asset-manager/overview) | provides a service for exchanging metadata about assets and related information with a third party [asset manager](/concepts/server-capability). This API supports the many-to-many correlation of identifiers used in the third party asset manager and the open metadata ecosystem. |
| [Asset Owner OMAS](/services/omas/asset-owner/overview) | provides a service for the owner of an asset to classify and manage the asset, and understand how it is being used by the organization. |
| [Discovery Engine OMAS](/services/omas/discovery-engine/overview) | provides a service for adding annotations to an asset's information that has been determined by specific analysis of the asset's contents by a [discovery service](/concepts/open-discovery-service). |
| [Data Manager OMAS](/services/omas/data-manager/overview) | enables a data manager (such as a database or file system) to maintain information about the assets it stores. |
| [Governance Engine OMAS](/services/omas/governance-engine/overview) | provides the metadata services for [governance action services](/concepts/governance-action-service) that verify, enhance and correct the properties of assets and their associated elements. |
| [IT Infrastructure OMAS](/services/omas/it-infrastructure/overview) | provides a service for maintaining information about the IT assets and supporting infrastructure owned or used by an organization. |
Expand Down
2 changes: 1 addition & 1 deletion site/docs/concepts/connected-asset-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ AssetUniverse extends AssetDetail which extend AssetSummary. AssetUniverse adds

The [Connector Broker](/concepts/connector-broker) does not have access to a metadata repository because the OCF is metadata repository neutral. When it creates a connector, the connected asset properties are null.

Egeria Open Metadata Access Services (OMASs) such as [Asset Consumer OMAS](/services/omas/asset-consumer/overview), [Asset Owner OMAS](/services/omas/asset-owner/overview) and [Discovery Engine OMAS](/services/omas/discovery-engine/overview), include the connector broker in their clients and support APIs for managing connections and creating connectors.
The Open Metadata Access Services (OMASs) such as [Asset Consumer OMAS](/services/omas/asset-consumer/overview) and [Asset Owner OMAS](/services/omas/asset-owner/overview) include the connector broker in their clients and support APIs for managing connections and creating connectors.

Connectors created by the Egeria access services will include the Connected Asset Properties object configured to retrieve metadata from the same open metadata repository where the OMAS is running.

Expand Down
30 changes: 0 additions & 30 deletions site/docs/concepts/discovery-analysis-report.md

This file was deleted.

2 changes: 1 addition & 1 deletion site/docs/concepts/governance-action-process-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Governance actions from the same governance action processes can run in parallel
> **Example 1:** Governance Action Process to validate and augment a newly created asset
Governance action processes can include any [type of governance service](/concepts/governance-service).
Example 2 shows an [open discovery service](/concepts/open-discovery-service) amongst the [governance action services](/concepts/governance-action-service).
Example 2 shows an [survey action service](/concepts/survey-action-service) amongst the [governance action services](/concepts/governance-action-service).

![Example 2](/concepts/governance-action-process-example-2.svg)
> **Example 2:** Governance Action Process to validate and augment a newly created asset
Expand Down
10 changes: 5 additions & 5 deletions site/docs/concepts/governance-service-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,11 @@ Many of the values for the governance service definition can be gleaned from the

The possible subtypes of *GovernanceService* are determined from the `connectorInterfaces` shown in the connector type from the connector provider.

| Connector Interface | SubType of *GovernanceService* |
|-----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| `org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionService` | [GovernanceActionService](/types/4/0461-Governance-Engines) |
| `org.odpi.openmetadata.frameworks.discovery.OpenDiscoveryService` | [OpenDiscoveryService](/types/6/0601-Open-Discovery-Engine) or [OpenDiscoveryPipeline](/types/6/0601-Open-Discovery-Engine) |
| `org.odpi.openmetadata.engineservices.repositorygovernance.connector.RepositoryGovernanceService` | [RepositoryGovernanceService](/types/4/0461-Governance-Engines) |
| Connector Interface | SubType of *GovernanceService* |
|---------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| `org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionService` | [GovernanceActionService](/types/4/0461-Governance-Engines) |
| `org.odpi.openmetadata.frameworks.surveyaction.SurveyActionService` | [SurveyActionService](/types/4/0461-Governance-Engines) |
| `org.odpi.openmetadata.engineservices.repositorygovernance.connector.RepositoryGovernanceService` | [RepositoryGovernanceService](/types/4/0461-Governance-Engines) |


*GovernanceService* is a type of [Asset](/concepts/asset) and so is linked to the connection entity using the [ConnectionToAsset](/types/2/0205-Connection-Linkage) relationship.
Expand Down
13 changes: 0 additions & 13 deletions site/docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
- [Log Message](/concepts/asset-log-message)
- [Open Metadata Type](/types/0/0010-Base-Model)

- [Asset Analysis OMES](/service/omes/asset-analysis/overview)
- [Asset Catalog OMAS](/services/omas/asset-catalog/overview)
- [Asset Consumer OMAS](/services/omas/asset-consumer/overview)
- [Asset Catalog OMAS](/services/omas/asset-catalog/overview)
Expand Down Expand Up @@ -93,18 +92,6 @@
- [Digital Service](/practices/digital-services/overview)
- [Digital Service OMAS](/services/omas/digital-service/overview)
- [Discovery (metadata)](/features/discovery-and-stewardship/overview)
- [Discovery Analysis Report](/concepts/discovery-analysis-report)
- [Discovery Annotation](/concepts/discovery-analysis-report/#discovery-annotations)
- [Discovery Annotation Store](/guides/developer/open-discovery-services/overview/#discovery-context)
- [Discovery Asset Catalog Store](/guides/developer/open-discovery-services/overview/#discovery-context)
- [Discovery Asset Store](/guides/developer/open-discovery-services/overview/#discovery-context)
- [Discovery Configuration Server](/services/omas/governance-engine/overview)
- [Discovery Context](/guides/developer/open-discovery-services/overview/#discovery-context)
- [Discovery Engine](/concepts/open-discovery-engine)
- [Discovery Engine OMAS](/services/omas/discovery-engine/overview)
- [Discovery Pipeline](/concepts/open-discovery-service/#open-discovery-pipeline)
- [Discovery Server](/concepts/engine-host)
- [Discovery Service](/concepts/open-discovery-service)
- [Display Integrator OMIS](/services/omis/display-integrator/overview)
- [Dynamic Integration Group](/concepts/integration-group)

Expand Down
27 changes: 0 additions & 27 deletions site/docs/concepts/open-discovery-engine.md

This file was deleted.

22 changes: 0 additions & 22 deletions site/docs/concepts/open-discovery-service.md

This file was deleted.

4 changes: 2 additions & 2 deletions site/docs/concepts/survey-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ A *survey report* contains one or more sets of related properties that a [survey

The survey report is attached to the [asset](/concepts/asset) for the [digital resource](/concepts/digital-resource) that was analysed. Over time, the survey reports show how the digital resource's contents are changing.

![Asset with discovery analysis reports](/frameworks/saf/asset-to-survey-reports.svg)
![Asset with survey reports](/frameworks/saf/asset-to-survey-reports.svg)

The survey report is created in the open metadata repository by the [Survey Action OMES](/services/omes/survey-action/overview) when it creates an new survey action service instance. The survey action service can retrieve information about the survey report through the [survey context](/guides/developer/open-discovery-services/overview/#discovery-analysis-report-store).
The survey report is created in the open metadata repository by the [Survey Action OMES](/services/omes/survey-action/overview) when it creates an new survey action service instance. The survey action service can retrieve information about the survey report through the [survey context](/guides/developer/survey-action-services/overview).

## Annotations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ The Apache Atlas Survey Action Service provides a summary of the contents of the

It has three analysis steps:

1. Measure Resource - Retrieves the overall metrics from the Apache Atlas server. These are stored in a [*DataSourceMeasurementAnnotation*](/types/0660-Data-Source-Measurement) entity linked to the [*SurveyReport*](/types/6/0603-Survey-Reports) entity generated for each run of the Apache Atlas Survey Action Service.
1. Measure Resource - Retrieves the overall metrics from the Apache Atlas server. These are stored in a [*ResourceMeasureAnnotation*](/types/0660-Resource-Measures) entity linked to the [*SurveyReport*](/types/6/0603-Survey-Reports) entity generated for each run of the Apache Atlas Survey Action Service.
2. Schema Extraction - Retrieves the types from Apache Atlas and organizes them in a linked graph of [*Schema Attributes*](/types/5/0533-Graph-Schemas) entities. All the graph schema attributes are linked to a [*GraphSchemaType*](/types/5/0533-Graph-Schemas) entity which is in turn linked to the [*SurveyReport*](/types/6/0603-Survey-Reports) entity.
3. Profile Data - Retrieves each entity in the Apache Atlas server and adds the following counts to [*DataProfileAnnotation*](/types/6/0620-Data-Profiling) entities linked from the appropriate data field entities:
3. Profile Data - Retrieves each entity in the Apache Atlas server and adds the following counts to [*ResourceProfileAnnotation*](/types/6/0620-Resource-Profiling) entities linked from the appropriate data field entities:

* The number of instances of each entity type.
* The number of classifications of a particular type attached to each type of entity.
Expand Down
6 changes: 3 additions & 3 deletions site/docs/connectors/discovery/discovery-service-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ An *open discovery service* is a component that performs specific analysis of th

Each time an open discovery service runs, it creates a new [discovery analysis report](/concepts/discovery-analysis-report) linked off of the digital resource's [Asset](/concepts/asset) metadata element that records the results of the analysis.

![Asset with discovery analysis reports](/guides/developer/open-discovery-services/asset-to-discovery-analysis-reports.svg)
> Each time an open discovery service runs to analyse a digital resource, a new discovery analysis report is created and attached to the resource's asset. If the open discovery service is run regularly, it is possible to track how the contents are changing over time.
![Asset with discovery analysis reports](/guides/developersurvey-action-services/asset-to-survey-reports.svg)
> Each time a survey action service runs to analyse a digital resource, a new survey report is created and attached to the resource's asset. If the survey action service is run regularly, it is possible to track how the contents are changing over time.
The *discovery analysis report* contains one or more sets of related properties that the discovery service has discovered about the resource, its metadata, structure and/or content. These are stored in a set of [*discovery annotations*](/concepts/discovery-analysis-report/#discovery-annotations) linked off of the discovery analysis report.
The *discovery analysis report* contains one or more sets of related properties that the discovery service has discovered about the resource, its metadata, structure and/or content. These are stored in a set of [*annotations*](/concepts/survey-report) linked off of the survey report.

An open discovery service is designed to run at regular intervals to gather a detailed perspective on the contents of the digital resource and how they are changing over time. Each time it runs, it is given access to the results of previously run open discovery services, along with a review of these findings made by individuals responsible for the digital resource (such as stewards, owners, custodians).

Expand Down
Loading

0 comments on commit e8f8896

Please sign in to comment.