Using Anypoint Studio to Configure Salesforce CDP Connector 1.0 - 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 a source for the connector’s flow.
Add a connector operation to the flow.
Configure a global element for the connector.
Configure the other connector fields.

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

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

Create a Mule Project

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

In Studio, select File > New > Mule Project.
Enter a name for your Mule project and click Finish.

Add the Connector to Your Mule Project

Add Salesforce CDP 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 the Add Dependencies to Project window, type salesforce CDP in the search field.
Click Salesforce CDP 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 CDP 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 source, 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 the Connector configuration field to configure a global element that can be used by all instances of the HTTP Listener source 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 are specifying an action for that connector to perform.

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

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

Configure a Global Element for the Connector

When you configure a connector, 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 CDP system. Salesforce CDP Connector supports OAuth JWT and OAuth Username Password authentication.

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

Select the operation 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 JWT
- OAuth Username Password
  
  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, refer to 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.

OAuth JWT

OAuth JWT uses OAuth 2.0 with a JSON Web Token (JWT) request for user authentication.

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

Field Description

Consumer key

Consumer key for the Salesforce-connected app. See the Salesforce documentation for information about generating a consumer key.

Key store

Path to the keystore that signs data during authentication. See Additional Configuration Information on how to generate a keystore file.

If a relative path is provided, then the file must exist in the corresponding location under the /src/main/resources directory. For example, in the following screenshot, the file is expected to be in the /src/main/resources/prod/keyStoreFile.jks directory.

Store password

Password for the keystore.

Certificate alias

Alias of the certificate to use if the specified keystore contains multiple certificates.

Subject

Username of the Salesforce user.

Audience url

The URL of the authorization server.

The following image shows an example of configuring OAuth JWT authentication:

OAuth JWT is selected in the Connection field and the authentication fields are completed on the *General* tab.

OAuth Username Password

OAuth Username Password authentication uses OAuth 2.0 with a user and password for authentication.

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

Field	Description
Consumer key	Consumer key for the Salesforce-connected app. See the Salesforce documentation for information about generating a consumer key.
Consumer secret	Consumer secret for the connector to access Salesforce.
Username	Salesforce username.
Password	Corresponding password.
Audience url	The URL of the authorization server.

Field

Description

Consumer key

Consumer key for the Salesforce-connected app. See the Salesforce documentation for information about generating a consumer key.

Consumer secret

Consumer secret for the connector to access Salesforce.

Username

Salesforce username.

Password

Corresponding password.

Audience url

The URL of the authorization server.

The following image shows an example of configuring OAuth Username Password authentication:

OAuth Username Password is selected in the Connection field and the authentication fields are completed on the *General* tab.

Configure Additional Connector Fields

After you configure a global element for Salesforce CDP Connector, configure the other required fields for the connector. The required fields vary depending on which connector operation you use.

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.