Skip to main content
Mulesoft

Mulesoft

BETA
In this section, we provide guides and references to use the Mulesoft Anypoint Platform connector. Configure and schedule Mulesoft metadata workflows from the Collate UI:

​
Requirements

​
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
You can find more details about MuleSoft Anypoint Platform authentication in 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

1

Visit the Services Page

Click `Settings` in the side navigation bar and then `Services`. The first step is to ingest the metadata from your sources. To do that, you first need to create a Service connection first. This Service will be the bridge between OpenMetadata and your source system. Once a Service is created, it can be used to configure your ingestion workflows.Visit Services Page
2

Create a New Service

Click on _Add New Service_ to start the Service creation.Create a new Service
3

Select the Service Type

Select Mulesoft as the Service type and click _Next_.Select Service
4

Name and Describe your Service

Provide a name and description for your Service.

Service Name

OpenMetadata uniquely identifies Services by their **Service Name**. Provide a name that distinguishes your deployment from other Services, including the other Mulesoft Services that you might be ingesting metadata from. Note that when the name is set, it cannot be changed.Add New Service
5

Configure the Service Connection

In this step, we will configure the connection settings required for Mulesoft. Please follow the instructions below to properly configure the Service to read from your sources. You will also find helper documentation on the right-hand side panel in the UI.Configure Service connection

​
Connection Options

1

Connection Options

  • 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.
2

Test the Connection

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

Configure Metadata Ingestion

In this step we will configure the metadata ingestion pipeline, Please follow the instructions belowConfigure Metadata Ingestion

​
Metadata Ingestion Options

  • Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
  • Pipeline Filter Pattern (Optional): Use to pipeline filter patterns to control whether or not to include pipeline as part of metadata ingestion.
    • Include: Explicitly include pipeline by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all pipeline with names matching one or more of the supplied regular expressions. All other schemas will be excluded.
    • Exclude: Explicitly exclude pipeline by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all pipeline with names matching one or more of the supplied regular expressions. All other schemas will be included.
  • Include lineage (toggle): Set the Include lineage toggle to control whether to include lineage between pipelines and data sources as part of metadata ingestion.
  • Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug.
  • Mark Deleted Pipelines (toggle): Set the Mark Deleted Pipelines toggle to flag pipelines as soft-deleted if they are not present anymore in the source system.
4

Schedule the Ingestion and Deploy

Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.If something doesn’t look right, click the Back button to return to the appropriate step and change the settings as needed.After configuring the workflow, you can click on Deploy to create the pipeline.Schedule the Workflow
5

View the Ingestion Pipeline

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.View Ingestion Pipeline
If AutoPilot is enabled, workflows like usage tracking, data lineage, and similar tasks will be handled automatically. Users don’t need to set up or manage them - AutoPilot takes care of everything in the system.