2. Click **Add New Service**.
### Step 2: Select a Service and Connector
From the service type dropdown, select **Dashboard Services**, then click the **Hex** 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 Hex services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.
* **hostPort**: URL to the Hex instance. Provide the URL to your Hex instance. For Hex cloud users, use `https://app.hex.tech`. For on-premise installations, provide your custom domain URL.
* **tokenType**: Type of authentication token. Select the type of token you're using:
* **personal**: Personal access token (default)
* **workspace**: Workspace-level token (requires admin privileges)
* **token**: Hex API Token. Provide the API token generated from your Hex account. This token is used for authentication with the Hex APIs.
To generate a token:
* Log into Hex
* Go to **Account Settings** > **API Keys**
* Create a new API key
* Copy the generated token
* **includeTags**: Import Hex Categories and Status as Tags. Enable this option to import Hex project categories and status as OpenMetadata tags. This helps in organizing and filtering your Hex projects within OpenMetadata. By default, this is set to `true`.
* **Dashboard Filter Pattern**: Use regex patterns to include or exclude specific dashboards from ingestion. This helps you control which Hex projects are imported into OpenMetadata.
Examples:
* Include only production projects: `^prod-.*`
* Exclude test projects: `^(?!test-).*`
#### 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.
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
Hex connector extracts lineage information by:
* **Warehouse Query History**: Directly queries data warehouse logs (Snowflake, BigQuery, Databricks, Redshift, and others) to find queries executed by Hex.
* **Hex Metadata Identification**: Identifies Hex-originated queries using metadata comments embedded by Hex containing project IDs.
* **SQL Parsing**: Analyzes the discovered SQL queries to extract upstream table dependencies.
The lineage information helps you understand:
* Which data warehouse tables are actually queried by each Hex project.
* Real data usage patterns based on executed queries.
* Impact analysis when making changes to underlying data sources.
**Note**: The connector does not use Hex APIs for lineage. Instead, it discovers lineage by analyzing actual queries executed in your data warehouses, providing more accurate data dependency information.
### Warehouse Query Log Requirements
For lineage extraction to work, query logging must be enabled in your data warehouse:
#### Snowflake
* Requires access to `SNOWFLAKE.ACCOUNT_USAGE.QUERY_HISTORY`.
* Query history is automatically maintained by Snowflake.
#### BigQuery
* Requires access to `INFORMATION_SCHEMA.JOBS_BY_PROJECT`.
* Query history is automatically maintained by BigQuery.
#### MySQL
* Requires general\_log to be enabled:
```sql theme={null}
SET GLOBAL general_log = 'ON';
SET GLOBAL log_output = 'TABLE';
```
* Grant access to the `mysql.general_log` table.
#### Databricks
* Requires access to `system.query.history`.
* Query history is automatically maintained.
#### Redshift
* Requires access to the `stl_query` system table.
* Query history is automatically maintained.
#### Other Warehouses
* Athena: Access to query history via CloudTrail or S3 logs.
* ClickHouse: Access to the `system.query_log` table.
## Related