Skip to content

Commit

Permalink
Merge pull request #923 from mandy-chessell/code2024
Browse files Browse the repository at this point in the history 
Add Valid Metadata OMVS
  • Loading branch information
@mandy-chessell
mandy-chessell committed Apr 24, 2024
2 parents f72c4a9 + c39bc5a commit 62e59b1
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 4 deletions.
12 changes: 11 additions & 1 deletion site/docs/release-notes/5-0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ _**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 basic 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 that mean you can get Egeria up and running without needing to understand the administration services.
* *A python client* - pyegeria provides a python API covering Egeria's administration and operational services plus many of the Open Metadata View Services (OMVSs).
* *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.
Expand Down Expand Up @@ -124,6 +125,15 @@ Release 5.0 is a major functional release focused on usability, both from the po
??? functional "New View Service: Feedback Manager OMVS"
[Feedback Manager OMVS](/services/omvs/feedback-manager/overview) is a new view service that supports the management of feedback (comments, likes, informal tags, notelogs and reviews) from users. The feedback support in Glossary Browser OMVS has been removed.

??? functional "New View Service: Project Manager OMVS"
[Project Manager OMVS](/services/omvs/project-manager/overview) supports the definition and management of projects. Projects can themselves be organized hierarchically.

??? functional "New View Service: Collection Manager OMVS"
[Collection Manager OMVS](/services/omvs/collection-manager/overview) supports the organizing and browsing of metadata in collections. Collections can themselves be organized hierarchically. An example of its use is in managing the collections of assets that make up digital products.

??? functional "New View Service: Valid Metadata OMVS"
[Valid Metadata OMVS](/services/omvs/valid-metadata/overview) supports the retrieval and maintenance of valid values for open metadata.

??? functional "Improved anchor support"
Anchor classifications now include the type name of the anchor entity. This allows the Anchor classification to be used to search for string values in any element that is anchored to a particular type of element.

Expand Down
7 changes: 5 additions & 2 deletions site/docs/release-notes/5-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ _**These are DRAFT release notes. The notes will be updated until & when 5.1 is
??? functional "New Engine Service: Context Event OMES"
[Context Event OMES](/services/omes/context-event/overview) supports the running of [Context Event Services](/concepts/context-event-service).

??? functional "New View Service: Collection Manager OMVS"
[Collection Manager OMVS](/services/omvs/collection-manager/overview) supports the organizing and browsing of metadata in collections. Collections can themselves be organized hierarchically. An example of its use is in managing the collections of assets that make up digital products.
??? functional "New View Service: Data Discovery OMVS"
[Data Discovery OMVS](/services/omvs/data-discovery/overview) supports the creation of data specs and saved searches.

??? functional "New View Service: Reference Data OMVS"
[Reference Data OMVS](/services/omvs/reference-data/overview) supports the query and maintenance of code values and reference data.



Expand Down
3 changes: 2 additions & 1 deletion site/docs/services/omvs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ The view services are as follows:
| [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. | |
| [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. |
| [Glossary Author](/services/omvs/glossary-author/overview) | **Develop new glossary terms and categories.** | The Glossary Author OMVS is for user interfaces supporting the creating and editing of glossary content, such as glossary terms and categories. The changes made are immediately visible to all users. |
| [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 Workflow](/services/omvs/glossary-workflow/overview) | **Develop new glossary terms and categories in a controlled workflow process.** | The Glossary Workflow 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 Author](/services/omvs/glossary-author/overview) | **Develop new glossary terms and categories.** | The Glossary Author OMVS is for user interfaces supporting the creating and editing of glossary content, such as glossary terms and categories. The changes made are immediately visible to all users. |
| [Repository Explorer](/services/omvs/rex/overview) | **Explorer interface to inspect instances across a cohort of repositories.** | The Repository Explorer (Rex) OMVS is for user interfaces that support enterprise architects who need to inspect, navigate or explore the instance data stored in an open metadata repository or a cohort of repositories. It enables the retrieval of instance data (entities and relationships) and exploration of the graph of instances connected to those entities. This enables the user to construct a graph (as a diagram) to visualize the details and connectivity of a group of instances of interest to the user. |
| [Type Explorer](/services/omvs/tex/overview) | **Explorer interface to inspect types across a cohort of repositories.** | The Type Explorer (Tex) OMVS is for user interfaces that support enterprise architects who need to inspect, navigate or explore the open metadata types supported by a repository or a cohort of repositories. It enables the retrieval of type data (relating to entities, relationships and classifications) and exploration of the graphs of entity type inheritance and the supported combinations of entity and relationship types. |
| [Dynamic Infrastructure and Operations](/services/omvs/dino/overview) | **Admin interface to inspect servers, services, cohorts and platforms.** | The Dino OMVS is for user interfaces that support Egeria operators who need to inspect, navigate or explore the open metadata servers, services, cohorts and platforms that are configured or actively running. It is intended for operations and problem-determination. |
Expand Down
49 changes: 49 additions & 0 deletions site/docs/services/omvs/valid-metadata/overview.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
hide:
- toc
---

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

--8<-- "snippets/content-status/tech-preview.md"

# Valid Metadata OMVS

The Valid Metadata Open Metadata View Services (OMVS) is a REST API designed to back user interfaces (UIs) that support lists of valid values for open metadata attributes. It offers two types of services:

* Maintain and query lists of valid values for open metadata attributes.
* Retrieve details of the defined open metadata types.

## Working with valid metadata values

[Valid Metadata Values](/guides/planning/valid-values/overview) uses [Valid Value Sets](/types/5/0545-Reference-Data) to maintain lists of valid values for open metadata attributes. It aims to offer UI developers the ability to populate drop-downs with valid values for an attribute, or validate a value provided by an end user, or offer services that maintain these valid value lists.

There are twelve operations for maintaining the valid value lists:

* Three for creating a valid value.
* Three for deleting a valid value.
* Three for querying if a valid value is valid.
* Three for retrieving the properties of a specific valid value.

The reason for three operations for each method is that Egeria needs to distinguish between:

1. A valid value for a primitive attribute (string, integer, etc) or a primitive value in an array attribute.
2. A valid key in a map attribute (called a mapName).
3. A valid value associated with a key in a map attribute.

In addition, there is an operation for retrieving the entire list of valid values for an attribute, plus two methods for managing *Consistent Values* relationships.

## Retrieving open metadata types

The standard open metadata types are describe [on this website](/types). It is also possible to [define your own](/guides/developer/open-metadata-archives/defining-new-types) open metadata types. The Valid Metadata OMVS provides services to query the types and understand how the lint together.



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






1 change: 1 addition & 0 deletions site/mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -566,6 +566,7 @@ nav:
- Project Manager: services/omvs/project-manager/overview.md
- Reference Data: services/omvs/reference-data/overview.md
- Template Manager: services/omvs/template-manager/overview.md
- Valid Metadata: services/omvs/valid-metadata/overview.md
- Dynamic Infrastructure and Ops: services/omvs/dino/overview.md
- Glossary Author: services/omvs/glossary-author/overview.md
- Repository Explorer: services/omvs/rex/overview.md
Expand Down

0 comments on commit 62e59b1

Please sign in to comment.