--- schema_version: "1" id: 25ed2d9ec20a4fd482539950a4b1799f0133211178cdedf5a6f763f385662555 title: Using Anypoint Code Builder to Configure a Connector collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/connectors/introduction/intro-config-use-acb.md canonical_url: https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb source_site: docs.mulesoft.com content_type: documentation content_hash: 8fe711d69270c8d72dc1c74b01b7ad8b89284846bdcfd83174763ef179e11220 description: MuleSoft Documentation Site latest: true --- --- product: Connectors --- # Using Anypoint Code Builder to Configure a Connector > For the full documentation index, see: https://docs.mulesoft.com/llms.txt To use Anypoint Code Builder to configure a connector: - [Create a basic integration project](#create-integration-project) in Anypoint Code Builder. - [Add connectors](#add-connector-to-project) and other components to your Mule application to process your business logic. - [Configure the connector’s trigger](#configure-trigger). - [Configure the connector’s operations](#configure-component-attributes). ## Before You Begin Before creating an integration project, you must: - [Set up and access the Anypoint Code Builder web or desktop IDE.](https://docs.mulesoft.com/anypoint-code-builder/start-acb) - Have credentials to access the connector’s API. To use connectors, you must be familiar with: - The connector’s API - Anypoint Connectors - Mule runtime engine (Mule) After you complete the prerequisites, you are ready to create an app and configure the connector by using Anypoint Code Builder. ## Create a New Integration Project 1. In the activity bar of the IDE, click the ![Anypoint Code Builder icon](/mulesoft/current/en-us/connectors/_images/acb-icon-ms-logo.png) (**Anypoint Code Builder**) icon. 2. From **Quick Actions**, click **Develop an Integration**: ![Develop an Integration link highlighted in the Getting started section](/mulesoft/current/en-us/anypoint-code-builder/_images/develop-integration-option-mat.png) 3. Complete the **Develop an Integration** form.
AttributeValue

Project Name

Unique name for your project.

This name is used as the title and name of the integration project file. For example, if the project name is "Salesforce Integration," the project file name is salesforce-integration.

Project Location

Your home directory or another directory you create. Click Browse to select a different directory for the integration project.

Don’t create the project within another project directory.

