Mode Connector | OpenMetadata Dashboard Integration Guide

In this section, we provide guides and references to use the Mode connector. Configure and schedule Mode metadata workflows from the OpenMetadata UI:

• Requirements
• Metadata Ingestion
• Troubleshooting

​

Requirements

OpenMetadata relies on Mode’s API, which is exclusive to members of the Mode Business Workspace. This means that only resources that belong to a Mode Business Workspace can be accessed via the API.

​

Metadata Ingestion

To ingest metadata from Mode, you need to create a service connection. The service connects Mode with OpenMetadata. Once you create a service, OpenMetadata automatically starts ingesting metadata.

​

Step 1: Add New Service

1. Navigate to Settings > Services.
2. Click Add New Service.

​

Step 2: Select a Service and Connector

From the service type dropdown, select Dashboard Services, then click the Mode connector tile.

​

Step 3: Add Service Name and Description

• Enter a unique, descriptive Service Name. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other Mode services you are ingesting metadata from.
• Optional: Enter a Description for the service.

​

Step 4: Configure Connection Options

Specify your source credentials and verify the connection.

​

Enter Connection Details

Enter the connection details for Mode. The right-hand panel in the UI displays inline help for each field.

• hostPort: Host and port for the Mode dashboard. The hostPort parameter specifies the host and port of the Mode server. This should be specified as a string in the format https://app.mode.com.
• accessToken: Access Token for Mode Dashboard. Get the Access Token by following the steps below:
  • Navigate to your Mode homepage.
  • Click on your name in the upper left corner and click My Account.
  • Click on API Tokens on the left side.
  • To generate a new API token and password, enter a token name and click Create Token.
  • Copy the generated access token and password.
  For detailed information, see the Mode API reference.
• accessTokenPassword: Access Token Password for Mode Dashboard. Copy the access token password from the step above where a new token is generated. For detailed information, see the Mode API reference.
• workspaceName: Mode Workspace Name. Name of the Mode workspace from which OpenMetadata fetches metadata.

​

Test Connection

Once the credentials have been added, click on Test Connection and Save the changes.

​

Step 5: Configure Ingestion Options

In the What to Ingest step, use filter patterns to control which assets OpenMetadata ingests from your dashboard service. Filter patterns use regular expressions applied to asset names.

​

How Filter Patterns Work

• Include: Add one or more comma-separated regular expressions. OpenMetadata ingests only assets whose names match at least one expression. Leave blank to include all assets.
• Exclude: Add one or more comma-separated regular expressions. OpenMetadata skips any asset whose name matches an expression. Leave blank to exclude nothing.

Rules match asset names using one of five expressions:

• 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. Filter Options The Dashboard, Chart, and Data Model sections each include the following filter options:

• Dashboard: Controls which dashboards OpenMetadata ingests from the source.
• Chart: Controls which charts within the ingested dashboards are included.
• Data Model: Controls which data models are included in metadata ingestion.

Each section provides the following controls:

• Scan Mode: You can 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 (available only in Only specific mode): Click + Add to define a rule. Added rules appear as chips; an asset is included if it matches any rule.

​

Step 6: Create & Deploy

Click Create & Deploy to deploy the agent and start the first metadata ingestion run. OpenMetadata 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 OpenMetadata catalog in sync. It powers discovery, lineage, and governance across your data assets. When you click Create & Deploy, OpenMetadata 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 service type.
2. Click the service you have added.
3. Select the Agents tab and click Add Agent > Metadata. 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.
   • 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 OpenMetadata when they are removed from the source. Associated lineage is also deleted.
     Mark Deleted Data Models	On	Soft-delete data models in OpenMetadata when they are removed from the source. Associated lineage is also deleted.
     Mark Deleted Charts	On	Soft-delete charts in OpenMetadata 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.

     
   • 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: Configure Ingestion Options.
   • 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 OpenMetadata. When off, OpenMetadata only updates fields that have no existing value.
     Override Lineage	Off	When on, existing lineage is replaced with newly extracted lineage on each run.

     
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.
   
6. Click Add to deploy the agent.

​

Lineage

Lineage in OpenMetadata 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, OpenMetadata attempts to match source tables across all ingested database services.

​

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, OpenMetadata searches across all ingested database services.

The Db Service Prefixes field helps OpenMetadata locate the source tables and draw the lineage path from table to dashboard. Examples of valid entries:

​

Related