Package a Custom Flow Connector as a 2GP Managed Package

In force-app/main/default, create the integArtifactDefs directory. Then, in integArtifactDefs, create these folders and files.

• A folder for the connector: The folder’s name must match the developerName of the connector’s JAR file (.jar) file. To find the developerName, open the JAR file that you exported from Mulesoft Connector Builder, locate the flow-connector.ic file within it, and then search for developerName. For example, if flow-connector.ic defines developerName as MyConnector, name your folder MyConnector.

  Salesforce uses the folder name as the connector’s developer name in the org only when the name matches the JAR file’s internal definition.

  Note

• The metadata file: In the folder for the connector, create the metadata file and add the folder name to its file name. For example, if the folder for the connector is named MyConnector, then name the metadata file MyConnector-meta.xml.
• A subfolder for the JAR file: In the folder for the connector, create a subfolder for the JAR file. The name of this subfolder must be a version number, and it must match the version defined in the connector’s JAR file. To find the version number, open the JAR file, locate the flow-connector.ic file within it, and then search for version. For example, if flow-connector.ic defines version as 1.0.0, name the subfolder 1.0.0. Add the JAR file to this subfolder.

The resulting directory structure looks like this:

1force-app/main/default/integArtifactDefs/
2└── MyConnector/
3    ├── MyConnector-meta.xml
4    └── 1.0.0/
5        └── my-connector.jar

Then, in the metadata file (MyConnector-meta.xml), structure the metadata like this:

1<?xml version="1.0" encoding="UTF-8"?>
2<IntegArtifactDef xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>Connects Salesforce Flow to MySystem</description>
4    <displayName>My Connector</displayName>
5    <groupId>com.example.myconnector</groupId>
6    <iconName>MyConnectorIcon</iconName>
7    <isGlobal>true</isGlobal>
8</IntegArtifactDef>

This table describes each field in the metadata file.

Add a new package entry to the project configuration file (sfdx-project.json). In this example, replace the placeholder values with the values for your managed package.

1{
2  "packageAliases": {
3    "MyConnectorPackage": "0Hoxx0000004ABCDE"
4  },
5  "packageDirectories": [
6    {
7      "path": "force-app",
8      "package": "MyConnectorPackage",
9      "versionName": "ver 0.1",
10      "versionNumber": "0.1.0.NEXT",
11      "default": true
12    }
13  ]
14}

Then, create the package definition in your Dev Hub by running the sf package create CLI command.

1sf package create \
2    --name "MyConnectorPackage" \
3    --package-type Managed \
4    --path force-app

1{
2  "features": ["ExternalConnectivity"]
3}

For other scratch org configuration options, see Scratch Org Features in the Salesforce DX Developer Guide.

Then, create a package version by running the sf package version create CLI command.

1sf package version create \
2    --package "MyConnectorPackage" \
3    --installation-key <your-installation-key> \
4    --code-coverage \
5    --definition-file config/project-scratch-def.json \
6    --wait 60

When the command finishes, it returns a package version ID (starting with 04t). Use this ID to install the managed package in test orgs and to associate it with your AgentExchange listing.

When you’re ready to move forward with listing your managed package on AgentExchange, make sure to verify the package’s listing readiness first. See Check If Your Package Version Is Ready to List on AgentExchange in the ISVforce Guide.