4. Click **Create Project**. ## Add the Connector to Your Integration Project Anypoint Connectors provide operations for retrieving, modifying, and sending data to and from systems. In addition to the [built-in connectors](https://docs.mulesoft.com/anypoint-code-builder/acb-reference#builtin-connectors) that Anypoint Code Builder provides, you can download many other connectors from Anypoint Exchange. To import a connector from Exchange and add it to your configuration: 1. In the Explorer view, open the configuration XML file for your project, such as `my-project-name.xml`. 2. Click the ![Show Mule graphical mode icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-tree-view.png) (**Show Mule graphical mode**) icon in the activity bar to open the canvas UI if it doesn’t open automatically. 3. Add the connector the same way you added other components from the canvas UI: 1. In the canvas UI, click the ![Add Component icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-plus.png) (**Add component**) icon. 2. In the **Add Component** panel, click **Connectors**. 3. Click the connector name and then click the operation to add, such as **Publish**: ![Add Publish operation from the Anypoint MQ Connector](/mulesoft/current/en-us/anypoint-code-builder/_images/int-add-connector-operation.png) If the connector isn’t available locally, click the ![Search in Exchange icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-search-exchange.png) (**Search in Exchange**) toggle: ![Search in Exchange toggle](/mulesoft/current/en-us/anypoint-code-builder/_images/int-connector-search-exchange.png)
1Search locally
2Search in Exchange
4. Select the connector to add to your project. 5. Select the operation from the **Add Component** panel. Adding a connector to an integration project does not make that connector available to other projects in your Anypoint Code Builder workspace. ## Update the Connector Version To update a connector to a newer version in Anypoint Code Builder, see [Select Connector Versions for a Project](https://docs.mulesoft.com/anypoint-code-builder/int-versions#project-versions-connectors). Updating to a new major version (for example, from `1.x` to `2.x`) can introduce backward-compatibility changes. Before you upgrade, review the release notes and, if available, the upgrade and migration guide for the connector. ## Creating a Configuration File A configuration file is a YAML file that references other configurations and specifies values for your connector’s properties. Define the configuration properties based on the environment that you are deploying your application to. 1. In the **Explorer** view, right-click the **resources** folder (`src/main/resources`) and select **New File**. 2. Name the file `config.yaml`. 3. Populate your file with the connection properties required to connect to your connector. The following shows examples of Salesforce, Gmail, and Slack connection properties: ```YAML salesforce: username: "yourUserName" password: "yourPassword" token: "yourToken" email: host: "smtp.gmail.com" username: "yourGmailEmail" password: "yourEmailAppPassword" slack: token: "yourSlackToken" ``` 4. Navigate to your project XML, add a new line before the `` tag, type `configuration`, and select **mule:configurationProperties**: ![List of components with an arrow pointing to the mule:configurationProperties component](/mulesoft/current/en-us/anypoint-code-builder/_images/select-mule-config-properties-contacts-sync.png) 5. Scroll through the attributes and set the value of `file` to `config.yaml`: ```XML ``` ### Salesforce Connector Configuration Example Use the values in your `config.yaml` file to connect Salesforce Connector to your Salesforce environment: 1. In your project XML file, create a new line after the `` element, type `salesforce`, and select **salesforce:sfdc-config**. 2. Set the **name** field to `Salesforce-Config`. 3. Create a new line, type `basic`, and select **Salesforce:Basic**. 4. Configure the `username` and `password` properties to use your configuration file values: ```XML ``` > [!NOTE] When you move your cursor over the `${salesforce.username}` and > `${salesforce.password}` elements, Anypoint Code Builder shows the values from the > configuration file. 5. Click **Test Connection** for the `` element to verify your connection to Salesforce: ![Arrow pointing to the Test Connection option in the connection XML](/mulesoft/current/en-us/anypoint-code-builder/_images/sync-api-sfdc-test-connection.png) Anypoint Code Builder returns a **Connection is valid** message. If you get an error, check the error message to troubleshoot further. For more information, see [Troubleshooting Anypoint Code Builder](https://docs.mulesoft.com/anypoint-code-builder/troubleshooting). ## Configuring a Trigger for the Flow A trigger (source) starts the flow when specified conditions are met. If a connector has its own associated sources, you can use a connector-specific trigger to initiate the flow. Each connector trigger has a unique configuration. ### Configuring HTTP Listener To use HTTP Listener as a trigger for the flow: 1. Click the **Listener** component on the canvas. 2. (Optional) Click the edit icon to change the name of the **Listener** component. 3. (Optional) If you created a configuration file for the connector, select it. 4. In the **General** tab, in the **Path** field, enter the relative path for the path set in the HTTP configuration element. See [Configure Paths](https://docs.mulesoft.com/http-connector/latest/http-listener-ref#configure-paths). 5. Select the **Advanced** tab to configure the following attributes:
AttributeDescriptionRequired

Allowed methods

To allow all HTTP methods (default), do not define this attribute. To restrict specific methods, specify the allowed HTTP methods in a comma-separated format, for example, POST,GET.

No

Response streaming mode

Whether to use streaming when the response is sent. When HTTP Connector manages response bodies, the connector considers the type of data to send and uses chunked encoding when the body size isn’t clear. This causes streams with no size information. To control this behavior, select any of these options:

  • AUTO (default)
    Uses Content-Length encoding if a size is defined for the body, otherwise uses Transfer-Encoding: chunked.

  • ALWAYS
    Uses Transfer-Encoding: chunked regardless of any size data present.

  • NEVER
    Uses Content-Length encoding, consuming streams if necessary to determine the data size.

No

Output MIME type

MIME type of the payload that this component outputs.

No

Parameters

Appends a key-value pair for a reader property to the value of the Output MIME attribute. Multiple key-value pairs are allowed.

No

Output encoding

Encoding of the payload that this component outputs.

No

Streaming Strategy

For more information about configuring the streaming strategy, see Configuring the Streaming Strategy in XML.

No

Primary node only

If selected, executes the Listener trigger on the primary node only when the app is running in a cluster.

No

Redelivery policy

Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow. For more information about configuring the redelivery policy, see Redelivery Policy.

No

Reconnection strategy

When an operation in a Mule application fails to connect to an external server, the default behavior is for the operation to fail immediately and return a connectivity error. You can modify the default behavior by configuring the reconnection strategy for the operation. See Reconnect, Reconnect Forever, and Configuring the Reconnection Strategy in XML.

No

Response

Attributes that contain the metadata associated with the body (or payload) of the message. For more information, see HTTP Response Attributes.

