> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt > Use this file to discover all available pages before exploring further. # Omni Connector | Collate Dashboard Integration > Connect Omni to Collate with our comprehensive dashboard connector guide. Setup instructions, configuration tips, and metadata extraction made simple. export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => { const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0; const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []]; return
{icon &&
{name}
}

{name}

{stage}
{showSubHeading &&
Feature List
{totalAvailableFeatures.map(feature =>
✓ {feature}
)} {unavailableFeatures.map(feature =>
✕ {feature}
)}
}
; }; This section provides guides and references to use the Omni connector. Configure and schedule Omni metadata workflows from the Collate UI: * [Requirements](#requirements) * [Metadata Ingestion](#metadata-ingestion) * [Lineage](#lineage) * [Troubleshooting](/connectors/dashboard/omni/troubleshooting) ## Requirements Collate 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. ### Generate an API Token Collate authenticates with Omni using an API token sent as a `Bearer` token. Use one of the following: * **Organization API Key**: Created by an Organization Admin. Grants access across the organization's models and documents. * **Personal Access Token (PAT)**: Scoped to your own access. For steps to obtain either Omni's credential, see [API authentication](https://docs.omni.co/api/authentication). **Tip**: The token is shown only once when created. Copy and store it securely. ## Metadata Ingestion To ingest metadata from Omni, you need to create a service connection. The service connects Omni with Collate. Once you create a service, Collate automatically starts ingesting metadata. ### Step 1: Add New Service Open the Services page and start a new service. 1. Navigate to **Settings** > **Services** and select **Dashboard Services**. Navigate to Services 2. Click **Add New Service**. Add New Service ### Step 2: Select a Service and Connector From the service type dropdown, select **Dashboard Services**, then click the **Omni** connector tile. Select Service ### Step 3: Add Service Name and Description * Enter a unique, descriptive **Service Name**. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other Omni services you are ingesting metadata from. * Optional: Enter a **Description** for the service. Add New Service Name **Note**: The service name can't be changed after you set it. ### Step 4: Configure Connection Options Specify where ingestion runs, provide your source credentials, and verify the connection. #### Select Ingestion Runner Select an **Ingestion Runner**: the runner where the ingestion pipeline will execute. Add Name and Select Ingestion Runner #### Enter Connection Details Enter the connection details for Omni. The right-hand panel in the UI displays inline help for each field. Configure Service Connection **Connection** * **Host and Port**: URL of the Omni instance, for example `https://your-org.omniapp.co`. The `/api` path is added automatically. **Authentication** * **API Token**: API token to authenticate with Omni. Generated in [Generate an API Token](#generate-an-api-token). **Scope & Options** * **Verify SSL**: Client SSL verification. Configure **SSL Config** if enabled. Defaults to `no-ssl`. **Advanced Config** *(driver-level options; most connections don't need these)* * **CA Certificate**: The CA certificate used for SSL validation. * **SSL Certificate**: The SSL certificate used for client authentication. * **SSL Key**: The SSL key used for client authentication. #### Test Connection 1. Click **Test Connection** to verify the credentials. 2. After the test succeeds, click **Save**. Test Connection ### Step 5: Configure Ingestion Options In the **What to Ingest** step, use filter patterns to control which assets Collate ingests from your dashboard service. Filter rules match asset names using the following match types. #### How Filter Patterns Work * **Include**: Add one or more comma-separated values. Each value uses one of the following match types. Collate ingests only assets whose names match at least one rule. Leave blank to include all assets. * **Exclude**: Add one or more comma-separated values. Each value uses one of the following match types. Collate skips any asset whose name matches a rule. Leave blank to exclude nothing. Rules match asset names using one of five match types: * **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`. * **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`. * **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`. * **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`. * **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`. When both Include and Exclude are set, Exclude takes priority. **Tip**: Leave all filter patterns empty to ingest all dashboards and charts available in the source. #### Filter Options The Dashboard and Chart sections each include the following filter options: * **Dashboard**: Controls which dashboards Collate ingests from the source. * **Chart**: Controls which charts within the ingested dashboards are included. Each section provides the following controls: * **Scan Mode**: Choose between the following scan modes: * **Scan all**: Ingests every asset of that type the connector can access. This is the default. * **Only specific**: Enables include rules so only assets matching at least one rule are ingested. * **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules. * **Preview**: Shows a real-time summary of what will be in scope based on your current rules. * **Include rules**: In **Only specific** mode, click **+ Add** to define a rule. Added rules appear as chips. An asset is included if it matches any rule. **Tip**: If [AutoPilot](/how-to-guides/admin-guide/applications/autopilot) is enabled, usage tracking, data lineage, and other downstream workflows start automatically after the first metadata ingestion completes. ### Step 6: Create & Deploy Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. Collate saves the service configuration and immediately begins pulling metadata from the source. To monitor ingestion progress or view the service you just added, go to **Settings** > **Services** and select your service. ## Configure Metadata Agent and Schedule Ingestion The **Metadata Agent** extracts dashboards, charts, data models, and other structural metadata from your source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets. When you click **Create & Deploy**, Collate automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page. To configure the additional Metadata Agent and schedule ingestion, follow these steps: 1. Navigate to **Settings** > **Services** and select the **Dashboards** service. 2. Select your service and click the **Agents** tab. 3. Click **Add Agent** and select **Metadata** from the dropdown. Add Metadata Agent For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page. 4. On the **Configure Ingestion** page, do the following and click **Next**. * **Name this Ingestion**: Enter a unique, recognizable name for this ingestion pipeline. Name this Ingestion * **Agent Setup**: Configure ingestion parameters. The following fields are available: | Field | Default | Description | | - | - | - | | Db Service Prefixes | — | List of database service name prefixes used to resolve lineage between dashboards and database assets. Accepted formats: `DBService`, `DBService.Database`, `DBService.Database.Schema`, `DBService.Database.Schema.Table`. | | Query Parser Type | Auto | Select the SQL parser used for lineage extraction from dashboard queries. **Auto** selects the best available parser automatically. **SqlGlot** is a high-performance parser with excellent dialect support; falls back to SqlParse on failure. **SqlFluff** is a comprehensive parser with strong dialect support; falls back to SqlParse on failure. | | Mark Deleted Dashboards | On | Soft-delete dashboards in Collate when they are removed from the source. Associated lineage is also deleted. | | Mark Deleted Data Models | On | Soft-delete data models in Collate when they are removed from the source. Associated lineage is also deleted. | | Mark Deleted Charts | On | Soft-delete charts in Collate when they are removed from the source. | | Include Data Models | On | Ingest data model metadata. | | Include Draft Dashboards | On | Ingest dashboards that are in draft state. | | Include Usage | On | Collect and ingest usage statistics for dashboards. | Agent Setup * **Filter Patterns**: Apply include or exclude rules to scope which dashboards, charts, data models, and projects this agent ingests. These follow the same filter options described in **Step 5**. Filter Patterns * **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs: | Toggle | Default | Description | | - | - | - | | Enable Debug Log | Off | Sets the ingestion log level to DEBUG. Useful for troubleshooting. | | Include Current Owners | Off | When enabled, replaces the current owner with a new owner from the source if the current owner is null. Recommended to keep enabled during the first metadata ingestion to capture owner information. | | Include Tags | On | Ingest tags from the source. | | Override Metadata | Off | When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value. | | Override Lineage | Off | When on, existing lineage is replaced with newly extracted lineage on each run. | Scope & Behaviour 5. On the **Schedule Interval** page, set when the agent runs: * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression. * **On-Demand**: No automatic schedule. Trigger the agent manually when needed. Schedule Interval 6. Click **Add** to deploy the agent. ## Lineage ## Lineage Lineage in Collate shows you which database tables power each dashboard. When lineage is set up, you can trace any dashboard back to the exact source tables in your database. There is no separate lineage agent or lineage pipeline—lineage is collected as part of the same metadata ingestion workflow. Configuring the **Db Service Prefixes** field (covered below) is optional but recommended — it restricts table matching to specific database services. If left blank, Collate attempts to match source tables across all ingested database services. Lineage Information ### How to Set Up Lineage 1. Go to **Settings** > **Services** > **Dashboards**. 2. Click the dashboard service you've added. 3. Go to the **Agents** tab, then select **Add Agent** > **Add Metadata Agent**. If a metadata agent already exists, select the three-dot context menu (⋮) next to it and select **Edit**. 4. In the **Configure Ingestion** step, scroll down to the **Lineage Information** section. 5. Optionally enter one or more database service names in the **Db Service Prefixes** field to restrict table matching to specific services. If left blank, Collate searches across all ingested database services. The **Db Service Prefixes** field helps Collate locate the source tables and draw the lineage path from table to dashboard. **Examples of valid entries:** | What you enter | What it matches | | - | - | | `SnowflakeProd` | All tables in the Snowflake service named `SnowflakeProd` | | `SnowflakeProd.sales_db` | Tables in the `sales_db` database within `SnowflakeProd` | | `SnowflakeProd.sales_db.public` | Tables in the `public` schema within `sales_db` | If your dashboards pull data from multiple database services, add each service as a separate entry in the **Db Service Prefixes** field. 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 Collate has already indexed produces a direct edge from that source table, through the topic (data model), to every dashboard tile built on it. ## Troubleshooting Learn more about how to troubleshoot common Omni connector issues and resolve configuration or ingestion errors. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.