Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update descriptions of anchors #932

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions site/docs/concepts/anchor.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,20 @@ hide:

# Anchor

An *anchor* is a [Referenceable](/concepts/referenceable) metadata entity that
groups other entities together as if they were logically a part of the anchor.
This means, for example, if the anchor entity is deleted then
the entities anchored to this entity are also deleted.
An *anchor* is a metadata element that is the root of a group of linked elements that should be processed as if they were logically a part of the same "object".

The value of establishing this grouping is to ensure that entities that have little meaning without their
anchor entity are cleaned up properly and are not left to uselessly clutter the repository.
For example, an [asset](/concepts/asset) may be linked to its [schema](/concepts/schema), a [connection](/concepts/connection) and a [glossary term](/practices/common-data-definitions/anatomy-of-a-glossary). The schema and connection would typically be anchored to the asset since they only have meaning in the context of the asset. The glossary term is independent of the asset, since it can be used in many other contexts. Therefore the glossary term would not be part of the asset's anchor grouping.

The value of establishing this *anchor grouping* is to ensure that elements that have little meaning without their anchor are managed consistently. There are four main use cases for the anchor grouping:

* *Security* - when elements within the anchor group are created, updated, deleted or accessed, the security check is whether the user has access to the anchor element.
* *Deleting* - when the anchor element is deleted, all of the other elements in the anchor grouping are deleted as well. This ensures anchored elements are cleaned up properly and are not left to uselessly clutter the repository.
* *Templated cataloguing* - when a new element is created from a [template](/concepts/template), all the linked elements anchored to the template are copied. Other elements linked to the template are also linked to the equivalent newly created element(s).
* *Searching and retrieval* - the [Asset Catalog OMVS](/services/omvs/asset-catalog/overview) uses the anchor information in its search API to enable searches to include all elements anchored to assets.

!!! education "Further information"

- [Anchor Management](/features/anchor-management/overview) provide support for the Anchors and LatestChange classifications.
- [Anchor Classification](/types/0/0010-Base-Model) is used to implement the anchor grouping.

--8<-- "snippets/abbr.md"
17 changes: 17 additions & 0 deletions site/docs/concepts/catalog-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
hide:
- toc
---

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

# Catalog Template

A *catalog template* identifies a template designed to catalog a particular type of open metadata element. For example in the [Automated Curation OMVS](/services/omvs/automated-curation/overview) API, it links a particular *technology type* to relevant [templates](/concepts/template) for that ype of technology.

The catalog template is implemented using the [CatalogTemplate](/types/0/0011-Managing-Referenceables) relationship.



