Omni (beta)

👶

Beta Feature

Beta features represent newly added features in the product, and there is a chance of incompatible changes that impact the API and functionality in subsequent releases as we approach a stable version. As such we will not provide any advanced notice of any deprecation of functionality related to beta features.

Omni Dashboard with Validio Browser Extension Panel

The Omni integration for Validio is a credential configuration to fetch metadata from Omni about dashboards and charts and display these assets in Validio data Catalog and Lineage. The integration does not perform any updates or edits to Omni.

Prerequisites for Integrating with Omni

To connect Validio with your Omni instance, create an API key. You have two authorization options: Organization keys or Personal tokens.

Omni Organization Keys

Organization keys require Omni Admin permissions to create and access the API keys. The organization keys provide access to the full Omni catalog, including workbooks and dashboards. Refer to Omni documentation for creating organization keys.

📘

You can scope down which resources are ingested into Validio by using the User field in the Validio credentials configuration. Set the field to the email of a user in Omni, and then only resources that the user has access to will be ingested.

Omni Personal Tokens

Personal tokens are API keys tied a single Omni user and only provides access to Omni resources that the specific user has access to.

📘

When using personal tokens, the User field in the Validio credential configuration must be left empty.

Add an Omni Credential

To add a Omni credential in Validio,

  1. Navigate to Credentials, and click + New Credential.
  2. Under Namespace, select a namespace to define where resources will be created and who can access it.
  3. Under Credential Type, select Omni.
  4. Fill in the Configuration parameters for the credential. For more information, see Omni Credential Parameters.
  5. (Optional) Click Test credential to validate that Validio can successfully access the Omni account. If validation fails, check that you provided the correct parameter values.
  6. Click Create credential.

Validio will automatically start fetching data and you will be able to view Omni assets and their relationships in the Catalog and Lineage pages.

Omni Credential Parameters

FieldDescription
NameThe display name of your credential.
Base URLThe base URL for the Omni API server, for example: https://company.omniapp.co
User(Optional) The user (email) in your Omni account. Leave this field empty if your API key is a Personal Token.
API KeyThe Organization Key or Personal Token connected to your Omni account.

View Omni Assets in Catalog

To view the Omni assets in Catalog, navigate to Catalog and select the BI Tools tab.

The Omni assets are listed and organized by Name, Type, Date, and Tags.. To view more information about each asset, click on the row to open the details panel.

📘

BI Tool Assets and Sources

Validio BI tool integrations are only credentials, and you cannot use them to create sources or convert their assets to sources.

For more information, see About Data Catalog.

View Omni Relationships in Lineage

Omni Assets in Validio Lineage

To view the Omni assets in Lineage, navigate to Lineage . You can also open Lineage directly for a Omni asset by clicking on the asset in the BI Tools list and clicking on the View in Lineage button in the side panel.

For more information, see About Data Lineage.

Browser Extension Support

If you have the Validio Browser Extension installed, you can easily access data quality and lineage information directly from within your Omni workflow. The extension will automatically detect when you are in an Omni dashboard and provide a link to the corresponding entry in Validio's Data Catalog page.