Use Anypoint Studio to Configure Commerce Cloud B2C Shop Connector - 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:

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 Use Studio to Configure a Connector. If, after reading this topic, you need additional information about the connector fields, see the Commerce Cloud B2C Shop Connector Reference.

Prerequisites

To avoid dependency errors, update your Maven settings.xml file if needed. See Maven Reference for more information (Ignore if already done).

Create a Mule Project

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

  1. In Studio, select File > New > Mule Project.

  2. Enter a name for your Mule project and click Finish.

Add the Connector to Your Mule Project

Add Anypoint Connector for Salesforce Commerce Cloud B2C Shop APIs (B2C Shop 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:

  1. In the Mule Palette view, click (X) Search in Exchange.

  2. In Add Modules to Project, type commerce cloud b2c shop in the search field.

  3. Click Commerce Cloud B2C Shop Connector in Available modules.

  4. Click Add.

  5. 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 Commerce Cloud B2C Shop 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:

  1. In the Mule Palette view, select HTTP > Listener.

  2. Drag Listener to the Studio canvas.

  3. On the Listener configuration screen, optionally change the value of the Display Name field.

  4. Specify a value for the Path field.

  5. Click the plus sign (+) next to the Connector configuration field to configure a global element that can be used by all instances of HTTP Listener in the app.

  6. On the General tab, specify connection information for the connector.

  7. On the TLS tab, optionally specify the TLS information for the connector. For TLS configuration information, see TLS Configuration.

  8. On the Advanced tab, optionally specify reconnection information, including a reconnection strategy. For Reconnection strategy details, see Reconnection Strategies.

  9. Click Test Connection to confirm that Mule can connect with the specified server.

  10. 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 B2C Shop Connector, follow these steps:

  1. In the Mule Palette view, select Commerce Cloud B2C Shop Connector and then select the desired operation.

  2. Drag the operation onto the Studio canvas to the right of the input source.

shop connector add operation to flow

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 Commerce Cloud B2C Shop Connector system. Commerce Cloud B2C Shop Connector supports two different types of connection provider:

  1. Customer Auth Connection Provider

  2. OAuth2 Application Connection Provider

To configure the global element for Commerce Cloud B2C Shop Connector, follow these steps:

  1. Select the name of the connector in the Studio canvas.

  2. In the configuration screen for the operation, click the plus sign (+) next to the Connector configuration field to access the global element configuration fields.

  3. On the General tab, configure the connection:

  4. On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.

  5. Click Test Connection to confirm that Mule can connect with the specified server.

  6. Click OK.

[ === Get the Shopper JWT Token

To get the Shopper JWT Token to use for the Commerce Cloud B2C Shop Connector Customer Auth Config:

  1. On the General tab of the Global Element Properties screen, select Commerce Cloud B2C Shop Connector Shopper Token and click OK.

  2. Configure the following parameters:

    Field Name Value

    Base URI

    Parameter base URI. Each instance or tenant gets its own base URI.

    shop connector shopper token config

The XML configuration looks like this:

    <commerce-cloud-shopper-api:shopper-token-config name="Commerce_Cloud_B2C_Shop_Connector_Shopper_token" doc:name="Commerce Cloud B2C Shop Connector Shopper token" doc:id="9edebcff-2328-4312-88eb-d8ab4dcbd7cd" >
        <commerce-cloud-shopper-api:shopper-token-connection baseUri="${shopper.baseUri}" />
    </commerce-cloud-shopper-api:shopper-token-config>

Customer Auth Connection Provider Configuration

Before you configure the connection for Commerce Cloud B2C Shop Connector Customer Auth Config, get the Shopper JWT Token.

  1. On the General tab of the Global Element Properties screen, select Commerce Cloud B2C Shop Connector Customer Auth Config and click OK.

  2. Configure the following parameters:

    Field Name Value

    Base URI

    Parameter base URI. Each instance or tenant has its own base URI.

    Authorization

    Provide the Commerce Cloud B2C Shopper JWT Token as the authorization parameter.

    This example adds the base URI to the application properties file and references it using placeholders:

    shop connector customer auth config
  3. Click Test Connection to verify the configuration.

The XML configuration looks like this:

    <commerce-cloud-shopper-api:customer-auth-config name="Commerce_Cloud_Shopper_Connector_Customer_auth_config" doc:name="Commerce Cloud Shopper Connector Customer auth config" doc:id="3513fbf9-98ad-45a0-bd8e-5f01f1f340b2">
        <commerce-cloud-shopper-api:shopper-connection baseUri="${shopper.baseUri}" authorization="#[attributes.headers.Authorization]" />
    </commerce-cloud-shopper-api:customer-auth-config>

OAuth2 Application Connection Provider

  1. On the General tab of the Global Element Properties screen, select Commerce Cloud B2C Shop Connector Config and click OK.

  2. Configure the following parameters:

    Field Name Value

    Base Uri

    Access API URL

    Client Id

    ID of the client account created with Salesforce Commerce Cloud

    Client Secret

    Secret of the client account created with Salesforce Commerce Cloud

    Token url

    Access token URL

    Scopes

    Scopes for access

    Commerce Cloud B2C Shop Connector Config with values for the OAuth 2.0 client credentials connection

    This example adds credentials to the application properties file and references it using placeholders:

  3. Click Test Connection to verify the configuration.

The XML code for the OAuth 2.0 application connection provider configuration looks like this:

   <commerce-cloud-shopper-api:config name="Commerce_Cloud_B2C_Shop_Connector_Config" doc:name="Commerce Cloud B2C Shop Connector Config" doc:id="b487e17a-b80a-4cf4-a2f3-d24d47690844" >
		<commerce-cloud-shopper-api:am-oauth2-connection baseUri="${shopper.baseUri}" >
			<commerce-cloud-shopper-api:oauth-client-credentials clientId="${shopper.clientId}" clientSecret="${shopper.clientSecret}" tokenUrl="${shopper.tokenUrl}" scopes="${shopper.scopes}" />
		</commerce-cloud-shopper-api:am-oauth2-connection>
	</commerce-cloud-shopper-api:config>

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.

Configure the Other Connector Fields

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