--8<-- "snippets/abbr.md"
10 changes: 5 additions & 5 deletions site/docs/concepts/governance-action-processes.drawio
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<mxfile host="Electron" modified="2024-04-16T16:00:41.491Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.1.0 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="NAq1PPQdifNhHUwY3wNv" version="24.1.0" type="device" pages="7">
<mxfile host="Electron" modified="2024-05-30T13:24:37.136Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.4.8 Chrome/124.0.6367.207 Electron/30.0.6 Safari/537.36" etag="L0KBZCOEabYg43vC7KeQ" version="24.4.8" type="device" pages="7">
<diagram id="3oW2gErGzdiTbXQZ8IKy" name="survey-follow-on">
<mxGraphModel dx="1201" dy="812" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
Expand Down Expand Up @@ -120,7 +120,7 @@
</mxGraphModel>
</diagram>
<diagram id="LQvSkKPcHTI8DiOGS9q0" name="process-step">
<mxGraphModel dx="1201" dy="812" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<mxGraphModel dx="2760" dy="1760" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
Expand Down Expand Up @@ -1521,7 +1521,7 @@
</mxGraphModel>
</diagram>
<diagram id="YZMFq_lJCUdQEENVh9U_" name="reference-data">
<mxGraphModel dx="1201" dy="-357" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<mxGraphModel dx="1242" dy="-377" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
Expand Down Expand Up @@ -1671,13 +1671,13 @@
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="ueI73NFC35rtGcMufVAl-48" value="Governance Action&lt;br&gt;Process Step" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="350" y="2120" width="120" height="60" as="geometry" />
<mxGeometry x="425" y="2120" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="ueI73NFC35rtGcMufVAl-51" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="ueI73NFC35rtGcMufVAl-50" target="ueI73NFC35rtGcMufVAl-48" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="ueI73NFC35rtGcMufVAl-50" value="Governance Process" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="150" y="2120" width="120" height="60" as="geometry" />
<mxGeometry x="225" y="2120" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="ueI73NFC35rtGcMufVAl-52" value="supportedRequestParameters&lt;br&gt;supportedActionTargets" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="827" y="2130" width="180" height="40" as="geometry" />
Expand Down
9 changes: 7 additions & 2 deletions site/docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
- [Action Target](/concepts/action-target)
- [Analytics Integrator OMIS](/services/omis/analytics-integrator/overview)
- [Anchor](/concepts/anchor)
- [Anchor Grouping](/concepts/anchor)
- [Anchor Domain](/concepts/anchor)
- [API Integrator OMIS](/services/omis/api-integrator/overview)
- [Application Programming Interface (API)](/concepts/basic-concepts)
- [Archives for Open Metadata](/concepts/open-metadata-archive)
Expand Down Expand Up @@ -40,6 +42,7 @@
- [Catalog Integrator OMIS](/services/omis/catalog-integrator/overview)
- [Catalog Target](/concepts/catalog-target)
- [Catalog Target Type](/concepts/catalog-target)
- [Catalog Template](/concepts/catalog-template)
- [Cohort](/concepts/cohort-member)
- [Cohort Event](/concepts/cohort-events)
- [Cohort Member](/concepts/cohort-member)
Expand Down Expand Up @@ -147,7 +150,7 @@
- [Glossary Browser OMVS](/services/omvs/glossary-browser/overview)
- [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)
- [Glossary Workflow OMVS](/services/omvs/glossary-workflow/overview)
- [Glossary Manager OMVS](/services/omvs/glossary-manager/overview)
- [Governance Action](/concepts/governance-action)
- [Governance Action Engine](/concepts/governance-action-engine)
- [Governance Action OMES](/service/omes/governance-action/overview)
Expand Down Expand Up @@ -295,6 +298,7 @@
- [Personal Note](/concepts/personal-notes)
- [Personal Profile](/concepts/personal-profile)
- [Personal Roles](/concepts/personal-roles)
- [Placeholder](/concepts/placeholder)
- [Platform Chassis](/services/platform-chassis)
- [Platform Metadata Security Connector](/concepts/platform-metadata-security-connector)
- [Platform Security](/features/metadata-security/overview)
Expand Down Expand Up @@ -364,6 +368,7 @@
- [Software Capability](/concepts/software-capability)
- [Software Server Capability](/concepts/software-capability)
- [Star Ratings](/concepts/review)
- [Specification](/concepts/specification)
- [Stewardship](/features/discovery-and-stewardship/overview)
- [Stewardship Action OMAS](/services/omas/stewardship-action/overview)
- [Stewardship Engine](/concepts/governance-engine)
Expand All @@ -384,7 +389,7 @@

