Skip to main content
This section provides guides and references to use the Matillion connector. Configure and schedule Matillion metadata and profiler workflows from the Collate UI:

​
Requirements

To extract metadata from Matillion, you need to create a user with the following permissions:
  • API Permission (while creating the user, from Admin > User).
  • To retrieve lineage data, the user must be granted Component-level permissions.
  • To enable lineage tracking in Matillion, Matillion Enterprise Mode is required. For detailed setup instructions and further information, refer to the official documentation: Matillion Lineage Documentation.

​
Matillion Versions

Collate is integrated with Matillion up to version 1.75.0.

​
Metadata Ingestion

To ingest metadata from Matillion, you need to create a service connection. The service connects Matillion 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 the Pipelines service. Navigate to Services
  2. Click Add New Service. Add New Service

​
Step 2: Select a Service and Connector

From the service type dropdown, select Pipeline Services, then click the Matillion 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 Matillion 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 Matillion. The right-hand panel in the UI displays inline help for each field. Configure Service Connection
  • hostPort: The hostname or IP address with the REST API enabled, for example, https://<your-matillion-host-name-here>
  • username: The username to authenticate with the Matillion instance.
  • password: The password to authenticate with the Matillion instance.
  • caCertificate: CA Certificate to authenticate with the Matillion instance.
Tip: When using a Hybrid Ingestion Runner, any sensitive credential fields, such as passwords, API keys, and private keys, must reference secrets using the following format:
This applies only to fields marked as secrets in the connection form (these typically mask input and show a visibility toggle icon). For more information about managing secrets in hybrid setups, see the Hybrid Ingestion Runner Secret Management Guide.

​
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 pipeline service. Filter rules match pipeline 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 the filter pattern empty to ingest all pipelines available in the source.

​
Filter Options

The Pipeline section includes one filter option, Pipeline, which controls which pipelines (DAGs, jobs, or workflows) Collate ingests from the source. This section provides the following controls:
  • Scan Mode: Choose one of 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.
  • Exclude system toggle: Use this toggle to filter out system-reserved names defined by the connector for that asset type.
  • 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 is enabled, lineage between pipeline tasks and data assets is tracked 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 pipelines, tasks, 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 Pipelines 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 the core parameters for this agent. The following fields are available: Agent Setup
    • Filter Patterns: Apply include or exclude rules to scope which pipelines 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: 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.

​
Troubleshooting

Matillion Troubleshooting

Learn more about how to troubleshoot common Matillion connector issues and resolve configuration or ingestion errors.