No

Error Response

If selected, the HTTP error response returns a status code for the error.

No

Body

Body of the error message.

No

Headers

Headers to include in the error message. Each header attribute is a key-value pair separated by an equal sign (=), for example:

Headers=[
          date=Sun, 20 Jan 2019 19:13:51 GMT
          content-type=text/html;
          charset=UTF-8
          transfer-encoding=chunked
          connection=keep-alive
          set-cookie=__cfduid=d03462713a0b2c57c8d2ad3bf311287041548011631;
          expires=Mon, 20-Jan-20 19:13:51 GMT;
          path=/;
          domain=.typicode.com;
          HttpOnly
          x-powered-by=Express
          vary=Origin, Accept-Encoding
          access-control-allow-credentials=true
          cache-control=public, max-age=14400
          last-modified=Tue, 15 Jan 2019 18:17:15 GMT
          via=1.1 vegur
          cf-cache-status=HIT
          expires=Sun, 20 Jan 2019 23:13:51 GMT
          expect-ct=max-age=604800,
          report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
          server=cloudflare
          cf-ray=49c3dc570c2f281c-SJC
       ]

No

Status code

Status code of the error response, for example, Status Code=500.

No

Reason phrase

Reason for the error, for example, Gateway Timeout or Internal Server Error.

No

