Skip to content

Commit

Permalink
Merge pull request #901 from mandy-chessell/code2024
Browse files Browse the repository at this point in the history
Add code for getBasicServerProperties
  • Loading branch information
mandy-chessell committed Feb 21, 2024
2 parents 18cadb6 + 22e7ddf commit cb490f9
Show file tree
Hide file tree
Showing 47 changed files with 210 additions and 134 deletions.
2 changes: 1 addition & 1 deletion site/docs/concepts/catalog-target.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# Catalog Target

A *catalog target* describes the third party technology ([resource](/concepts/resource)) that a specific [integration connector](/concept/integration-connector) is exchanging metadata with.
A *catalog target* describes the third party technology ([digital resource](/concepts/digital-resource)) that a specific [integration connector](/concept/integration-connector) is exchanging metadata with.

## Catalog Target Types

Expand Down
2 changes: 1 addition & 1 deletion site/docs/concepts/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hide:

# Connector

A connector is a client library for accessing a [resource](/concepts/resource) and, optionally, its associated [asset](/concepts/asset) metadata.
A connector is a client library for accessing a [digital resource](/concepts/digital-resource) and, optionally, its associated [asset](/concepts/asset) metadata.

The concept of a connector comes from the [Open Connector Framework (OCF)](/frameworks/ocf/overview). The OCF provides a common framework for components (ie connectors) that enable one technology to call another, arbitrary technology through a common interface. The implementation of the connector is dynamically loaded based on the connector's configuration.

Expand Down
13 changes: 13 additions & 0 deletions site/docs/concepts/digital-resource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
hide:
- toc
---

<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# Digital Resource

A *digital resource* is a [resource](/concepts/resource) that is implemented using software (supported by hardware of course). It is catalogued in open metadata using an [Asset](/concepts/asset) and is accessed via a [digital resource connector](/concepts/digital-resource-connector).

--8<-- "snippets/abbr.md"
2 changes: 1 addition & 1 deletion site/docs/concepts/discovery-analysis-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ hide:

