Using Anypoint Studio to Configure Salesforce Composite Connector 2.13 - Mule 4

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files.

To add and configure a connector in Studio:

Create a Mule project.
Add the connector to your Mule project.
Configure an input source for the connector’s flow.
Add a connector operation to the flow.
Configure a global element for the connector.

When you run the connector, you can view the app log to check for problems, as described in View the App Log.

If you are new to configuring connectors in Studio, see Using Anypoint Studio to Configure a Connector. If, after reading this topic, you need additional information about the connector fields, see the Salesforce Composite Reference.

Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

Select File > New > Mule Project.
Enter a name for your Mule project and click Finish.

Add the Connector to Your Mule Project

Add Salesforce Composite Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s pom.xml file:

In the Mule Palette view, click (X) Search in Exchange.
In Add Modules to Project, type salesforce composite in the search field.
Click Salesforce Composite in Available modules.
Click Add.
Click Finish.

Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace.

Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Salesforce Composite Connector:

HTTP Listener
Initiates a flow each time it receives a request on the configured host and port
Scheduler
Initiates a flow when a time-based condition is met

For example, to configure an HTTP listener, follow these steps:

In the Mule Palette view, select HTTP > Listener.
Drag Listener to the Studio canvas.
On the Listener configuration screen, optionally change the value of the Display Name field.
Specify a value for the Path field.
Click the plus sign (+) next to Connector configuration to configure a global element that can be used by all instances of HTTP Listener in the app.
On the General tab, specify connection information for the connector.
On the TLS tab, optionally specify the TLS information for the connector.
On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.
Click Test Connection to confirm that Mule can connect with the specified server.
Click OK.

Add a Connector Operation to the Flow

When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform.

To add an operation for Salesforce Composite Connector, follow these steps:

In the Mule Palette view, select Salesforce Composite and then select the desired operation.
Drag the operation onto the Studio canvas to the right of the input source.

Configure a Global Element for the Connector

When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Salesforce Composite system. Salesforce Composite Connector supports OAuth v2.0, OAuth JWT, OAuth SAML, and OAuth Username and Password.

To configure the global element for Salesforce Composite Connector, follow these steps:

Select the name of the connector in the Studio canvas.
In the configuration screen for the operation, click the plus sign (+) next to the Connector configuration field to access the global element configuration fields.
On the General tab, in Connection, select the authentication method to configure:
- OAuth v2.0
- OAuth JWT
- OAuth SAML
- OAuth Username and Password
- Token Connection
  
  You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see Anypoint Connector Configuration.
On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.
Click Test Connection to confirm that Mule can connect with the specified server.
Click OK.
On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.
Click Test Connection to confirm that Mule can connect with the specified server.
Click OK.

OAuth Username and Password

Enter the following information on the General tab of the Global Element Properties screen to configure Basic authentication:

Consumer Key
The consumer key for the Salesforce connected app
Consumer Secret
The consumer secret for the connector to access Salesforce
Username
The Salesforce username
Password
The corresponding password
- Security Token
  The corresponding security token
  
  Figure 1. The basic authentication includes a consumer key, consumer secret, username, and password.

View the App Log

To check for problems, you can view the app log as follows:

If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window.
If you’re running the app using Mule from the command line, the app log output is visible in your OS console.

Unless the log file path is customized in the app’s log file (log4j2.xml), you can also view the app log in the default location MULE_HOME/logs/<app-name>.log. You can configure the location of the log path in the app log file log4j2.xml.

Next Step

After you configure a global element and connection information, configure the other fields for the connector. See Examples for use cases.