Open Metadata Access Services (OMAS)¶
The Open Metadata Access Services (OMAS) provide domain-specific services for data tools, engines and platforms to integrate with open metadata.
The access services are as follows:
|Asset Catalog||The Asset Catalog OMAS 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.|
|Asset Consumer||The Asset Consumer OMAS is designed for applications that are using OCF connectors to access data stores, APIs and functions such as analytics. The Asset Consumer OMAS provides a factory function for the connectors, the ability to retrieve all of the metadata about the asset and the ability to add feedback on the asset.|
|Asset Lineage||The Asset Lineage OMAS listens to relevant lineage related events on the enterprise topic level and publishes these on the Asset Lineage OutTopic, combined with relevant context information on the described entities. These events are listened to by the open lineage services governance server.|
|Asset Manager||The Asset Manager OMAS manages the exchange of metadata with third party metadata catalogs and asset managers. It is typically called by the Catalog Integrator OMIS to send and receive asset information, including schemas, profiles, policies and lineage information with a third party asset manager. Typical examples of asset managers include data catalogs that are managing metadata for a collection of data assets for a data-serving solution.|
|Asset Owner||The Asset Owner OMAS provides services for an asset owner to curate metadata about their asset(s) and understand how these assets are being used and governed.|
|Community Profile||The Community Profile OMAS supports the administration for a community and related user profiles. These communities are involved in reviewing and crowd-sourcing knowledge about the data assets and their use.|
|Data Engine||The Data Engine OMAS provides APIs and events for a data movement/processing engine to record the changes it is making the the data landscape. This information forms a key part of asset lineage.|
|Data Manager||The Data Manager OMAS provides an integration point to enable technologies that manage collections of data such as database servers, file systems, file managers and content managers to publish metadata to the metadata repositories about the changing structures and content stored in the data platform. It is typically called from the Database Integrator OMIS and Files Integrator OMIS integration services.|
|Data Privacy||The Data Privacy OMAS supports a privacy officer as they manage data privacy in their organization. This includes managing privacy impact assessments and reviews of software services that use personal data as they move through their development, deployment and use.|
|Data Science||The Data Science OMAS provides access to metadata for data assets, connections and projects, plus the ability to maintain metadata about data science notebooks and models and log activity during the analytics development process. It is designed for data science and analytics management tools.|
|Design Model||The Design Model OMAS provides the ability to manage information from all types of design models. These models may come from tools or be part of a packaged standard. This content is useful for governance, system integration and software development.|
|DevOps||The DevOps OMAS provides services for a DevOps pipeline to query and maintain metadata about systems, processes and software components that are being deployed into the information landscape.|
|Digital Architecture||The Digital Architecture OMAS provides the ability to define information standards, definitions, solution blueprints and models for an organization. It is designed for architecture tools. It is able to support the definition and management of a digital service through concept to deployment.|
|Digital Service||The Digital Service OMAS provides services for a managing the lifecycle of an Egeria Digital Service.|
|Discovery Engine||The Discovery Engine OMAS provides an API for a discovery engine to access and store metadata from an open metadata repository (or open metadata repository cohort).|
|Glossary View||The Glossary View OMAS provides APIs to browse glossaries and their content.|
|Governance Engine||The Governance Engine OMAS provides APIs and events that retrieve and manage metadata for governance engines. Governance engines ensure that the infrastructure supporting the data landscape is operating according to the governance program. For example, the governance engine may be ensuring that individuals and servers only have access to the data they have been authorized to see.|
|Governance Program||The Governance Program OMAS provides the ability to maintain a governance program in the open metadata repositories. It is designed for governance and CDO tools.|
|IT Infrastructure||The IT Infrastructure OMAS provides support for the design and planning of the information infrastructure that supports the data assets. This includes the development of system blueprints that link down to the metadata about real infrastructure components. This metadata helps in the linkage between information governance metadata and IT infrastructure management (ITIL) metadata typically stored in a Configuration Management Database (CMDB).|
|Project Management||The Project Management OMAS supports the metadata associated with projects and campaigns. These projects and campaigns may be for governance projects, or generic data use projects.|
|Security Manager||The Security Manager OMAS provides the services to exchange security tags with access control and data protection technology services. It is called by the Security Integrator OMIS.|
|Security Officer||The Security Officer OMAS provides the services to support the definition of roles and rules for managing the protection of metadata and assets, plus work with the audit logs captured by the open metadata and governance tools. It is typically used by the security, compliance and auditing teams.|
|Software Developer||The Software Development OMAS provides access to metadata needed to build compliant APIs, data stores and related software components.|
|Stewardship Action||The Stewardship Action OMAS provides services for managing exceptions discovered in the information landscape that need correcting. These exceptions may be quality errors, missing or outdated information, invalid licensing, job failures, and many more. The Stewardship Action OMAS also enables the review and triage of the exceptions, simple remediation and status reporting.|
|Subject Area||The Subject Area OMAS is for tools that support subject matter experts who are defining glossaries, reference data and rules around data for a specific subject area, such as "customer data". It supports the development of a comprehensive definition of the subject area and the standards that support it. These definitions can then be folded into the Governance Program, and used by Asset Owner's to improve the findability and understandability of their assets by linking their asset's structure to relevant parts of the subject area definition.|
Using the OMAS's¶
The OMAS's run in a metadata access server. They can be configured and activated individually or as a complete set. The administration services provide the ability to configure, start and stop the access services.
Each OMAS typically supports a Java API, a topic where it publishes notifications of interest to its callers (called the OutTopic), and a topic where new metadata requests can be posted to the OMAS (called the InTopic).
Internally, the Java client calls the REST API of the server module to allow it to reside in remote servers. This java client is embedded in the governance servers and view servers. They can also be downloaded and used independently within an application.
Inside an OMAS¶
Although each OMAS provides a unique API, the internal structure of each OMAS is pretty similar.
Typically, an OMAS supports a Java client interface that runs locally in the metadata tool, service, or application. These client interfaces support both synchronous and asynchronous calls to the OMAS server-side.
For callers that do not use Java, behind the client there is an OMAS REST API and an event notification interface (typically supported by Apache Kafka) that can be called directly. The event notification interface for each OMAS has a topic to allow an external caller to post metadata updates to the open metadata repositories (OMAS In Topic) and another topic (OMAS Out Topic) to receive relevant updates that have come from other parts of the open metadata and governance ecosystem.
Today, direct calls to the REST APIs and topics are not guaranteed to be backward compatible. They are also not documented. However, we are moving to a position where these interfaces are both documented and supported. The change in their disposition will occur when the documentation is contributed.
The interfaces are illustrated in Figure 1:
Figure 1: Structure of an Open Metadata Access Service (OMAS)
Figure 2 shows the repository services.
Figure 2: Calling the repository services
The OMRS subsystem called the enterprise repository services offers both an Enterprise OMRS Repository Connector and Enterprise OMRS Topic. The Enterprise OMRS Repository Connector queries all repositories in the cohorts that the local server is connected to. The Enterprise OMRS Topic aggregates events from all connected cohorts.
The OMAS is passed the enterprise repository service objects at initialization. It can then register a listener with the Enterprise OMRS Topic to receive the cohort events.
While running, the OMAS can call the Enterprise OMRS Repository Connector directly. However, there are many common functions that all OMASs need and these are provided by the common services.
Figure 3 shows the common services.
Figure 3: Using the common services
The common services provide most of the metadata management implementation logic for the OMASs. This means that the code in each OMAS's modules is able to focus on supporting its specific interfaces and mapping them to the common services.
The Repository Handler provides an object-oriented interface over the Enterprise OMRS Repository Connector.
The Generic Handlers provide support for maintaining and accessing specific Open Metadata Types (such as Asset, Connection, ...). They also support calls to metadata security, visibility of metadata based on governance zones and the maintenance of anchorGUIDs in dependent instances.