For details about the Listener configuration attributes, see [Listener Configuration](https://docs.mulesoft.com/http-connector/latest/http-documentation#listenerConfig). ### Configuring Scheduler The Scheduler sets a scheduling strategy at a fixed frequency or an interval based on a cron expression. When adding a Scheduler to your Mule application, consider these points: - Schedulers use the same timezone as the machine on which Mule is running. However, if an application is running in CloudHub, the Scheduler conforms to the UTC timezone, regardless of the geographic region in which the application is running. To set a different time zone for the Scheduler, see `timeZone` in the [cron scheduling strategy attributes](#cron-attributes). - The `disallowConcurrentExecution` property enables you to prevent the Scheduler from triggering the execution of the flow while a previously-triggered execution is running. - If [back-pressure](https://docs.mulesoft.com/mule-runtime/latest/execution-engine#backpressure) occurs because no resources are available at the time of the scheduled trigger, Mule skips that execution. - In a Mule runtime engine cluster or multi-worker CloudHub deployment, the Scheduler executes only on the primary node (that is, only in one Mule instance). ```xml ``` Scheduler (``) attributes are configurable through the UI and XML.
Attribute NameAttribute XMLDescription

Scheduler (default)

doc:name

Editable name for the component to display in the canvas.

N/A

doc:id

Automatically generated identifier for the component.

Disallow concurrent execution

disallowConcurrentExecution

When this attribute is set to true, the Scheduler skips its scheduled execution if a previous execution is still running. Once the flow finishes, the Scheduler executes at the next configured interval. The default value is false.

**Scheduling strategy** (``) is a child element of Scheduler.
Child ElementDescription

<scheduling-strategy/>

Accepts a <fixed-frequency/> or <cron/> configuration.

### Fixed Frequency Attributes Scheduler accepts a fixed frequency (``) element that accepts these attributes:
Attribute NameAttribute XMLDescription

N/A

frequency

The frequency at which the Scheduler triggers the flow given the timeUnit setting. Defaults to 1000.

N/A

startDelay

The amount of time to delay execution of the Scheduler for the first time after the application starts. This property uses the same timeUnit as the frequency. Defaults to 0.

N/A

timeUnit

One of the following time units for the values of frequency and startDelay: MILLISECONDS, SECONDS, MINUTES, HOURS, or DAYS. Defaults to MILLISECONDS.

See the [fixed frequency examples](#example1). ### Cron Attributes For more complex scheduling, configure a cron expression in the `` element.
Attribute NameAttribute XMLDescription

N/A

expression

A cron expression for triggering the Scheduler. There is no default cron expression. For guidance with expressions, see Cron Expressions. Example: expression="1 1 1 1,7 * ?".

N/A

timeZone

Time zone passed as a system property, or in a machine’s operating system. Java time zone values are supported. Avoid Java abbreviations, such as PST and AGT, and instead use the full-name Java equivalents, such as America/Los_Angeles. Example: timeZone="America/Argentina/Buenos_Aires".

See the [cron examples](#example2). ### Fixed Frequency Examples In the following example, the Scheduler executes every fifteen seconds: ```xml ``` In the following example, the Scheduler skips its execution if the flow takes longer to complete than the fixed frequency of 10 milliseconds: ```xml ``` Each time a Scheduler skips its execution, Mule logs an `Execution skipped` message, for example (edited for readability): ```logs INFO 2022-11-09 15:15:43,082 ... ...scheduler.DefaultSchedulerMessageSource: Flow 'scheduler-disallowConcurrentExecution-ex' is already running and 'disallowConcurrentExecution' is set to 'true'. Execution skipped. INFO 2022-11-09 15:15:43,083 ... ...scheduler.DefaultSchedulerMessageSource: Flow 'scheduler-disallowConcurrentExecution-ex' is already running and 'disallowConcurrentExecution' is set to 'true'. Execution skipped. ``` The following example shows a fixed-frequency scheduling strategy that executes the Scheduler every 10 seconds after an initial 10 second delay: ```xml ``` ### Cron Examples The following example uses a cron expression to trigger the generation of a Mule message in a new execution of the flow every fifteen seconds: ```xml ``` The following example uses a cron expression to trigger the flow at 12:00 every day in the `America/Los_Angeles` time zone. ```xml ``` ## Cron Expressions Cron is a widely used standard for describing time and date information. The Cron Expression (`` scheduling strategy (``) is useful for triggering a flow at intervals not available through the Fixed Frequency scheduling strategy. The Scheduler keeps track of every second and creates a Mule event when the Quartz Cron expression matches your time-date setting. You can trigger the event just once or at regular intervals. A date-time expression consists of six required settings and can include the optional year setting. Specify the settings in the following order: 1. Seconds (`0`\-`59`) 2. Minutes (`0`\-`59`) 3. Hours (`0`\-`23`) 4. Day of month (`1`\-`31`) 5. Month (`1`\-`12` or `JAN`\-`DEC`) 6. Day of the week (`1`\-`7` or `SUN`\-`SAT`) 7. Year (empty or a 4-digit year between `1970`\-`2099`, for example, `2019`) The Scheduler supports Quartz Cron expressions. Here are a few examples:
ExpressionBehavior

1/2 * * * * ?

Run every 2 seconds of the day, every day.

0 15 10 ? * *

Run at 10:15 a.m., every day. 0 15 10 * * ? * and 0 15 10 * * ? produce the same effect.

0 15 10 * * ? 2019

Run at 10:15 a.m., every day during the year 2019.

0 * 14 * * ?

Run every minute starting at 2pm and ending at 2:59pm, every day.

0 0/5 14 * * ?

Run every 5 minutes starting at 2pm and ending at 2:55pm, every day

1 1 1 1,7 * ?

Run the first second of the first minute of the first hour, on the first and seventh day, every month.

The Scheduler component also supports Quartz Scheduler special characters: - `*`: All values. - `?`: No specific value. - `-`: Range of values, for example, `1-3`. - `,`: Additional values, for example, `1,7`. - `/`: Incremental values, for example, `1/7`. - `L`: Last day of the week or month, or last specific day of the month (such as `6L` for the last Saturday of the month). - `W`: Weekday, which is valid in the month and day-of-the-week fields. - `#`: "nth" day of the month. For example, `#3` is the third day of the month. This example logs the message "hello" every second: ```XML ``` Note that there are many free online tools that can help you build Cron expressions. ### Using a Connector-Specific Trigger If a connector has associated triggers, you can use a connector-specific trigger to initiate the flow. Each connector trigger has a unique configuration. For example, you can configure one of these triggers to use with Salesforce Connector: - **On Deleted Object** Initiates your app when a Salesforce user deletes an object. Possible object types are `Contact`, `Lead`, `Account`, `Contracts`, `Opportunity`, or the name of a custom object. - **On Modified Object** Initiates your app when a Salesforce user modifies an object. Possible object types are `Contact`, `Lead`, `Account`, `Contracts`, `Opportunity`, or the name of a custom object. - **On New Object** Initiates your app when a Salesforce user creates a new object. Possible object types are `Contact`, `Lead`, `Account`, `Contracts`, `Opportunity`, or the name of a custom object. - **Replay channel listener** Subscribes to a streaming channel. This source provides channel-related notification settings for new events and events stored by Salesforce within the 24-hour retention period. Events that occur in the specified channel source trigger the flow. - **Replay topic listener** Subscribes to a topic. This source provides topic-related notification settings for new events and events stored by Salesforce within the 24-hour retention period. Events that occur on records in the specified topic trigger the flow. - **Subscribe channel listener** Subscribes to a streaming channel. This source provides channel-related notification settings for new events that occur after you subscribe. - **Subscribe topic listener** Subscribes to a topic. This source provides topic-related notification settings for new events that occur after you subscribe. > [!NOTE] A channel or topic must be published to Salesforce before a subscription to the channel > can be created. For example, to configure the **On New Object** source: 1. Add the **On New Object** component to the canvas. 2. Click the **On New Object** component on the canvas. 3. In the **General** tab, select the configuration file to use, and configure the following attributes:
AttributeDescriptionRequired

Object type

Salesforce object type.

Yes

Triggers query

Query that filters the trigger results, for example, Name='Filter'.

No

Since

Date in the YYYY-MM-DD hh:mm:ss format, for example, 2017-03-17 16:30:40. If this field is empty, this source retrieves the selected objects from the time the Mule app started.

No

Scheduling strategy

Triggers the flow’s execution based on a time-based condition. See Configuring Scheduler.

Yes

4. Select the **Advanced** tab to configure the following attributes:
AttributeDescriptionRequired

Primary node only

Executes the On New Object trigger only on the primary node when the app is running in a cluster if selected.

No

Redelivery policy

For more information, see Redelivery Policy

No

Read timeout

How long the consumer waits for a response before it times out.

No

Time unit

Time unit for the Read timeout attribute. Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

No

Reconnection strategy

See Reconnect and Reconnect Forever, and Configuring the Reconnection Strategy in XML.

No

## Configure the Component Attributes After you add components to your integration project, configure the attributes in the component UI, or configure the attributes directly in the XML code editor. Connector XML tags start with a namespace followed by an operation, following the syntax `namespace:operation`, such as `` for a **Select** operation in Anypoint Connector for Database (Database Connector). ## Configuring a Connector in XML Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Code Builder: - If you manually code a Mule runtime engine (Mule) app in XML from the Anypoint Code Builder XML editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Anypoint Code Builder, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. This example shows how the namespace statements are placed in the `` XML block: ```xml ``` The Apache Maven `pom.xml` file generated by Anypoint Code Builder contains dependencies for a Mule app. If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml {group-id-exchange} {artifact-id-exchange} x.x.x mule-plugin ``` Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for the connector. 4. Select the connector. 5. Click **Dependency Snippets**. ### Configuring the Streaming Strategy in XML You can configure how Mule handles streams with streaming strategies. ### File-Stored Repeatable Stream The following is an XML example of reading a file that is configured with a 1 MB buffer: ```xml ``` If you consistently process a file that’s no larger than 10 KB, you can save memory by reducing the `inMemorySize` attribute: ```xml ``` ### In-Memory Repeatable Stream The following XML example shows an in-memory repeatable stream with a 512 KB initial size, which grows at a rate of 256 KB and allows up to 2000 KB (2 MB) of content in memory: ```xml ``` ## Configuring the Reconnection Strategy in XML The following is an XML example of a standard reconnection strategy setting the count of reconnection attempts before failing to `5` and setting `failsDeployment` to true, which causes the application deployment to fail if the connection test fails. Because a frequency is not specified, the retry interval is the default of every 2000 ms: ```xml ``` The following is an XML example of a reconnect forever strategy where the connector attempts to reconnect every 4000 ms for as long as the application runs: ```xml ``` ## See Also - [Anypoint Code Builder Overview](https://docs.mulesoft.com/anypoint-code-builder/) - [Creating Integrations](https://docs.mulesoft.com/anypoint-code-builder/int-create-integrations) - [Using Anypoint Code Builder to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb) - [Anypoint Code Builder Components and Commands Reference](https://docs.mulesoft.com/anypoint-code-builder/acb-reference) - [Defining and Securing Properties for a Mule Application](https://docs.mulesoft.com/anypoint-code-builder/int-create-secure-configs) - [Triggering Flows in Your Development Environment](https://docs.mulesoft.com/anypoint-code-builder/int-trigger-flows) - [Configuring Components](https://docs.mulesoft.com/anypoint-code-builder/int-configure-components) - [Debugging Mule Applications](https://docs.mulesoft.com/anypoint-code-builder/int-debug-mule-apps) - [Salesforce Help](https://help.salesforce.com)