diff --git a/site/docs/release-notes/egeria-status.drawio b/site/docs/release-notes/egeria-status.drawio index 3df43e986d..073f72de39 100644 --- a/site/docs/release-notes/egeria-status.drawio +++ b/site/docs/release-notes/egeria-status.drawio @@ -1,4 +1,4 @@ - + @@ -913,7 +913,7 @@ - + diff --git a/site/docs/services/omvs/data-designer/overview.md b/site/docs/services/omvs/data-designer/overview.md new file mode 100644 index 0000000000..5186f2f642 --- /dev/null +++ b/site/docs/services/omvs/data-designer/overview.md @@ -0,0 +1,21 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/in-development.md" + +# Data Designer OMVS + +The Data Designer Open Metadata View Services (OMVS) is a REST API that enables the caller to create schema definitions to describe the structure of data. + +---8<-- "snippets/abbr.md" + + + + + + diff --git a/site/docs/services/omvs/data-discovery/overview.md b/site/docs/services/omvs/data-discovery/overview.md index 75f8b69106..ac95f29522 100644 --- a/site/docs/services/omvs/data-discovery/overview.md +++ b/site/docs/services/omvs/data-discovery/overview.md @@ -10,7 +10,7 @@ hide: # Data Discovery OMVS -The Data Discovery Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) for documenting specifications that describe the data needed for a project. These are known as DataSpecs and they can be used to specify schemas for data pipelines as well as saved searches. +The Data Discovery Open Metadata View Services (OMVS) is a REST API that enables the caller to define and search for new data resources. ---8<-- "snippets/abbr.md" diff --git a/site/docs/services/omvs/data-officer/overview.md b/site/docs/services/omvs/data-officer/overview.md new file mode 100644 index 0000000000..f9c3314964 --- /dev/null +++ b/site/docs/services/omvs/data-officer/overview.md @@ -0,0 +1,21 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/in-development.md" + +# Data Officer OMVS + +The Data Officer Open Metadata View Services (OMVS) is a REST API that supports a Data Officer as they lead the data governance program. This builds on the capabilities of the [Governance Officer OMVS](/services/omvs/governance-officer/overview). + +---8<-- "snippets/abbr.md" + + + + + + diff --git a/site/docs/services/omvs/devops-pipeline/overview.md b/site/docs/services/omvs/devops-pipeline/overview.md new file mode 100644 index 0000000000..e08913a258 --- /dev/null +++ b/site/docs/services/omvs/devops-pipeline/overview.md @@ -0,0 +1,21 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/in-development.md" + +# Devops Pipeline OMVS + +The Devops Pipeline Open Metadata View Services (OMVS) is a REST API that enables a devops engineer to maintain the metadata about the changing digital resources being deployed through devops pipelines. + +---8<-- "snippets/abbr.md" + + + + + + diff --git a/site/docs/services/omvs/governance-officer/overview.md b/site/docs/services/omvs/governance-officer/overview.md new file mode 100644 index 0000000000..33d1372f86 --- /dev/null +++ b/site/docs/services/omvs/governance-officer/overview.md @@ -0,0 +1,18 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/in-development.md" + +# Governance Officer Open Metadata View Service (OMVS) + +The Governance Officer Open Metadata View Services (OMVS) is a REST API that support the creation and editing of a new governance domain. + +It uses the [Governance Program OMAS](/services/omas/governance-program/overview) for its metadata services. + + +--8<-- "snippets/abbr.md" diff --git a/site/docs/services/omvs/index.md b/site/docs/services/omvs/index.md index 120723d215..01ec5e5c22 100644 --- a/site/docs/services/omvs/index.md +++ b/site/docs/services/omvs/index.md @@ -7,23 +7,32 @@ The Open Metadata View Services (OMVS) provide task oriented, domain-specific se The view services are as follows: -| OMVS | Summary | Description | -|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [My Profile](/services/omvs/my-profile/overview) | **Locate, retrieve and update information relating to the calling user's profile.** | The My Profile OMVS is for user interfaces supporting a personalized experience. A registered user is able to maintain information about themselves, their roles and their network. | -| [Asset Catalog](/services/omvs/asset-catalog/overview) | **Search for assets.** | The Asset Catalog OMVS provides search and query capabilities for tools and applications to support an asset catalog function. It supports search requests for assets with specific characteristics and returns summaries of the matching assets, plus methods to allow drill-down into the details of a specific asset to related metadata. | -| [Feedback Manager](/services/omvs/feedback-manager/overview) | **Maintain feedback such as comments, tags, reviews, likes and note logs.** | The Feedback Manager OMVS is for user interfaces supporting feedback from users. A registered user is able to add comments, informal tags, notes, reviews and likes to elements such as assets or glossary terms. | -| [Collection Manager](/services/omvs/collection-manager/overview) | **Manage collections of assets and other elements.** | The Collection Manager OMVS provides the REST APIs to create collections of asset and other elements such as glossary terms or policies. The collections can be nested (like folders in a file system) and they can be classified to describe the type of collection. For example, one type of classification for a collection is a *DigitalProduct* that allows the collections of assets and other related material to describe data and or services for a specific consumer or purpose. | -| [Automated Curation](/services/omvs/automated-curation/overview) | **Discovery, initiate and monitor metadata cataloging and governance actions such as automated surveying.** | The Automated Curation OMVS is for user interfaces that allows asset owners and consumers to set up, execute and monitor automated harvesting and governance services. | -| [Data Discovery](/services/omvs/data-discovery/overview) | **Documenting specifications that describe the data needed for a project.** | The Data Discovery Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) for documenting specifications that describe the data needed for a project. These are known as DataSpecs and they can be used to specify schemas for data pipelines as well as saved searches. | -| [Action Author](/services/omvs/action-author/overview) | **Create and maintain governance actions.** | The Action Author OMVS is for user interfaces supporting the governance team to set up governance definitions and actions. | -| [Notification Manager](/services/omvs/notification-manager/overview) | **Locate, retrieve and update the types of user notifications that should be produced.** | The Notification Manager OMVS is for user interfaces supporting personalized notifications to specific users. A registered user is able to define which types of notification should be produced and who they should be delivered to. | -| [Project Manager](/services/omvs/project-manager/overview) | **Locate, retrieve and update information relating to projects.** | The Project Manager OMVS is for user interfaces supporting projects, either for a group of people or personalized sandboxes for individuals. A registered user is able to maintain information about a project and link it with other projects, users and resources. | -| [Reference Data](/services/omvs/reference-data/overview) | **Create and maintain reference data values and their mappings.** | The Reference Data Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that maintain reference data values and their mappings. | | -| [Runtime Manager](/services/omvs/runtime-manager/overview) | **Retrieve status information about Egeria's OMAG Server Platform and OMAG Servers.** | The Runtime Manager Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that displays operational status about Egeria. | | -| [Valid Metadata](/services/omvs/valid-metadata/overview) | **Create and maintain metadata valid values.** | The Valid Metadata Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that query and maintain lists of valid values for open metadata attributes as well as query open metadata type definitions. | | -| [Template Manager](/services/omvs/template-manager/overview) | **Create and maintain templates used to create new metadata elements.** | The Template Manager Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that support the management of templates that are used when creating new metadata. | +| OMVS | Summary | Description | +|----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Action Author](/services/omvs/action-author/overview) | **Create and maintain governance actions.** | The Action Author OMVS is for user interfaces supporting the governance team to set up governance definitions and actions. | +| [Asset Catalog](/services/omvs/asset-catalog/overview) | **Search for assets.** | The Asset Catalog OMVS provides search and query capabilities for tools and applications to support an asset catalog function. It supports search requests for assets with specific characteristics and returns summaries of the matching assets, plus methods to allow drill-down into the details of a specific asset to related metadata. | +| [Automated Curation](/services/omvs/automated-curation/overview) | **Discovery, initiate and monitor metadata cataloging and governance actions such as automated surveying.** | The Automated Curation OMVS is for user interfaces that allows asset owners and consumers to set up, execute and monitor automated harvesting and governance services. | +| [Classification Manager](/services/omvs/my-profile/overview) | **Manage classifications on open metadata..** | The Classification Manager OMVS enables the caller to add classifications and governance relationships to open metadata elements. | +| [Collection Manager](/services/omvs/collection-manager/overview) | **Manage collections of assets and other elements.** | The Collection Manager OMVS provides the REST APIs to create collections of asset and other elements such as glossary terms or policies. The collections can be nested (like folders in a file system) and they can be classified to describe the type of collection. For example, one type of classification for a collection is a *DigitalProduct* that allows the collections of assets and other related material to describe data and or services for a specific consumer or purpose. | +| [Data Designer](/services/omvs/data-designer/overview) | **Create schema definitions to describe the structure of data.** | The Data Designer OMVS is a REST API designed to support user interfaces (UIs) for building schemas for new data assets. | +| [Data Discovery](/services/omvs/data-discovery/overview) | **Define and search for new data resources.** | The Data Discovery OMVS is a REST API designed to support user interfaces (UIs) for locating the data needed for a project. | +| [Data Officer](/services/omvs/data-officer/overview) | **Manage the governance of data.** | The Data Officer OMVS is a REST API designed to support user interfaces (UIs) for supporting a Data Officer as they lead the data governance program. This builds on the capabilities of the Governance Officer OMVS. | +| [Devops Pipeline](/services/omvs/devops-pipeline/overview) | **Maintain the metadata about the assets managed by a devops pipeline.** | The Devops Pipeline OMVS is a REST API designed to support user interfaces (UIs) for supporting a devops engineer to maintain the metadata about the changing digital resources being deployed through devops pipelines. | +| [Feedback Manager](/services/omvs/feedback-manager/overview) | **Maintain feedback such as comments, tags, reviews, likes and note logs.** | The Feedback Manager OMVS is for user interfaces supporting feedback from users. A registered user is able to add comments, informal tags, notes, reviews and likes to elements such as assets or glossary terms. | | [Glossary Browser](/services/omvs/glossary-browser/overview) | **Search and view the contents of specific glossaries and their links to governance definitions and assets.** | The Glossary Browser OMVS is for user interfaces that wish to provide search facilities within a single glossary (or glossaries) along with the ability to browse the structure of the glossary and view an element within a glossary along with connected governance classifications, governance definitions, user feedback and attached assets. | -| [Glossary Manager](/services/omvs/glossary-manager/overview) | **Develop new glossary terms and categories in a controlled workflow process.** | The Glossary Manager OMVS is for user interfaces supporting the creation and editing of glossary content, such as glossary terms and categories, in a controlled workflow process. This means that as terms and categories are created, updated and deleted, these changes are invisible to the general user until they are approved. | +| [Glossary Manager](/services/omvs/glossary-manager/overview) | **Develop new glossary terms and categories in a controlled workflow process.** | The Glossary Manager OMVS is for user interfaces supporting the creation and editing of glossary content, such as glossary terms and categories, in a controlled workflow process. This means that as terms and categories are created, updated and deleted, these changes are invisible to the general user until they are approved. | +| [Governance Officer](/services/omvs/governance-officer/overview) | **Maintain governance definitions used to define any governance domain.** | The Governance Officer OMVS is for user interfaces supporting the creation and editing of a new governance domain. | +| [Metadata Explorer](/services/omvs/metadata-explorer/overview) | **Provides generic search, query and retrieval operations for open metadata..** | The Metadata Explorer OMVS is for user interfaces supporting the search, query and retrieval of open metadata. It is an advanced API for users that understand the [Open Metadata Types](https://egeria-project.org/types/). | +| [My Profile](/services/omvs/my-profile/overview) | **Locate, retrieve and update information relating to the calling user's profile.** | The My Profile OMVS is for user interfaces supporting a personalized experience. A registered user is able to maintain information about themselves, their roles and their network. | +| [Notification Manager](/services/omvs/notification-manager/overview) | **Locate, retrieve and update the types of user notifications that should be produced.** | The Notification Manager OMVS is for user interfaces supporting personalized notifications to specific users. A registered user is able to define which types of notification should be produced and who they should be delivered to. | +| [People Organizer](/services/omvs/people-manager/overview) | **Describe teams, roles and organizational structure.** | The People Organizer OMVS provides the REST APIs used to maintain information about an organization. This includes the definitions of teams, roles and organization structures. | +| [Project Manager](/services/omvs/project-manager/overview) | **Locate, retrieve and update information relating to projects.** | The Project Manager OMVS is for user interfaces supporting projects, either for a group of people or personalized sandboxes for individuals. A registered user is able to maintain information about a project and link it with other projects, users and resources. | +| [Privacy Officer](/services/omvs/privacy-officer/overview) | **Manage the governance of privacy.** | The Privacy Officer OMVS is a REST API designed to support user interfaces (UIs) for supporting a Privacy Officer as they lead the data privacy governance program. This builds on the capabilities of the Governance Officer OMVS. | +| [Reference Data](/services/omvs/reference-data/overview) | **Create and maintain reference data values and their mappings.** | The Reference Data OMVS is a REST API designed to support user interfaces (UIs) that maintain reference data values and their mappings. | | +| [Runtime Manager](/services/omvs/runtime-manager/overview) | **Retrieve status information about Egeria's OMAG Server Platform and OMAG Servers.** | The Runtime Manager OMVS is a REST API designed to support user interfaces (UIs) that displays operational status about Egeria. | | +| [Security Officer](/services/omvs/security-officer/overview) | **Manage the governance of security.** | The Security Officer OMVS is a REST API designed to support user interfaces (UIs) for supporting a Security Officer as they lead the security governance program. This builds on the capabilities of the Governance Officer OMVS. | +| [Template Manager](/services/omvs/template-manager/overview) | **Create and maintain templates used to create new metadata elements.** | The Template Manager OMVS is a REST API designed to support user interfaces (UIs) that support the management of templates that are used when creating new metadata. | +| [Valid Metadata](/services/omvs/valid-metadata/overview) | **Create and maintain metadata valid values.** | The Valid Metadata OMVS is a REST API designed to support user interfaces (UIs) that query and maintain lists of valid values for open metadata attributes as well as query open metadata type definitions. | | diff --git a/site/docs/services/omvs/metadata-explorer/overview.md b/site/docs/services/omvs/metadata-explorer/overview.md new file mode 100644 index 0000000000..67a7adc65a --- /dev/null +++ b/site/docs/services/omvs/metadata-explorer/overview.md @@ -0,0 +1,21 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/in-development.md" + +# Metadata Explorer OMVS + +The Metadata Explorer Open Metadata View Services (OMVS) is a REST API that supports the search, query and retrieval of open metadata. It is an advanced API for users that understand the [Open Metadata Types](/types). + +---8<-- "snippets/abbr.md" + + + + + + diff --git a/site/docs/services/omvs/people-organizer/overview.md b/site/docs/services/omvs/people-organizer/overview.md new file mode 100644 index 0000000000..cb882cef7c --- /dev/null +++ b/site/docs/services/omvs/people-organizer/overview.md @@ -0,0 +1,21 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/in-development.md" + +# People Organizer OMVS + +The People Organizer Open Metadata View Services (OMVS) is a REST API that is used to maintain information about an organization. This includes the definitions of teams, roles and organization structures. + +---8<-- "snippets/abbr.md" + + + + + + diff --git a/site/docs/services/omvs/privacy-officer/overview.md b/site/docs/services/omvs/privacy-officer/overview.md new file mode 100644 index 0000000000..f6e4327714 --- /dev/null +++ b/site/docs/services/omvs/privacy-officer/overview.md @@ -0,0 +1,21 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/in-development.md" + +# Privacy Officer OMVS + +The Privacy Officer Open Metadata View Services (OMVS) is a REST API that supports a Privacy Officer as they lead the privacy governance program. This builds on the capabilities of the [Governance Officer OMVS](/services/omvs/governance-officer/overview). + +---8<-- "snippets/abbr.md" + + + + + + diff --git a/site/docs/services/omvs/security-officer/overview.md b/site/docs/services/omvs/security-officer/overview.md new file mode 100644 index 0000000000..9143d50507 --- /dev/null +++ b/site/docs/services/omvs/security-officer/overview.md @@ -0,0 +1,21 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/in-development.md" + +# Security Officer OMVS + +The Security Officer Open Metadata View Services (OMVS) is a REST API that supports a Security Officer as they lead the security governance program. This builds on the capabilities of the [Governance Officer OMVS](/services/omvs/governance-officer/overview). + +---8<-- "snippets/abbr.md" + + + + + +