In this section, we provide guides and references to use the Omni connector.
OpenMetadata ingests Omni metadata through Omni’s REST API. The connector reads Omni models and topics as data models, documents (workbooks) as dashboards with their tiles as charts, and builds lineage from your warehouse tables through topics to dashboards.
Configure and schedule Omni metadata workflows from the OpenMetadata UI:
How to Run the Connector Externally
To run the Ingestion via the UI you’ll need to use the OpenMetadata Ingestion Container, which comes shipped with
custom Airflow plugins to handle the workflow deployment.
If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check
the following docs to run the Ingestion Framework anywhere.
External Schedulers
Get more information about running the Ingestion Framework Externally
Requirements
OpenMetadata authenticates with Omni using an API token sent as a Bearer token. Use either an Organization API Key (created by an Organization Admin, grants access across the organization’s models and documents) or a Personal Access Token (scoped to your own access). For steps to obtain either credential, see API authentication.
Tip: The token is shown only once when created. Copy and store it securely.
Python Requirements
We have support for Python versions 3.9-3.11
requests library, which already ships with the base package. To run the Omni ingestion, you will need to install:
All connectors are defined as JSON Schemas.
Here
you can find the structure to create a connection to Omni.
In order to create and run a Metadata Ingestion workflow, we will follow
the steps to create a YAML configuration able to connect to the source,
process the Entities if needed, and reach the OpenMetadata server.
The workflow is modeled around the following
JSON Schema
1. Define the YAML Config
This is a sample config for Omni:
2. Run with the CLI
First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration,
you will be able to extract metadata from different sources.
Lineage
Omni resolves lineage from each topic’s declared base table, so it doesn’t need to parse warehouse query logs. A topic built on top of a table OpenMetadata has already indexed produces a direct edge from that source table, through the topic (data model), to every dashboard tile built on it. There is no separate lineage agent or pipeline: lineage is collected as part of the same metadata ingestion workflow above. 