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

​
Requirements

Before ingesting metadata, set up authentication for MuleSoft Anypoint Platform.

​
Metadata

To extract metadata from MuleSoft Anypoint Platform, you need either:
  • Basic Authentication: Username and password with appropriate permissions.
  • OAuth 2.0 Connected App: Client ID and Client Secret for OAuth authentication.
The user or connected app needs to have permissions to:
  • Access and read applications in the specified organization.
  • Query CloudHub and Runtime Manager APIs.
  • Read environment configurations.
For more information about MuleSoft Anypoint Platform authentication, see the official documentation.

​
Permissions

The authenticated user or connected app should have:
  • Read access to applications in the target organization and environments.
  • Permissions to view application details and configurations.
  • Access to CloudHub or Runtime Manager depending on deployment type.

​
Metadata Ingestion

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

​
Step 1: Add New Service

  1. In the left navigation, click Connections.
  2. On the Connections page, 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 MuleSoft 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 MuleSoft services you are ingesting metadata from.
  • Optional: Enter a Description for the service.
Add New Service Name
Note: The service name cannot be changed after it is set.

​
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 MuleSoft. The right-hand panel in the UI displays inline help for each field. Configure Service Connection
  • Host and Port: MuleSoft Anypoint Platform URL. Use https://anypoint.mulesoft.com for US cloud, https://eu1.anypoint.mulesoft.com for EU cloud, or your on-premises URL.
    • Authentication: Choose between two authentication methods:
      • Basic Authentication: Provide username and password
      • OAuth 2.0 Client Credentials (Connected App): Provide Client ID and Client Secret
    • Organization ID (Optional): Anypoint Platform Organization ID. If not provided, the connector will use the user’s default organization.
    • Environment ID (Optional): Anypoint Platform Environment ID. If not provided, the connector will discover all accessible environments.
    • Application Filter Pattern (Optional): Regex to filter MuleSoft applications by name for selective ingestion.

​
Advanced Configuration

The MuleSoft connector includes an Advanced Configuration section for passing extra arguments to the connector, required only for advanced connectivity scenarios or customizations.
  • Connection Options (Optional): Enter any additional connection options to send to the MuleSoft Anypoint Platform API during the connection. These details must be added as key-value pairs.
  • Connection Arguments (Optional): Enter any additional connection arguments, such as security or protocol configs, to send during the connection. These details must be added as key-value pairs.
Tip: When using a Hybrid Ingestion Runner, any sensitive credential fields—such as passwords, API keys, or 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

Once the credentials have been added, click on Test Connection and Save the changes. 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 patterns use regular expressions applied to pipeline names.

​
How Filter Patterns Work

  • Include: Add one or more comma-separated regular expressions. Collate 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. Collate 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.
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. Each 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 automatically filter out system-reserved names defined by the connector—for example, Exclude system databases for the Databases section.
  • 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.
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 Connections in the left navigation 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. In the left navigation, click Connections and select your service.
  2. 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

MuleSoft Troubleshooting

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