A *discovery analysis report* contains one or more sets of related properties that an [open discovery service](/concepts/open-discovery-service) has discovered about the resource, its metadata, structure and/or content. These are stored in a set of [discovery annotations](#discovery-annotations) linked off of the discovery analysis report.

It is attached to the [asset](/concepts/asset) for the [digital resource](/concepts/resource) that was analysed. Overtime, the discovery analysis reports show how the digital resource's contents are changing.
It is attached to the [asset](/concepts/asset) for the [digital resource](/concepts/digital-resource) that was analysed. Overtime, the discovery analysis reports show how the digital resource's contents are changing.

![Asset with discovery analysis reports](/guides/developer/open-discovery-services/asset-to-discovery-analysis-reports.svg)

Expand Down
14 changes: 7 additions & 7 deletions site/docs/concepts/governance-engine-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ A *governance engine definition* describes the [governance services](/concepts/g
There are three types of governance engine and they each support a specialist type of governance service. Therefore, the governance engine definitions include definitions of governance services that are consistent with the type of governance engine.

| Type of Governance Engine | Type of Governance Service | Description |
|---|---|---|
| [Governance action engine](/concepts/governance-action-engine) | [Governance action service](/guides/developer/governance-action-services/overview)| Monitor and manage the content of open metadata across the open metadata landscape. |
| [Open discovery engine](/concepts/open-discovery-engine)| [Open discovery service](/guides/developer/open-discovery-services/overview) | Analyze the content of [resources](/concepts/resource) in the digital landscape and create annotations that are attached to the resource's [asset](/concepts/asset) metadata element in the open metadata repositories in the form of a [discovery analysis report](/concepts/discovery-analysis-report). |
| [Repository governance engine](/concepts/repository-governance-engine) | [Repository governance service](/guides/developer/repository-governance-services/overview) | Provide additional management of the open metadata repositories that are members of the connected [cohorts](/concepts/cohort-members). |
| Type of Governance Engine | Type of Governance Service | Description |
|------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Governance action engine](/concepts/governance-action-engine) | [Governance action service](/guides/developer/governance-action-services/overview) | Monitor and manage the content of open metadata across the open metadata landscape. |
| [Survey action engine](/concepts/survey-action-engine) | [Survey action service](/guides/developer/survey-action-services/overview) | Analyze the content of [digital resources](/concepts/digital-resource) in the digital landscape and create annotations that are attached to the resource's [asset](/concepts/asset) metadata element in the open metadata repositories in the form of a [survey report](/concepts/survey-report). |
| [Repository governance engine](/concepts/repository-governance-engine) | [Repository governance service](/guides/developer/repository-governance-services/overview) | Provide additional management of the open metadata repositories that are members of the connected [cohorts](/concepts/cohort-members). |

Each governance engine definition describes a single engine and its specialized services as illustrated below.

Expand All @@ -31,8 +31,8 @@ Each governance engine definition describes a single engine and its specialized
![Governance Action Engine Definition Structure](/guides/developer/open-metadata-archives/governance-action-engine-definition.svg)
> Logical structure of a governance action engine definition showing how the governance request types map to the governance action service definitions
![Open Discovery Engine Definition Structure](/guides/developer/open-metadata-archives/open-discovery-engine-definition.svg)
> Logical structure of an open discovery engine definition showing how the governance request types map to the open discovery service definitions. Some of these services are *Open Discovery Pipelines* that control the choreography of a number of nested open discovery services
![Survey Action Engine Definition Structure](/guides/developer/open-metadata-archives/survey-action-engine-definition.svg)
> Logical structure of a survey action engine definition showing how the governance request types map to the survey action service definitions. Some of these services are *Survey Action Pipelines* that control the choreography of a number of nested survey action services.

!!! education "Further information"
Expand Down
4 changes: 2 additions & 2 deletions site/docs/concepts/governance-service-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There are ten types of governance services. Related governance services are [pa

| Governance Service | Description | Governance Engine type | Engine Service |
|:---------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------------------------------------------------------------------|
| [Survey Action Service](/guides/developer/survey-action-services/overview) | Analyses the content of an [Asset's](/concepts/asset) real-world counterpart ([resource](/concepts/resource)) in the digital landscape. (For example, if the asset describes a file, the survey action service analyses the data stored in the file). Results of the analysis are stored in a [Survey Report](/concepts/survey-report) | [Survey Action Engine](/concepts/survey-action-engine) | [Survey Action OMES](/services/omes/survey-action/overview) |
| [Survey Action Service](/guides/developer/survey-action-services/overview) | Analyses the content of an [Asset's](/concepts/asset) real-world counterpart ([digital resource](/concepts/digital-resource)) in the digital landscape. (For example, if the asset describes a file, the survey action service analyses the data stored in the file). Results of the analysis are stored in a [Survey Report](/concepts/survey-report) | [Survey Action Engine](/concepts/survey-action-engine) | [Survey Action OMES](/services/omes/survey-action/overview) |
| [Watchdog Governance Service](/guides/developer/governance-action-services/overview) | Monitors changes to open metadata elements and when certain changes occur (such as the creation of a new [Asset](/concepts/asset)) the watchdog service requests action from other governance services by creating either an [Engine Action](/concepts/engine-action), a [Governance Action Process](/concepts/governance-action-process) or an [Incident Report](/concepts/incident-report). | [Governance Action Engine](/concepts/governance-action-engine) | [Governance Action OMES](/services/omes/governance-action/overview) |
| [Verification Governance Service](/guides/developer/governance-action-services/overview) | Tests the properties of specific open metadata elements to ensure they are set up correctly or do not indicate a situation where governance activity is required. The [results](/concepts/guard) returned from the verification service can be used to trigger other governance services as part of a [Governance Action Process](/concepts/governance-action-process). | [Governance Action Engine](/concepts/governance-action-engine) | [Governance Action OMES](/services/omes/governance-action/overview) |
| [Triage Governance Service](/guides/developer/governance-action-services/overview) | Makes decisions on how to handle a specific situation or incident. Often this involves a human decision maker. | [Governance Action Engine](/concepts/governance-action-engine) | [Governance Action OMES](/services/omes/governance-action/overview) |
Expand All @@ -15,7 +15,7 @@ There are ten types of governance services. Related governance services are [pa
| [General Governance Action Service](/guides/developer/governance-action-services/overview) | Some form of governance activity. | [Governance Action Engine](/concepts/governance-action-engine) | [Governance Action OMES](/services/omes/governance-action/overview) |
| [Event Action Service](/guides/developer/event-action-services/overview) | Event management around [Context Event](/concepts/context-event). | [Event Action Engine](/concepts/event-action-engine) | [Event Action OMES](/services/omes/event-action/overview) |
| [Repository Governance Service](/guides/developer/repository-governance-services/overview) | Performs governance for open metadata repositories such as dynamically maintaining [open metadata archives](/concepts/open-metadata-archive). | [Repository Governance Engine](/concepts/repository-governance-engine) | [Repository Governance OMES](/services/omes/repository-governance/overview) |
| [Open Discovery Service](/guides/developer/open-discovery-services/overview) | Analyses the content of an [Asset's](/concepts/asset) real-world counterpart ([resource](/concepts/resource)) in the digital landscape. (For example, if the asset describes a file, the open discovery service analyses the data stored in the file). | [Open Discovery Engine](/concepts/open-discovery-engine) | [Asset Analysis OMES](/services/omes/asset-analysis/overview) |
| [Open Discovery Service](/guides/developer/open-discovery-services/overview) | Analyses the content of an [Asset's](/concepts/asset) real-world counterpart ([digital-resource](/concepts/digital-resource)) in the digital landscape. (For example, if the asset describes a file, the open discovery service analyses the data stored in the file). | [Open Discovery Engine](/concepts/open-discovery-engine) | [Asset Analysis OMES](/services/omes/asset-analysis/overview) |


--8<-- "snippets/abbr.md"
1 change: 1 addition & 0 deletions site/docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@
- [Design Model OMAS](/services/omas/design-model/overview)
- [DevOps OMAS](/services/omas/dev-ops/overview)
- [Digital Architecture OMAS](/services/omas/digital-architecture/overview)
- [Digital Resource](/concepts/digital-resource)
- [Digital Resource Connector](/concepts/digital-resource-connector)
- [Digital Service](/practices/digital-services/overview)
- [Digital Service OMAS](/services/omas/digital-service/overview)
Expand Down
2 changes: 1 addition & 1 deletion site/docs/concepts/memento.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# Memento

A *Memento* is a classification that is typically applied to an asset or related elements such as schema elements. It indicates that the element is logically deleted because it is no longer describing all or part of a [real-world resource](/concepts/resource) (typically because the resource has been deleted or changed).
A *Memento* is a classification that is typically applied to an asset or related elements such as schema elements. It indicates that the element is logically deleted because it is no longer describing all or part of a [real-world digital resource](/concepts/digital-resource) (typically because the resource has been deleted or changed).

This element has only been retained to support lineage graph queries. It will not be returned to callers unless:

Expand Down
2 changes: 1 addition & 1 deletion site/docs/concepts/open-discovery-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hide:

# Open Discovery Engines

An *open discovery engine* describes a set of related [open discovery services](/guides/developer/open-discovery-services/overview). Each open discovery service implements a specific type of analysis. This analysis is looking into the content of a [digital resource](/concepts/resource) and storing its findings in annotations within a [discovery analysis report](/concepts/discovery-analysis-report) that is linked of the resource's [Asset](/concepts/asset) in the metadata repository.
An *open discovery engine* describes a set of related [open discovery services](/guides/developer/open-discovery-services/overview). Each open discovery service implements a specific type of analysis. This analysis is looking into the content of a [digital resource](/concepts/digital-resource) and storing its findings in annotations within a [discovery analysis report](/concepts/discovery-analysis-report) that is linked of the resource's [Asset](/concepts/asset) in the metadata repository.

An open discovery engine is hosted in the [Asset Analysis Open Metadata Engine Service (OMES)](/services/omes/asset-analysis/overview) running on one or more [Engine Host OMAG Servers](/concepts/engine-host).

Expand Down
7 changes: 5 additions & 2 deletions site/docs/concepts/resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ Examples of resources include:
- Analytical models and processes.
- Addresses and other locations.
- Physical objects such as buildings that can have a digitized representation with a unique identity (for example, serial number).
- People allocated to a project.


Resources are described in open metadata as [Assets](/concepts/asset).
[Digital Resources](/concepts/digital-resource) and physical resources (such as computers, buildings etc) are described in open metadata as [Assets](/concepts/asset). People and teams are captured using [Actors and Person Roles](/features/people-roles-organizations/overview)

In addition, the organization may capture many types of descriptions and definitions that describe their operations in open metadata, such as, for example, a [glossary term](/practices/common-data-definitions/anatomy-of-a-glossary/#inside-a-glossary-term) or a [governance definition](/services/omas/governance-program/overview/#governance-definitions). These elements can be [linked to the asset](/patterns/metadata-manager/overview) to provide more information on the resource's content, significance and proper use to the people working with the resource as well as guiding automated processes that are managing and governing it.

!!! education "ResourceList relationship"
The [ResourceList](/types/0/0019-More-Information) relationship allows the list of resources allocated to a particular activity to be linked to the open metadata element that represents the activity.

--8<-- "snippets/abbr.md"
Loading

0 comments on commit cb490f9

Please sign in to comment.