- [Tagging](/concepts/informal-tag)
- [Team](/concepts/team)
- [Templates](/features/templated-cataloguing/overview)
- [Templates](/concepts/template)
- [Template Manager OMVS](/services/omvs/template-manager/overview)
- [Tool](/concepts/software-capability/#tool)
- Tombstone - see [Memento](#m)
Expand Down
17 changes: 2 additions & 15 deletions site/docs/concepts/presentation-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,11 @@ hide:

# Presentation server

The **presentation server** hosts the JavaScript applications that provide an interactive browser-based
user interface for Egeria.

The JavaScript applications call REST API services running in a [view server](/concepts/view-server)
to retrieve information and perform operations relating to open metadata.
The **presentation server** is the reverse proxy that protects the open metadata ecosystem from the vagaries of external user traffic and hosts the static JavaScript that provides the [interactive browser-based user interface for Egeria](/user-interfaces/general/overview). It also routes calls to the REST API services running in a [view server](/concepts/view-server) to retrieve information and perform operations relating to open metadata.

![A presentation server in the open metadata ecosystem](view-server.svg)

The presentation server supports multi-tenant operation.
Each presentation server tenant is designed to support an organization.
These may be independent organizations or divisions/departments within an organization.

The tenant is configured with the appropriate view server to use, which in turn routes requests
to its [governance servers](/concepts/governance-server) and [metadata access servers](/concepts/metadata-access-server).
Therefore, each tenant sees a different collection of metadata and operates in isolation to the other tenants.

!!! education "Further information"
The [setup and user guide for the presentation server :material-github:](https://github.com/odpi/egeria-react-ui){ target=gh }
is held in a separate repository.
[Setting up the presentation server](/guides/admin/user-interfaces/configuring-the-presentation-server)

--8<-- "snippets/abbr.md"
31 changes: 31 additions & 0 deletions site/docs/concepts/specification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# Specification

Specifications provide the information required to understand the behaviour of a function, to call it and to interpret its results. This is particularly important for functions that are available as a library for people to browse, select and run.

Egeria's templates, connectors and governance actions fit into this category. They can provide their own specification which can be queried through the [Automated Curation OMVS](/services/omvs/automated-curation/overview).

## Template specifications

[Templates](/concepts/template) are used to create consistent catalog entries. They include [placeholders](/concepts/placeholder) to allow specific values to be inserted into the resulting elements during the templating process. The names, types and descriptions are found in a template specification.

## Integration Connector Specifications

An integration connector implementation synchronizes (exchanges) metadata with particular types of third party technology. It often picks up details of which instance of this technology it is to synchronize with through its [catalog targets](/concepts/catalog-target). The specification for an integration connector describes the types of catalog targets it supports.

## Governance Service Specifications

[Governance Services](/concept/governance-service) provide the implementation of [governance actions](/concepts/governance-action). They are highly configurable and tis reflects in their specification which includes:

* *Supported Request Parameters* - these are the different types of request parameters that can be used to affect the behaviour of the governance service.
* *Supported Action Targets* - these list the types of [action targets](/concepts/action-target) that the governance service can process.
* *Supported Analysis Steps* ([Survey Action Service](/concepts/survey-action-service) only) - these list the analysis steps supported by the survey action service. They provide a description of the types of analysis performed. Some survey action services allow you to specify which analysis steps to skip through its request parameters.
* *Produced Request Parameters* - these list the types of any new request parameters produced by the governance service. These new request parameters will be added to (and may override) the request parameters supplied to the governance service. If the governance service is running as a step in a [governance action process](/concepts/governance-action-process), the combined request parameters are passed on to the next step(s) in the process.
* *Produced Action Targets* - these list the types of any new [action targets](/concepts/action-target) produced by the governance service. These new action targets will be added to (and may override) the action targets supplied to the governance service. If the governance service is running as a step in a [governance action process](/concepts/governance-action-process), the combined action targets are passed on to the next step(s) in the process.
* *Produced Guards* - these list the possible [guards](/concepts/guard) produced by the governance service when it completes. It also identifies the completion status that accompanies the guard that indicates whether the governance service succeeded or failed.
* *Produced Annotation Types* ([Survey Action Service](/concepts/survey-action-service) only) - these list the different types of annotations produced by the survey action service, the data values they include and which analysis step they are produced by.



11 changes: 11 additions & 0 deletions site/docs/concepts/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
hide:
- toc
---

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

# Template

A *template* is a collection of linked metadata elements that can be used to provide values and structure to a newly created element.
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ In the `omag-server-platform` assembly, there is a jar file called `egeria-platf
Glossary Author OMVS: View Service for glossary authoring.
Dynamic Infrastructure and Operations OMVS: Explore and operate an open metadata ecosystem.
Repository Explorer OMVS: Explore open metadata instances.
Glossary Workflow OMVS: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
Glossary MAnager OMVS: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
My Profile OMVS: Manage information about the logged on user as well as their preferences.
Type Explorer OMVS: Explore the open metadata types in a repository or cohort.
Server Author OMVS: Author servers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
* **Glossary Author OMVS**: View Service for glossary authoring.
* **Dynamic Infrastructure and Operations OMVS**: Explore and operate an open metadata ecosystem.
* **Repository Explorer OMVS**: Explore open metadata instances.
* **Glossary Workflow OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
* **Glossary Manager OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
* **My Profile OMVS**: Manage information about the logged on user as well as their preferences.
* **Type Explorer OMVS**: Explore the open metadata types in a repository or cohort.
* **Server Author OMVS**: Author servers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
* **Glossary Author OMVS**: View Service for glossary authoring.
* **Dynamic Infrastructure and Operations OMVS**: Explore and operate an open metadata ecosystem.
* **Repository Explorer OMVS**: Explore open metadata instances.
* **Glossary Workflow OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
* **Glossary Manager OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
* **My Profile OMVS**: Manage information about the logged on user as well as their preferences.
* **Type Explorer OMVS**: Explore the open metadata types in a repository or cohort.
* **Server Author OMVS**: Author servers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
* **Glossary Author OMVS**: View Service for glossary authoring.
* **Dynamic Infrastructure and Operations OMVS**: Explore and operate an open metadata ecosystem.
* **Repository Explorer OMVS**: Explore open metadata instances.
* **Glossary Workflow OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
* **Glossary Manager OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
* **My Profile OMVS**: Manage information about the logged on user as well as their preferences.
* **Type Explorer OMVS**: Explore the open metadata types in a repository or cohort.
* **Server Author OMVS**: Author servers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ In the `omag-server-platform` assembly, there is a jar file called `egeria-platf
Glossary Author OMVS: View Service for glossary authoring.
Dynamic Infrastructure and Operations OMVS: Explore and operate an open metadata ecosystem.
Repository Explorer OMVS: Explore open metadata instances.
Glossary Workflow OMVS: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
Glossary Manager OMVS: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
My Profile OMVS: Manage information about the logged on user as well as their preferences.
Type Explorer OMVS: Explore the open metadata types in a repository or cohort.
Server Author OMVS: Author servers.
Expand Down
Loading
Loading