diff --git a/site/docs/services/omvs/feedback-manager/feedback-manager-urls.png b/site/docs/services/omvs/feedback-manager/feedback-manager-urls.png new file mode 100644 index 0000000000..dac268caac Binary files /dev/null and b/site/docs/services/omvs/feedback-manager/feedback-manager-urls.png differ diff --git a/site/docs/services/omvs/index.md b/site/docs/services/omvs/index.md index 01ec5e5c22..a86e7c5759 100644 --- a/site/docs/services/omvs/index.md +++ b/site/docs/services/omvs/index.md @@ -3,36 +3,36 @@ # Open Metadata View Services (OMVS) -The Open Metadata View Services (OMVS) provide task oriented, domain-specific services for user interfaces to integrate with open metadata. They provide REST APIs. +The Open Metadata View Services (OMVS) provide task oriented, domain-specific services for user interfaces to integrate with open metadata. They provide REST APIs. The view services are as follows: -| 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. | +| 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. | -| [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. | | +| [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/metadata-explorer-urls.png b/site/docs/services/omvs/metadata-explorer/metadata-explorer-urls.png new file mode 100644 index 0000000000..ca3811a982 Binary files /dev/null and b/site/docs/services/omvs/metadata-explorer/metadata-explorer-urls.png differ diff --git a/site/docs/services/omvs/metadata-explorer/metadata-explorer.drawio b/site/docs/services/omvs/metadata-explorer/metadata-explorer.drawio new file mode 100644 index 0000000000..e41eb48651 --- /dev/null +++ b/site/docs/services/omvs/metadata-explorer/metadata-explorer.drawio @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/services/omvs/metadata-explorer/overview.md b/site/docs/services/omvs/metadata-explorer/overview.md index effff3cc7b..f7f1f12661 100644 --- a/site/docs/services/omvs/metadata-explorer/overview.md +++ b/site/docs/services/omvs/metadata-explorer/overview.md @@ -7,7 +7,7 @@ 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) because the searches are expressed using these types and the attributes they define, and the results directly reflect the elements and relationships they define. There are simpler, more specialized search operations in the other view services. -The Metadata Explorer OMVS has 11 different types of search operation. The first four retrieve details about a single metadata element. +The Metadata Explorer OMVS has 12 different types of search operation. The first four retrieve details about a single metadata element. * getMetadataElementByGUID - Retrieve the metadata element using its unique identifier (guid). * getMetadataElementByUniqueName - Retrieve the metadata element using its unique name (typically the *qualifiedName* attribute but other attributes can be used if they are unique - such as *pathName* for a file). @@ -21,16 +21,27 @@ The next four operations retrieve the relationships linked to an element, and th * getAllMetadataElementRelationships - Retrieve the relationships linking the supplied elements. * getMetadataElementRelationships - Retrieve the relationships linking the supplied elements via a specific type of relationship. +The next command retrieves a graph of elements that are all anchored to the supplied starting element. + +* getAnchoredElementsGraph - Return all the elements that are anchored to an element plus relationships between these elements and to other elements. + The next few operations retrieve lists of elements that contain properties (attributes and/or header values) that match the request. * findMetadataElementsWithString - Retrieve the metadata elements that contain the requested string in any attribute. The string is interpreted as a simple regular expression. * findMetadataElements - Return a list of metadata elements that match the supplied criteria. The results can be returned over many pages. * findRelationshipsBetweenMetadataElements - Return a list of relationships that match the requested conditions. The results can be received as a series of pages. -The next two operations allow you to retrieve details of a specific relationship, along with summary information about the elements at each end. +The final two operations allow you to retrieve details of a specific relationship, along with summary information about the elements at each end. + +* getRelationshipByGUID - Retrieve the relationship using its unique identifier. +* getRelationshipHistory - Retrieve all the versions of a relationship. + + ## Common request options + + ### Paging Requests that return multiple results have optional request parameters to specify paging options of *startFrom* and *pageSize*. If they are not specified, their default value is 0. @@ -90,18 +101,33 @@ SequencingOrder is used for search requests against a metadata collection. It d Note: not all repositories support ordering. The results may vary between repository types. -### Additional request parameters +### Using the urLMarker -Each access service can be set up to support a restrictive set of governance zones. This controls the visibility of assets to the callers. +Metadata Explorer OMVS contains operations that are useful in many scenarios. For that reason it is implemented as a *View Server Generic Service*. This means that firstly, it is always running in a view server. Secondly, each of its operations' URL has a segment that is specified as `{urlMarker}`. -By default, all requests are routed via Feedback Manager OMVS to Asset Manager OMAS. If you wish the request to be routed via a different view service (OMVS) or access service (OMAS) it is possible to use one or other of these request parameters: +![Metadata Explorer URLs](metadata-explorer-urls.png) +> The `urlMarker` in Metadata Explorer OMAS's REST API operations. -* viewServiceURLMarker optional view service URL marker (overrides accessServiceURLMarker) to route the request via a different view service and onto its default access service. -* accessServiceURLMarker optional access service URL marker used to identify which back end service. +This segment of the URL normally takes the URL marker for the particular view service it belongs to. (For example `metadata-explorer` for the Metadata Explorer OMVS, or `asset-catalog` for Asset Catalog OMVS). The `{urlMarker}` allows the use of the URL marker for any view service that is configured in the view server. -The URL marker is derived from the name of the requested service - take the short two-word service name, convert to lower case and add a hyphen between the two words - so Feedback Manager OMVS's URL Marker is feedback-manager. +???+ tip "How do I find out the URL marker for a service?" + The URL marker is derived from the name of the requested service - take the short two-word service name, convert to lower case and add a hyphen between the two words - so Feedback Manager OMVS's URL Marker is feedback-manager. + +When the request is received by Metadata Explorer OMVS, it uses the supplied URL marker to look up the configuration of the requested view service. It then issues the desired request(s) to the partner [metadata access server](/concepts/metadata-access-server) configured for the requested view server. + +The reason this feature is useful is that each view service is configured to call an [Open Metadata Access Service (OMAS)](/services/omas) running in a specific [Metadata Access Server](/concepts/metadata-access-server). They do not all have to be set to call the same server. + +![View server configuration example](view-server-configuration.svg) +> This example show a view server where its view services are configured to point to different metadata access stores. + +Each access service in each server can be set up to support a restrictive set of [governance zones](/features/governance-zoning/overview). This controls the visibility of assets returned to the callers. If, for example, a user interface was calling Asset Catalog OMAS to provide information about assets for its user, this service would call Asset Consumer OMAS in the metadata store. It could be set up to only return assets of a particular quality. If the UI needed to also perform a complex query using Metadata Explorer OMVS, it could set the URL Marker to be "asset-catalog" and the request would be passed to the same Asset Consumer OMAS as the other Asset Catalog OMAS calls - and so returning assets with the same visibility. + +???+ education "If Metadata Explorer OMVS is always active, do I need to configure it in my view server?" + You only need to configure Metadata Explorer OMVS if you want to use the `metadata-explorer` URL Marker to call the Asset Consumer OMAS in a specific Metadata Access Store. + +### Additional request parameters -In additional there are optional request parameters for lineage and duplicate processing requests. +There are optional request parameters for lineage and duplicate processing requests. * forLineage (default=false) - set this request parameter to true if this request is to support a lineage query - it will include the mementos representing elements in the graph that are deleted. * forDuplicateProcessing (default=false) - set this request parameter to true if the query is supporting deduplication processing and so it turns off the automatic deduplicate processing diff --git a/site/docs/services/omvs/metadata-explorer/view-server-configuration.svg b/site/docs/services/omvs/metadata-explorer/view-server-configuration.svg new file mode 100644 index 0000000000..9eab316701 --- /dev/null +++ b/site/docs/services/omvs/metadata-explorer/view-server-configuration.svg @@ -0,0 +1,4 @@ + + + +
view-server
Automated Curation
OMVS
Asset Catalog
OMVS
Runtime Manager
OMVS
Feedback Manager
OMVS
postgres-metadata-store
Metadata Explorer
OMVS
xtdb-kv-metadata-store
Asset Consumer
OMAS
IT Infrastructure OMAS
Asset Owner
OMAS
Asset Consumer
OMAS
Metadata Access
Stores
View
Server
\ No newline at end of file