# mulesoft Salesforce Connector - Full Documentation --- product: Salesforce Connector version: 11.2 --- # Processing Events with Salesforce Connector 11.2 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt You can use Anypoint Connector for Salesforce (Salesforce Connector) as an inbound connector to stream data from Salesforce into your application. To use the connector this way, you can use these sources for any type of events (platform events, change data capture events, and the legacy PushTopic and generic events): - **Replay topic listener** - **Replay channel listener** > [!NOTE] If you’re adding a new connector for platform events and change data capture events, you > can use [Salesforce Pub/Sub Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/), which is based > on the Pub/Sub API. When deploying apps in a distributed environment such as a runtime cluster, the source must run on the primary node. Running the source on multiple nodes causes duplicate event consumption and object store data corruption for the data stored by Salesforce Connector. When deploying apps in non-cluster mode with multiple workers, then the source runs on all the nodes which consumes duplicate events. Each event that travels through your flow contains information about the Salesforce data that changed, including how the data changed and when the change occurred. Salesforce stores events for 72 hours (or 24 hours for legacy PushTopic and generic events). A subscriber to a topic or channel can retrieve events related to that topic or channel during this retention window, after which the subscriber can retrieve only newer events that haven’t yet expired. Salesforce assigns a replay ID to each broadcast event, which you can use to replay stored event messages. For more information, refer to [Message Durability](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/using_streaming_api_durability.htm) in the Streaming API Developer Guide. > [!NOTE] Migrating a Salesforce instance to Hyperforce can result in an invalid replay ID error. > This occurs if the Mule app tries to access a replay ID from an object store that is no longer > valid on the new Hyperforce instance. To avoid this error, see this > [knowledge article](https://help.salesforce.com/s/articleView?id=001117442&type=1). ## Before You Begin To process events with Salesforce Connector, ensure that you have: - Access to the Salesforce target resource - The required Salesforce Streaming API permissions enabled in your organization To receive events for Salesforce changes associated with a topic, either create a new topic or use an existing one. ## Object Store Usage in Events Both Salesforce Connector and Mule runtime engine (Mule) use an object store to persist data for features such as automatic message replay and message redelivery: - The object store included in Mule for on-premises deployments of Mule apps has no transaction limits. - The free version of Object Store for CloudHub and CloudHub 2.0 deployments of Mule apps has a limit of 10 transactions per second (TPS), however other Anypoint Connectors using the object store internally have a limit of 100 TPS. For more information about Object Store versions, see [Object Store Notes](https://docs.mulesoft.com/object-store/#object-store-notes). ### Replay Topic Listener and Replay Channel Listener Sources The **Replay topic listener** and **Replay channel listener** sources can continue from the last replay ID they received before restarting the application. When a Mule app starts for the first time, the connector creates an object store that saves data: - If there are no failed events, the source starts from the event associated with the last successfully processed event ID. - If there are one or more failed events, the source starts with the event associated with the lowest replay ID that failed. Saving this change data capture in an object store ensures that no message is processed twice and that when the application restarts, it can reprocess any failed messages. The IDs are stored in the object store for 72 hours, after which they are automatically removed. The connector contains an in-memory structure that stores the replay IDs of events, including events that process successfully or events that fail to process. This in-memory structure uses the username in the connector configuration to persist into the object store to build a specific key. A redundancy mechanism avoids processing duplicate events by storing the same data under a backup key. Each persist operation consists of deleting the existing key and storing the new value, and if storing the new value fails, the connector retries, thus consuming 2 or more TPS per key. If you have multiple workers deployed in CloudHub, the **Replay topic listener** and **Replay channel listener** sources process each message on all Mule instances. To avoid this situation, you can deploy your application on a single worker and then use a shared queue to pass the messages to a different worker to process the message. ### Resume from the Last Replay ID To enable the resume from the last replay ID functionality for the **Replay topic listener** and **Replay channel listener** sources, the connector must store information about the events that were successfully processed by the flow in which the source is used. The connector uses an object store to store that information. The way that the object store stores the necessary data for the resume from the last replay ID functionality varies depending on the environment: - When a Mule app runs locally, the connector creates a persistent store in the file system. If the application stops and restarts, or if a connection issue triggers a reconnection, the data saved in the object store enables the connector to continue processing messages at the point where it stopped. - When a Mule app runs in a cluster with the nodes either on the same machine or on different machines, Mule uses a distributed in-memory object store: - If the primary node (the one consuming the messages) shuts down, the node that takes over for the primary node does not reprocess the same messages. Instead, the node continues from where the previous node stopped processing the messages. - If the cluster stops, the data from the object store is lost. When the cluster restarts, the configuration at the source level determines whether the connector reprocesses the messages. To persist data so that the app continues processing events when restarted, create a persistent object store, as described in [Create and Manage a Cluster Manually](https://docs.mulesoft.com/on-premises/latest/creating-and-managing-a-cluster-manually). - If you use multiple workers when running the app in CloudHub, all of the workers receive and process the events. ### Replay Sources Field Configurations Learn how to handle the priority in the replay sources field setup by using different configurations: - **Replay failed events if any or resume from last replay id** If enabled, this field overwrites anything selected in the **Replay option** field and anything entered in the **Replay id** field. The **Replay failed events if any or resume from last replay id** field checks the Object Store for failed event IDs or last known successfully processed event IDs. If there are failed events, processing starts with the lowest failed event, thus receiving all events from `lowestFailedEventId` until now. For example, if `FailedEventIdInObjectStore` is `10` and `LastSuccessfullyProcessedEventIdInObjectStore` is `15`, processing starts with 10 and the streaming client receives events 10 through 15 and consumes the quota. However, these events are not reprocessed by the flow and are filtered by the connector. If there are no failed event IDs stored, then processing starts with the highest known replay ID. If there is nothing saved in the Object Store, then the **Replay option** field is used. - **ReplayOption.ALL** Subscribes with `-2`. The user receives all events available in Salesforce. - **ReplayOption.ONLY\_NEW** Subscribes with `-1`. The user receives the events created after the connector subscribes. - **ReplayOption.FROM\_REPLAY\_ID** Subscribes with what the user enters in the **Replay id** field. - **ReplayOption.FROM\_LAST\_REPLAY\_ID** Checks the Object Store for the highest received event ID. It doesn’t matter whether the event is processed successfully. This option avoids quota consumption compared to the **Replay failed events if any or resume from last replay id** field, which starts the source with a failed event ID that is lower than the highest processed event ID. If you deploy the Mule app to CloudHub, then use the Object Store V2 option to retain the last processed `ReplayId`. - **Cache events in memory** If enabled, when the application starts, the connector subscribes from a replay ID. The Salesforce API pushes all events that start with the replay ID that is used to subscribe, thus consuming quota. If there are many available events and the Mule app processes them slowly, it can take a while to process all of them. With this option enabled, the events pushed by the API are stored in memory and are consumed sequentially in the order they are received. If there is a connection issue or the token expires and the connector must resubscribe, the events would be lost without this configuration and the quota would be consumed. > [!NOTE] The connector interacts with Object Store to store and retrieve data only when the > **Replay Option** field is set to `FROM_LAST_REPLAY_ID` or when the **Replay failed events if any > or resume from last replay id** checkbox is selected. > > In CloudHub and CloudHub 2.0, when the **Replay Option** field is set to `FROM_LAST_REPLAY_ID` or > when the **Replay failed events if any or resume from last replay id** checkbox is selected, the > last known replay ID might not be found in Object Store, which causes all events to replay when > the application restarts or redeploys. This is because Object Store v2 does not have a distributed > locking mechanism. For more information, refer to > [Last known replayId not found in ObjectStore](https://help.salesforce.com/s/articleView?id=001117329&type=1). ## Multiple Flows That Use the Same Source If you have two or more flows that use a source that listens to events on the same channel or topic, the events are consumed two or more times from your user quota. To avoid this, consider implementing that logic in a single flow instead. > [!WARNING] Having multiple sources listening to the same events and having the **Resume from the > Last Replay Id** option enabled can lead to data corruption and the potential loss of events. ## Multiple Flows with Different Sources Having two or more flows that use different sources with the **Replay Failed Events If Any or Resume from Last Replay Id** option enabled, under certain conditions, might have performance implications. To avoid performance implications, use different Salesforce Connector configurations with different Salesforce usernames. > [!WARNING] Changing the username for a configuration prevents the connector from loading the last > processed and failed replay IDs. Processing resumes from the first event available in Salesforce. > [!WARNING] Avoid using personal user accounts to access Salesforce. ## Working with Platform Events Subscribe to platform events by using Salesforce Connector. The following example is based on the platform events in the [Define and Publish Platform Events](https://trailhead.salesforce.com/content/learn/modules/platform_events_basics/platform_events_define_publish) Trailhead. To receive platform events from Salesforce by using Salesforce Connector: 1. Log in to Salesforce and create a Salesforce platform event, such as `Cloud_News__e`. 2. Go to Anypoint Studio and create a Mule app. 3. Drag the **Replay Channel Listener** source to the canvas and in the **Streaming Channel** field, specify `/event/Cloud_News__e`. 4. Drag a **Logger** component to the canvas to show the payload so you can see the received message on the console, for example: ```xml ``` 5. Publish a platform event message to `Cloud_News__e`. You can use Apex code, process, Salesforce Flow, or Salesforce APIs. For example, you can send a POST request as follows: ```text { "Location__c" : "Mountain City", "Urgent__c" : true, "News_Content__c" : "Lake Road is closed due to mudslides." } ``` The console appears as follows: ```console INFO 2019-10-26 16:11:50,483 [[MuleRuntime].cpuLight.05: [test].SampleFlow.CPU_LITE @2b42bef0] [event: e00096e0-f7bf-11e9-b534-8c85907d741e] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: {data={schema=eGRz2Sfoy-YO9mVvH8J4fg, payload= {News_Content__c=Lake Road is closed due to mudslides., CreatedById=0050o00000U3Q8vAAF, CreatedDate=2019-10-26T07:12:01.026Z, Location__c=Mountain City, Urgent__c=true}, event={replayId=49544589}}, channel=/event/Cloud_News__e} ``` ## Working with Change Data Capture Events Subscribe to change data capture events, such as Salesforce object creations, updates, or deletions, by using Salesforce Connector. This example uses the **Replay Channel Listener** source, which enables you to replay events. 1. Log in to Salesforce. 2. Go to **Setup > Integrations > Change Data Capture** and select a Salesforce object, such as Account. 3. Go to Anypoint Studio and create a Mule app. 4. Drag the **Replay Channel Listener** source to the canvas and in the **Streaming Channel** field, specify `/data/AccountChangeEvent`. For a list of channel names, refer to [Subscription Channels](https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_subscribe_channels.htm). 5. Drag a **Logger** component to the canvas to show the payload so you can see the received message on the console, for example: ```xml ``` 6. Log in to Salesforce and update any Account record; for example, update the name of the account to `TestName2`. The console appears as follows: ```console INFO 2019-11-12 08:17:27,496 [[MuleRuntime].cpuLight.05: [sample].sampleFlow.CPU_LITE @14741f50] [event: xxx] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: {data={schema=CEjkFTwpfASSecY9UGNoOg, payload={LastModifiedDate=2019-11-11T23:17:30.000Z, ChangeEventHeader={commitNumber=10743571519745, commitUser=0050o00000XTesxAAD, sequenceNumber=1, entityName=Account, changeType=UPDATE, changedFields=[Ljava.lang.Object;@4f738b9d, changeOrigin=com/salesforce/api/soap/47.0;client=SfdcInternalAPI/, transactionKey=0002463d-1e88-1d80-5638-15c821f06b79, commitTimestamp=1573514251000, recordIds=[Ljava.lang.Object;@6e812151}, Name=TestName2}, event={replayId=1065378}}, channel=/data/AccountChangeEvent} ``` ## Working with PushTopic Events (Legacy) Work with PushTopic events by creating a PushTopic, subscribing to a PushTopic, and replaying PushTopic messages. > [!NOTE] PushTopic events is a legacy product. Salesforce no longer enhances PushTopic events with > new features and provides limited support for this product. Instead of PushTopic events, use > Change Data Capture events, as described in the > [Change Data Capture Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.change_data_capture.meta/change_data_capture/cdc_intro.htm) > and the > [Change Data Capture Basics](https://trailhead.salesforce.com/content/learn/modules/change-data-capture) > Trailhead module. ### Creating a PushTopic to Receive Data from Salesforce When you create a topic, the connector creates a `PushTopic`, which is a special object in Salesforce that binds a name (in this case, the topic’s name) and a Salesforce Object Query Language (SOQL) query together. After creating a PushTopic, you can subscribe to it by name. You can use either the **Create** (`create`) operation or **Publish topic** (`publish-topic`) operation to create a PushTopic. The following example uses the `publish-topic` operation to create a PushTopic: `` Alternatively, you can create a topic in Salesforce by executing code from an **Enter Apex Code** window, which is accessible through the system logs, for example: ```text PushTopic pushTopic = new PushTopic(); pushTopic.ApiVersion = 50.0; pushTopic.Name = 'AllAccounts'; pushTopic.Description = 'All records for the Account object'; pushTopic.Query = 'SELECT Id, Name FROM Account'; insert pushTopic; System.debug('Created new PushTopic: '+ pushTopic.Id); ``` ### Subscribing to a PushTopic To subscribe to a PushTopic, add the **Replay topic listener** (`replay-topic-listener`) as a source for your flow. The source acts as an inbound endpoint. Each time the subscription receives an event, the source executes the rest of the flow in your Mule app. In the following XML example, Mule prints a message to the log at the INFO level when the `AccountUpdates` PushTopic receives an event: ```xml ``` You can subscribe to a PushTopic that was not previously published in Salesforce. However, after the PushTopic is published, you won’t receive notifications for that PushTopic unless you resubscribe to it. ### Replaying Messages from a PushTopic A subscriber can specify which events to receive. By default, a subscriber receives only the events that occur after subscribing. Events outside of the retention period are discarded. The **Replay topic listener** source provides these options: - `ALL` Subscriber receives all events, including past events that are within the retention period and new events that are sent after the client subscribes. - `ONLY_NEW` Subscriber receives new events that are sent after the client subscribes. - `FROM_REPLAY_ID` Subscriber receives all events after the specified event `replayId`. - `FROM_LAST_REPLAY_ID` Subscriber uses the highest replay ID stored in the object store regardless of whether it’s processed successfully or not. If you deploy the Mule app to CloudHub, then use the Object Store V2 option to retain the last processed `ReplayId`. If you specify either the `ALL` replay option or `ONLY_NEW` replay option, the `replayId` value is ignored. The **Resume from the Last Replay Id** checkbox enables you to specify an automatic replay of stored events based on the Replay ID of the last event processed by the connector. You can use this functionality when the connector stops listening, such as a during a server shutdown or dropped connection. If the stored Replay ID is outside the retention period, the replay option determines which events to replay. To support the resume from last replay ID functionality, the connector uses a persistent object store to keep different details regarding the processed messages. This feature reduces the possibility of message loss and avoids processing duplicate messages. For more information about how the object store is used, see [Object Store Usage in Events](#objectstoreusage). In the following XML example, the **Replay topic listener** operation (`replay-topic-listener`) acts like an inbound endpoint for the **Logger** component message: ```xml ``` ## Working with Generic Events (Legacy) Work with generic events by creating a streaming channel, subscribing to a streaming channel, replaying generic events, and pushing events to a streaming channel. > [!NOTE] Generic Events is a legacy product. Salesforce no longer enhances Generic Events with new > features and provides limited support for this product. Instead of Generic Events, you can use > Platform Events, as described in the > [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.platform_events.meta/platform_events/platform_events_intro.htm) > and the > [Platform Events Basics](https://trailhead.salesforce.com/content/learn/modules/platform_events_basics) > Trailhead module. ### Creating a Streaming Channel To create a streaming channel, you must have the proper Salesforce Streaming API permissions enabled in your organization. Follow these steps to create a streaming channel: 1. Log in to your Salesforce Developer Edition organization. 2. Under **All Tabs (+)**, select **Streaming Channels**. 3. On the **Streaming Channels** tab, select **New**. 4. Enter `/u/notifications/ExampleUserChannel` in the **Streaming Channel Name** field. 5. Enter an optional description. You can also create a streaming channel by using either the connector **Create** operation or the connector **Publish streaming channel** (`publish-streaming-channel`) operation. The following example uses the `publish-streaming-channel` operation: ```xml ``` ### Subscribing to a Streaming Channel After you create a streaming channel, you can start receiving events by subscribing to the channel. The **Replay channel listener** (`replay-channel-listener`) source acts like an inbound endpoint. In this example, every time a subscription to `/u/TestStreaming` receives an event, it executes the rest of the flow and logs a message at the INFO level: ```xml ``` ### Replaying Messages from a Streaming Channel A streaming channel can replay notifications. The **Replay channel listener** (`replay-channel-listener`) source acts as an inbound endpoint, for example: ```xml ``` If you specify either the `ALL` replay option or the `ONLY_NEW` replay option, the `replayId` value is ignored. The **Resume from the Last Replay Id** checkbox enables you to specify an automatic replay of stored events based on the Replay ID of the last event processed by the connector. You can use this functionality when the connector stops listening, such as a during a server shutdown or dropped connection. If the stored Replay ID is outside the retention period, the replay option determines which events to replay. To support the resume from the last replay ID feature, the connector uses a persistent object store to keep details regarding the processed messages. This feature reduces the possibility of message loss and avoids processing duplicate messages. For more information about how the object store is used, see [Object Store Usage in Events](#objectstoreusage). ### Pushing Events to a Streaming Channel with No Listener Users can push events to a streaming channel, even if the channel does not have a listener for reading published events. After a listener is started for the channel, Salesforce Streaming API pushes as many messages as it can to the listener, based on the maximum daily limit. For example, the maximum number of delivered event notifications within a 24-hour period for a free Salesforce organization is 10,000. Suppose you publish 15,000 events to that channel. When Salesforce Connector subscribes to that channel, Streaming API attempts to push 10,000 events, thus consuming the daily quota. The API then attempts to push the remaining 5,000 events the next day, before pushing any new events. In this scenario, the connector streams the events one-by-one into the Mule app. If the app takes too long to process a message, Streaming API might instruct the connector to reconnect. If this happens, Streaming API drops all of the unprocessed messages. You can avoid this situation by implementing a reliability pattern, as described in [Reliability Patterns](https://docs.mulesoft.com/mule-runtime/latest/reliability-patterns). ### Obtaining Generic Event Notifications Salesforce Connector enables you to obtain custom event notifications, which apply to general events that are not tied to Salesforce data changes. To obtain generic event notifications: 1. Use the **Publish streaming channel** operation to create a streaming channel. `StreamingChannel` is a special Salesforce object that represents a channel used to notify listeners of generic Streaming API events. You can also create a streaming channel through Salesforce. 2. Use the **Replay channel listener** operation to subscribe to the channel. Salesforce Connector converts the custom events in your streaming channel to Mule events. ### Pushing Generic Events to a Streaming Channel Salesforce enables you to push custom events to a specific streaming channel through the REST API. To do this, use this connector. The following example uses the connector’s **Push generic event** (`push-generic-event`) operation to push custom events to the channel with the ID `0M6j0000000KyjBCAS`: ```xml ``` You can retrieve the channel ID from the response map of the **Publish streaming channel** operation. Alternatively, you can retrieve the channel ID from the Salesforce page: 1. Log in to your Salesforce Developer Edition organization. 2. Under **All Tabs (+)**, select **Streaming Channels**. If the channel ID field is not visible on the channel list, follow these steps: 1. Click **Create New View**. 2. Type a name for the view in the **Name** input field. 3. In the **Available Fields** list, select **Streaming Channel ID** and click **Add**. You should see the channel ID for each streaming channel in the list. 4. Add any other fields. 5. Click **Save**. The JSON received as a response from the push event operation looks something like this: ```json [ { "userOnlineStatus": {}, "fanoutCount": 0 } ] ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-config-topics) - [Examples](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-examples) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.3 --- # Processing Events with Salesforce Connector 11.3 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use Anypoint Connector for Salesforce (Salesforce Connector) as an inbound connector to stream data from Salesforce into your application. To use the connector this way, you can use these sources for any type of events (platform events, change data capture events, and the legacy PushTopic and generic events): - **Replay topic listener** - **Replay channel listener** > [!NOTE] If you’re adding a new connector for platform events and change data capture events, you > can use [Salesforce Pub/Sub Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/), which is based > on the Pub/Sub API. When deploying apps in a distributed environment such as a runtime cluster, the source must run on the primary node. Running the source on multiple nodes causes duplicate event consumption and object store data corruption for the data stored by Salesforce Connector. When deploying apps in non-cluster mode with multiple workers, then the source runs on all the nodes which consumes duplicate events. Each event that travels through your flow contains information about the Salesforce data that changed, including how the data changed and when the change occurred. Salesforce stores events for 72 hours (or 24 hours for legacy PushTopic and generic events). A subscriber to a topic or channel can retrieve events related to that topic or channel during this retention window, after which the subscriber can retrieve only newer events that haven’t yet expired. Salesforce assigns a replay ID to each broadcast event, which you can use to replay stored event messages. For more information, refer to [Message Durability](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/using_streaming_api_durability.htm) in the Streaming API Developer Guide. > [!NOTE] Migrating a Salesforce instance to Hyperforce can result in an invalid replay ID error. > This occurs if the Mule app tries to access a replay ID from an object store that is no longer > valid on the new Hyperforce instance. To avoid this error, see this > [knowledge article](https://help.salesforce.com/s/articleView?id=001117442&type=1). ## Before You Begin To process events with Salesforce Connector, ensure that you have: - Access to the Salesforce target resource - The required Salesforce Streaming API permissions enabled in your organization To receive events for Salesforce changes associated with a topic, either create a new topic or use an existing one. ## Object Store Usage in Events Both Salesforce Connector and Mule runtime engine (Mule) use an object store to persist data for features such as automatic message replay and message redelivery: - The object store included in Mule for on-premises deployments of Mule apps has no transaction limits. - The free version of Object Store for CloudHub and CloudHub 2.0 deployments of Mule apps has a limit of 10 transactions per second (TPS), however other Anypoint Connectors using the object store internally have a limit of 100 TPS. For more information about Object Store versions, see [Object Store Notes](https://docs.mulesoft.com/object-store/#object-store-notes). ### Replay Topic Listener and Replay Channel Listener Sources The **Replay topic listener** and **Replay channel listener** sources can continue from the last replay ID they received before restarting the application. When a Mule app starts for the first time, the connector creates an object store that saves data: - If there are no failed events, the source starts from the event associated with the last successfully processed event ID. - If there are one or more failed events, the source starts with the event associated with the lowest replay ID that failed. Saving this change data capture in an object store ensures that no message is processed twice and that when the application restarts, it can reprocess any failed messages. The IDs are stored in the object store for 72 hours, after which they are automatically removed. The connector contains an in-memory structure that stores the replay IDs of events, including events that process successfully or events that fail to process. This in-memory structure uses the username in the connector configuration to persist into the object store to build a specific key. A redundancy mechanism avoids processing duplicate events by storing the same data under a backup key. Each persist operation consists of deleting the existing key and storing the new value, and if storing the new value fails, the connector retries, thus consuming 2 or more TPS per key. If you have multiple workers deployed in CloudHub, the **Replay topic listener** and **Replay channel listener** sources process each message on all Mule instances. To avoid this situation, you can deploy your application on a single worker and then use a shared queue to pass the messages to a different worker to process the message. ### Resume from the Last Replay ID To enable the resume from the last replay ID functionality for the **Replay topic listener** and **Replay channel listener** sources, the connector must store information about the events that were successfully processed by the flow in which the source is used. The connector uses an object store to store that information. The way that the object store stores the necessary data for the resume from the last replay ID functionality varies depending on the environment: - When a Mule app runs locally, the connector creates a persistent store in the file system. If the application stops and restarts, or if a connection issue triggers a reconnection, the data saved in the object store enables the connector to continue processing messages at the point where it stopped. - When a Mule app runs in a cluster with the nodes either on the same machine or on different machines, Mule uses a distributed in-memory object store: - If the primary node (the one consuming the messages) shuts down, the node that takes over for the primary node does not reprocess the same messages. Instead, the node continues from where the previous node stopped processing the messages. - If the cluster stops, the data from the object store is lost. When the cluster restarts, the configuration at the source level determines whether the connector reprocesses the messages. To persist data so that the app continues processing events when restarted, create a persistent object store, as described in [Create and Manage a Cluster Manually](https://docs.mulesoft.com/on-premises/latest/creating-and-managing-a-cluster-manually). - If you use multiple workers when running the app in CloudHub, all of the workers receive and process the events. ### Replay Sources Field Configurations Learn how to handle the priority in the replay sources field setup by using different configurations: - **Replay failed events if any or resume from last replay id** If enabled, this field overwrites anything selected in the **Replay option** field and anything entered in the **Replay id** field. The **Replay failed events if any or resume from last replay id** field checks the Object Store for failed event IDs or last known successfully processed event IDs. If there are failed events, processing starts with the lowest failed event, thus receiving all events from `lowestFailedEventId` until now. For example, if `FailedEventIdInObjectStore` is `10` and `LastSuccessfullyProcessedEventIdInObjectStore` is `15`, processing starts with 10 and the streaming client receives events 10 through 15 and consumes the quota. However, these events are not reprocessed by the flow and are filtered by the connector. If there are no failed event IDs stored, then processing starts with the highest known replay ID. If there is nothing saved in the Object Store, then the **Replay option** field is used. - **ReplayOption.ALL** Subscribes with `-2`. The user receives all events available in Salesforce. - **ReplayOption.ONLY\_NEW** Subscribes with `-1`. The user receives the events created after the connector subscribes. - **ReplayOption.FROM\_REPLAY\_ID** Subscribes with what the user enters in the **Replay id** field. - **ReplayOption.FROM\_LAST\_REPLAY\_ID** Checks the Object Store for the highest received event ID. It doesn’t matter whether the event is processed successfully. This option avoids quota consumption compared to the **Replay failed events if any or resume from last replay id** field, which starts the source with a failed event ID that is lower than the highest processed event ID. If you deploy the Mule app to CloudHub, then use the Object Store V2 option to retain the last processed `ReplayId`. - **Cache events in memory** If enabled, when the application starts, the connector subscribes from a replay ID. The Salesforce API pushes all events that start with the replay ID that is used to subscribe, thus consuming quota. If there are many available events and the Mule app processes them slowly, it can take a while to process all of them. With this option enabled, the events pushed by the API are stored in memory and are consumed sequentially in the order they are received. If there is a connection issue or the token expires and the connector must resubscribe, the events would be lost without this configuration and the quota would be consumed. > [!NOTE] The connector interacts with Object Store to store and retrieve data only when the > **Replay Option** field is set to `FROM_LAST_REPLAY_ID` or when the **Replay failed events if any > or resume from last replay id** checkbox is selected. > > In CloudHub and CloudHub 2.0, when the **Replay Option** field is set to `FROM_LAST_REPLAY_ID` or > when the **Replay failed events if any or resume from last replay id** checkbox is selected, the > last known replay ID might not be found in Object Store, which causes all events to replay when > the application restarts or redeploys. This is because Object Store v2 does not have a distributed > locking mechanism. For more information, refer to > [Last known replayId not found in ObjectStore](https://help.salesforce.com/s/articleView?id=001117329&type=1). ## Multiple Flows That Use the Same Source If you have two or more flows that use a source that listens to events on the same channel or topic, the events are consumed two or more times from your user quota. To avoid this, consider implementing that logic in a single flow instead. > [!WARNING] Having multiple sources listening to the same events and having the **Resume from the > Last Replay Id** option enabled can lead to data corruption and the potential loss of events. ## Multiple Flows with Different Sources Having two or more flows that use different sources with the **Replay Failed Events If Any or Resume from Last Replay Id** option enabled, under certain conditions, might have performance implications. To avoid performance implications, use different Salesforce Connector configurations with different Salesforce usernames. > [!WARNING] Changing the username for a configuration prevents the connector from loading the last > processed and failed replay IDs. Processing resumes from the first event available in Salesforce. > [!WARNING] Avoid using personal user accounts to access Salesforce. ## Working with Platform Events Subscribe to platform events by using Salesforce Connector. The following example is based on the platform events in the [Define and Publish Platform Events](https://trailhead.salesforce.com/content/learn/modules/platform_events_basics/platform_events_define_publish) Trailhead. To receive platform events from Salesforce by using Salesforce Connector: 1. Log in to Salesforce and create a Salesforce platform event, such as `Cloud_News__e`. 2. Go to Anypoint Studio and create a Mule app. 3. Drag the **Replay Channel Listener** source to the canvas and in the **Streaming Channel** field, specify `/event/Cloud_News__e`. 4. Drag a **Logger** component to the canvas to show the payload so you can see the received message on the console, for example: ```xml ``` 5. Publish a platform event message to `Cloud_News__e`. You can use Apex code, process, Salesforce Flow, or Salesforce APIs. For example, you can send a POST request as follows: ```text { "Location__c" : "Mountain City", "Urgent__c" : true, "News_Content__c" : "Lake Road is closed due to mudslides." } ``` The console appears as follows: ```console INFO 2019-10-26 16:11:50,483 [[MuleRuntime].cpuLight.05: [test].SampleFlow.CPU_LITE @2b42bef0] [event: e00096e0-f7bf-11e9-b534-8c85907d741e] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: {data={schema=eGRz2Sfoy-YO9mVvH8J4fg, payload= {News_Content__c=Lake Road is closed due to mudslides., CreatedById=0050o00000U3Q8vAAF, CreatedDate=2019-10-26T07:12:01.026Z, Location__c=Mountain City, Urgent__c=true}, event={replayId=49544589}}, channel=/event/Cloud_News__e} ``` ## Working with Change Data Capture Events Subscribe to change data capture events, such as Salesforce object creations, updates, or deletions, by using Salesforce Connector. This example uses the **Replay Channel Listener** source, which enables you to replay events. 1. Log in to Salesforce. 2. Go to **Setup > Integrations > Change Data Capture** and select a Salesforce object, such as Account. 3. Go to Anypoint Studio and create a Mule app. 4. Drag the **Replay Channel Listener** source to the canvas and in the **Streaming Channel** field, specify `/data/AccountChangeEvent`. For a list of channel names, refer to [Subscription Channels](https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_subscribe_channels.htm). 5. Drag a **Logger** component to the canvas to show the payload so you can see the received message on the console, for example: ```xml ``` 6. Log in to Salesforce and update any Account record; for example, update the name of the account to `TestName2`. The console appears as follows: ```console INFO 2019-11-12 08:17:27,496 [[MuleRuntime].cpuLight.05: [sample].sampleFlow.CPU_LITE @14741f50] [event: xxx] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: {data={schema=CEjkFTwpfASSecY9UGNoOg, payload={LastModifiedDate=2019-11-11T23:17:30.000Z, ChangeEventHeader={commitNumber=10743571519745, commitUser=0050o00000XTesxAAD, sequenceNumber=1, entityName=Account, changeType=UPDATE, changedFields=[Ljava.lang.Object;@4f738b9d, changeOrigin=com/salesforce/api/soap/47.0;client=SfdcInternalAPI/, transactionKey=0002463d-1e88-1d80-5638-15c821f06b79, commitTimestamp=1573514251000, recordIds=[Ljava.lang.Object;@6e812151}, Name=TestName2}, event={replayId=1065378}}, channel=/data/AccountChangeEvent} ``` ## Working with PushTopic Events (Legacy) Work with PushTopic events by creating a PushTopic, subscribing to a PushTopic, and replaying PushTopic messages. > [!NOTE] PushTopic events is a legacy product. Salesforce no longer enhances PushTopic events with > new features and provides limited support for this product. Instead of PushTopic events, use > Change Data Capture events, as described in the > [Change Data Capture Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.change_data_capture.meta/change_data_capture/cdc_intro.htm) > and the > [Change Data Capture Basics](https://trailhead.salesforce.com/content/learn/modules/change-data-capture) > Trailhead module. ### Creating a PushTopic to Receive Data from Salesforce When you create a topic, the connector creates a `PushTopic`, which is a special object in Salesforce that binds a name (in this case, the topic’s name) and a Salesforce Object Query Language (SOQL) query together. After creating a PushTopic, you can subscribe to it by name. You can use either the **Create** (`create`) operation or **Publish topic** (`publish-topic`) operation to create a PushTopic. The following example uses the `publish-topic` operation to create a PushTopic: `` Alternatively, you can create a topic in Salesforce by executing code from an **Enter Apex Code** window, which is accessible through the system logs, for example: ```text PushTopic pushTopic = new PushTopic(); pushTopic.ApiVersion = 50.0; pushTopic.Name = 'AllAccounts'; pushTopic.Description = 'All records for the Account object'; pushTopic.Query = 'SELECT Id, Name FROM Account'; insert pushTopic; System.debug('Created new PushTopic: '+ pushTopic.Id); ``` ### Subscribing to a PushTopic To subscribe to a PushTopic, add the **Replay topic listener** (`replay-topic-listener`) as a source for your flow. The source acts as an inbound endpoint. Each time the subscription receives an event, the source executes the rest of the flow in your Mule app. In the following XML example, Mule prints a message to the log at the INFO level when the `AccountUpdates` PushTopic receives an event: ```xml ``` You can subscribe to a PushTopic that was not previously published in Salesforce. However, after the PushTopic is published, you won’t receive notifications for that PushTopic unless you resubscribe to it. ### Replaying Messages from a PushTopic A subscriber can specify which events to receive. By default, a subscriber receives only the events that occur after subscribing. Events outside of the retention period are discarded. The **Replay topic listener** source provides these options: - `ALL` Subscriber receives all events, including past events that are within the retention period and new events that are sent after the client subscribes. - `ONLY_NEW` Subscriber receives new events that are sent after the client subscribes. - `FROM_REPLAY_ID` Subscriber receives all events after the specified event `replayId`. - `FROM_LAST_REPLAY_ID` Subscriber uses the highest replay ID stored in the object store regardless of whether it’s processed successfully or not. If you deploy the Mule app to CloudHub, then use the Object Store V2 option to retain the last processed `ReplayId`. If you specify either the `ALL` replay option or `ONLY_NEW` replay option, the `replayId` value is ignored. The **Resume from the Last Replay Id** checkbox enables you to specify an automatic replay of stored events based on the Replay ID of the last event processed by the connector. You can use this functionality when the connector stops listening, such as a during a server shutdown or dropped connection. If the stored Replay ID is outside the retention period, the replay option determines which events to replay. To support the resume from last replay ID functionality, the connector uses a persistent object store to keep different details regarding the processed messages. This feature reduces the possibility of message loss and avoids processing duplicate messages. For more information about how the object store is used, see [Object Store Usage in Events](#objectstoreusage). In the following XML example, the **Replay topic listener** operation (`replay-topic-listener`) acts like an inbound endpoint for the **Logger** component message: ```xml ``` ## Working with Generic Events (Legacy) Work with generic events by creating a streaming channel, subscribing to a streaming channel, replaying generic events, and pushing events to a streaming channel. > [!NOTE] Generic Events is a legacy product. Salesforce no longer enhances Generic Events with new > features and provides limited support for this product. Instead of Generic Events, you can use > Platform Events, as described in the > [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.platform_events.meta/platform_events/platform_events_intro.htm) > and the > [Platform Events Basics](https://trailhead.salesforce.com/content/learn/modules/platform_events_basics) > Trailhead module. ### Creating a Streaming Channel To create a streaming channel, you must have the proper Salesforce Streaming API permissions enabled in your organization. Follow these steps to create a streaming channel: 1. Log in to your Salesforce Developer Edition organization. 2. Under **All Tabs (+)**, select **Streaming Channels**. 3. On the **Streaming Channels** tab, select **New**. 4. Enter `/u/notifications/ExampleUserChannel` in the **Streaming Channel Name** field. 5. Enter an optional description. You can also create a streaming channel by using either the connector **Create** operation or the connector **Publish streaming channel** (`publish-streaming-channel`) operation. The following example uses the `publish-streaming-channel` operation: ```xml ``` ### Subscribing to a Streaming Channel After you create a streaming channel, you can start receiving events by subscribing to the channel. The **Replay channel listener** (`replay-channel-listener`) source acts like an inbound endpoint. In this example, every time a subscription to `/u/TestStreaming` receives an event, it executes the rest of the flow and logs a message at the INFO level: ```xml ``` ### Replaying Messages from a Streaming Channel A streaming channel can replay notifications. The **Replay channel listener** (`replay-channel-listener`) source acts as an inbound endpoint, for example: ```xml ``` If you specify either the `ALL` replay option or the `ONLY_NEW` replay option, the `replayId` value is ignored. The **Resume from the Last Replay Id** checkbox enables you to specify an automatic replay of stored events based on the Replay ID of the last event processed by the connector. You can use this functionality when the connector stops listening, such as a during a server shutdown or dropped connection. If the stored Replay ID is outside the retention period, the replay option determines which events to replay. To support the resume from the last replay ID feature, the connector uses a persistent object store to keep details regarding the processed messages. This feature reduces the possibility of message loss and avoids processing duplicate messages. For more information about how the object store is used, see [Object Store Usage in Events](#objectstoreusage). ### Pushing Events to a Streaming Channel with No Listener Users can push events to a streaming channel, even if the channel does not have a listener for reading published events. After a listener is started for the channel, Salesforce Streaming API pushes as many messages as it can to the listener, based on the maximum daily limit. For example, the maximum number of delivered event notifications within a 24-hour period for a free Salesforce organization is 10,000. Suppose you publish 15,000 events to that channel. When Salesforce Connector subscribes to that channel, Streaming API attempts to push 10,000 events, thus consuming the daily quota. The API then attempts to push the remaining 5,000 events the next day, before pushing any new events. In this scenario, the connector streams the events one-by-one into the Mule app. If the app takes too long to process a message, Streaming API might instruct the connector to reconnect. If this happens, Streaming API drops all of the unprocessed messages. You can avoid this situation by implementing a reliability pattern, as described in [Reliability Patterns](https://docs.mulesoft.com/mule-runtime/latest/reliability-patterns). ### Obtaining Generic Event Notifications Salesforce Connector enables you to obtain custom event notifications, which apply to general events that are not tied to Salesforce data changes. To obtain generic event notifications: 1. Use the **Publish streaming channel** operation to create a streaming channel. `StreamingChannel` is a special Salesforce object that represents a channel used to notify listeners of generic Streaming API events. You can also create a streaming channel through Salesforce. 2. Use the **Replay channel listener** operation to subscribe to the channel. Salesforce Connector converts the custom events in your streaming channel to Mule events. ### Pushing Generic Events to a Streaming Channel Salesforce enables you to push custom events to a specific streaming channel through the REST API. To do this, use this connector. The following example uses the connector’s **Push generic event** (`push-generic-event`) operation to push custom events to the channel with the ID `0M6j0000000KyjBCAS`: ```xml ``` You can retrieve the channel ID from the response map of the **Publish streaming channel** operation. Alternatively, you can retrieve the channel ID from the Salesforce page: 1. Log in to your Salesforce Developer Edition organization. 2. Under **All Tabs (+)**, select **Streaming Channels**. If the channel ID field is not visible on the channel list, follow these steps: 1. Click **Create New View**. 2. Type a name for the view in the **Name** input field. 3. In the **Available Fields** list, select **Streaming Channel ID** and click **Add**. You should see the channel ID for each streaming channel in the list. 4. Add any other fields. 5. Click **Save**. The JSON received as a response from the push event operation looks something like this: ```json [ { "userOnlineStatus": {}, "fanoutCount": 0 } ] ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-config-topics) - [Examples](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-examples) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.4 --- # Processing Events with Salesforce Connector 11.4 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use Anypoint Connector for Salesforce (Salesforce Connector) as an inbound connector to stream data from Salesforce into your application. To use the connector this way, you can use these sources for any type of events (platform events, change data capture events, and the legacy PushTopic and generic events): - **Replay topic listener** - **Replay channel listener** > [!NOTE] If you’re adding a new connector for platform events and change data capture events, you > can use [Salesforce Pub/Sub Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/), which is based > on the Pub/Sub API. When deploying apps in a distributed environment such as a runtime cluster, the source must run on the primary node. Running the source on multiple nodes causes duplicate event consumption and object store data corruption for the data stored by Salesforce Connector. When deploying apps in non-cluster mode with multiple workers, then the source runs on all the nodes which consumes duplicate events. Each event that travels through your flow contains information about the Salesforce data that changed, including how the data changed and when the change occurred. Salesforce stores events for 72 hours (or 24 hours for legacy PushTopic and generic events). A subscriber to a topic or channel can retrieve events related to that topic or channel during this retention window, after which the subscriber can retrieve only newer events that haven’t yet expired. Salesforce assigns a replay ID to each broadcast event, which you can use to replay stored event messages. For more information, refer to [Message Durability](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/using_streaming_api_durability.htm) in the Streaming API Developer Guide. > [!NOTE] Migrating a Salesforce instance to Hyperforce can result in an invalid replay ID error. > This occurs if the Mule app tries to access a replay ID from an object store that is no longer > valid on the new Hyperforce instance. To avoid this error, see this > [knowledge article](https://help.salesforce.com/s/articleView?id=001117442&type=1). ## Before You Begin To process events with Salesforce Connector, ensure that you have: - Access to the Salesforce target resource - The required Salesforce Streaming API permissions enabled in your organization To receive events for Salesforce changes associated with a topic, either create a new topic or use an existing one. ## Object Store Usage in Events Both Salesforce Connector and Mule runtime engine (Mule) use an object store to persist data for features such as automatic message replay and message redelivery: - The object store included in Mule for on-premises deployments of Mule apps has no transaction limits. - The free version of Object Store for CloudHub and CloudHub 2.0 deployments of Mule apps has a limit of 10 transactions per second (TPS), however other Anypoint Connectors using the object store internally have a limit of 100 TPS. For more information about Object Store versions, see [Object Store Notes](https://docs.mulesoft.com/object-store/#object-store-notes). ### Replay Topic Listener and Replay Channel Listener Sources The **Replay topic listener** and **Replay channel listener** sources can continue from the last replay ID they received before restarting the application. When a Mule app starts for the first time, the connector creates an object store that saves data: - If there are no failed events, the source starts from the event associated with the last successfully processed event ID. - If there are one or more failed events, the source starts with the event associated with the lowest replay ID that failed. Saving this change data capture in an object store ensures that no message is processed twice and that when the application restarts, it can reprocess any failed messages. The IDs are stored in the object store for 72 hours, after which they are automatically removed. The connector contains an in-memory structure that stores the replay IDs of events, including events that process successfully or events that fail to process. This in-memory structure uses the username in the connector configuration to persist into the object store to build a specific key. A redundancy mechanism avoids processing duplicate events by storing the same data under a backup key. Each persist operation consists of deleting the existing key and storing the new value, and if storing the new value fails, the connector retries, thus consuming 2 or more TPS per key. If you have multiple workers deployed in CloudHub, the **Replay topic listener** and **Replay channel listener** sources process each message on all Mule instances. To avoid this situation, you can deploy your application on a single worker and then use a shared queue to pass the messages to a different worker to process the message. ### Resume from the Last Replay ID To enable the resume from the last replay ID functionality for the **Replay topic listener** and **Replay channel listener** sources, the connector must store information about the events that were successfully processed by the flow in which the source is used. The connector uses an object store to store that information. The way that the object store stores the necessary data for the resume from the last replay ID functionality varies depending on the environment: - When a Mule app runs locally, the connector creates a persistent store in the file system. If the application stops and restarts, or if a connection issue triggers a reconnection, the data saved in the object store enables the connector to continue processing messages at the point where it stopped. - When a Mule app runs in a cluster with the nodes either on the same machine or on different machines, Mule uses a distributed in-memory object store: - If the primary node (the one consuming the messages) shuts down, the node that takes over for the primary node does not reprocess the same messages. Instead, the node continues from where the previous node stopped processing the messages. - If the cluster stops, the data from the object store is lost. When the cluster restarts, the configuration at the source level determines whether the connector reprocesses the messages. To persist data so that the app continues processing events when restarted, create a persistent object store, as described in [Create and Manage a Cluster Manually](https://docs.mulesoft.com/on-premises/latest/creating-and-managing-a-cluster-manually). - If you use multiple workers when running the app in CloudHub, all of the workers receive and process the events. ### Replay Sources Field Configurations Learn how to handle the priority in the replay sources field setup by using different configurations: - **Replay failed events if any or resume from last replay id** If enabled, this field overwrites anything selected in the **Replay option** field and anything entered in the **Replay id** field. The **Replay failed events if any or resume from last replay id** field checks the Object Store for failed event IDs or last known successfully processed event IDs. If there are failed events, processing starts with the lowest failed event, thus receiving all events from `lowestFailedEventId` until now. For example, if `FailedEventIdInObjectStore` is `10` and `LastSuccessfullyProcessedEventIdInObjectStore` is `15`, processing starts with 10 and the streaming client receives events 10 through 15 and consumes the quota. However, these events are not reprocessed by the flow and are filtered by the connector. If there are no failed event IDs stored, then processing starts with the highest known replay ID. If there is nothing saved in the Object Store, then the **Replay option** field is used. - **ReplayOption.ALL** Subscribes with `-2`. The user receives all events available in Salesforce. - **ReplayOption.ONLY\_NEW** Subscribes with `-1`. The user receives the events created after the connector subscribes. - **ReplayOption.FROM\_REPLAY\_ID** Subscribes with what the user enters in the **Replay id** field. - **ReplayOption.FROM\_LAST\_REPLAY\_ID** Checks the Object Store for the highest received event ID. It doesn’t matter whether the event is processed successfully. This option avoids quota consumption compared to the **Replay failed events if any or resume from last replay id** field, which starts the source with a failed event ID that is lower than the highest processed event ID. If you deploy the Mule app to CloudHub, then use the Object Store V2 option to retain the last processed `ReplayId`. - **Cache events in memory** If enabled, when the application starts, the connector subscribes from a replay ID. The Salesforce API pushes all events that start with the replay ID that is used to subscribe, thus consuming quota. If there are many available events and the Mule app processes them slowly, it can take a while to process all of them. With this option enabled, the events pushed by the API are stored in memory and are consumed sequentially in the order they are received. If there is a connection issue or the token expires and the connector must resubscribe, the events would be lost without this configuration and the quota would be consumed. > [!NOTE] The connector interacts with Object Store to store and retrieve data only when the > **Replay Option** field is set to `FROM_LAST_REPLAY_ID` or when the **Replay failed events if any > or resume from last replay id** checkbox is selected. > > In CloudHub and CloudHub 2.0, when the **Replay Option** field is set to `FROM_LAST_REPLAY_ID` or > when the **Replay failed events if any or resume from last replay id** checkbox is selected, the > last known replay ID might not be found in Object Store, which causes all events to replay when > the application restarts or redeploys. This is because Object Store v2 does not have a distributed > locking mechanism. For more information, refer to > [Last known replayId not found in ObjectStore](https://help.salesforce.com/s/articleView?id=001117329&type=1). ## Multiple Flows That Use the Same Source If you have two or more flows that use a source that listens to events on the same channel or topic, the events are consumed two or more times from your user quota. To avoid this, consider implementing that logic in a single flow instead. > [!WARNING] Having multiple sources listening to the same events and having the **Resume from the > Last Replay Id** option enabled can lead to data corruption and the potential loss of events. ## Multiple Flows with Different Sources Having two or more flows that use different sources with the **Replay Failed Events If Any or Resume from Last Replay Id** option enabled, under certain conditions, might have performance implications. To avoid performance implications, use different Salesforce Connector configurations with different Salesforce usernames. > [!WARNING] Changing the username for a configuration prevents the connector from loading the last > processed and failed replay IDs. Processing resumes from the first event available in Salesforce. > [!WARNING] Avoid using personal user accounts to access Salesforce. ## Working with Platform Events Subscribe to platform events by using Salesforce Connector. The following example is based on the platform events in the [Define and Publish Platform Events](https://trailhead.salesforce.com/content/learn/modules/platform_events_basics/platform_events_define_publish) Trailhead. To receive platform events from Salesforce by using Salesforce Connector: 1. Log in to Salesforce and create a Salesforce platform event, such as `Cloud_News__e`. 2. Go to Anypoint Studio and create a Mule app. 3. Drag the **Replay Channel Listener** source to the canvas and in the **Streaming Channel** field, specify `/event/Cloud_News__e`. 4. Drag a **Logger** component to the canvas to show the payload so you can see the received message on the console, for example: ```xml ``` 5. Publish a platform event message to `Cloud_News__e`. You can use Apex code, process, Salesforce Flow, or Salesforce APIs. For example, you can send a POST request as follows: ```text { "Location__c" : "Mountain City", "Urgent__c" : true, "News_Content__c" : "Lake Road is closed due to mudslides." } ``` The console appears as follows: ```console INFO 2019-10-26 16:11:50,483 [[MuleRuntime].cpuLight.05: [test].SampleFlow.CPU_LITE @2b42bef0] [event: e00096e0-f7bf-11e9-b534-8c85907d741e] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: {data={schema=eGRz2Sfoy-YO9mVvH8J4fg, payload= {News_Content__c=Lake Road is closed due to mudslides., CreatedById=0050o00000U3Q8vAAF, CreatedDate=2019-10-26T07:12:01.026Z, Location__c=Mountain City, Urgent__c=true}, event={replayId=49544589}}, channel=/event/Cloud_News__e} ``` ## Working with Change Data Capture Events Subscribe to change data capture events, such as Salesforce object creations, updates, or deletions, by using Salesforce Connector. This example uses the **Replay Channel Listener** source, which enables you to replay events. 1. Log in to Salesforce. 2. Go to **Setup > Integrations > Change Data Capture** and select a Salesforce object, such as Account. 3. Go to Anypoint Studio and create a Mule app. 4. Drag the **Replay Channel Listener** source to the canvas and in the **Streaming Channel** field, specify `/data/AccountChangeEvent`. For a list of channel names, refer to [Subscription Channels](https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_subscribe_channels.htm). 5. Drag a **Logger** component to the canvas to show the payload so you can see the received message on the console, for example: ```xml ``` 6. Log in to Salesforce and update any Account record; for example, update the name of the account to `TestName2`. The console appears as follows: ```console INFO 2019-11-12 08:17:27,496 [[MuleRuntime].cpuLight.05: [sample].sampleFlow.CPU_LITE @14741f50] [event: xxx] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: {data={schema=CEjkFTwpfASSecY9UGNoOg, payload={LastModifiedDate=2019-11-11T23:17:30.000Z, ChangeEventHeader={commitNumber=10743571519745, commitUser=0050o00000XTesxAAD, sequenceNumber=1, entityName=Account, changeType=UPDATE, changedFields=[Ljava.lang.Object;@4f738b9d, changeOrigin=com/salesforce/api/soap/47.0;client=SfdcInternalAPI/, transactionKey=0002463d-1e88-1d80-5638-15c821f06b79, commitTimestamp=1573514251000, recordIds=[Ljava.lang.Object;@6e812151}, Name=TestName2}, event={replayId=1065378}}, channel=/data/AccountChangeEvent} ``` ## Working with PushTopic Events (Legacy) Work with PushTopic events by creating a PushTopic, subscribing to a PushTopic, and replaying PushTopic messages. > [!NOTE] PushTopic events is a legacy product. Salesforce no longer enhances PushTopic events with > new features and provides limited support for this product. Instead of PushTopic events, use > Change Data Capture events, as described in the > [Change Data Capture Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.change_data_capture.meta/change_data_capture/cdc_intro.htm) > and the > [Change Data Capture Basics](https://trailhead.salesforce.com/content/learn/modules/change-data-capture) > Trailhead module. ### Creating a PushTopic to Receive Data from Salesforce When you create a topic, the connector creates a `PushTopic`, which is a special object in Salesforce that binds a name (in this case, the topic’s name) and a Salesforce Object Query Language (SOQL) query together. After creating a PushTopic, you can subscribe to it by name. You can use either the **Create** (`create`) operation or **Publish topic** (`publish-topic`) operation to create a PushTopic. The following example uses the `publish-topic` operation to create a PushTopic: `` Alternatively, you can create a topic in Salesforce by executing code from an **Enter Apex Code** window, which is accessible through the system logs, for example: ```text PushTopic pushTopic = new PushTopic(); pushTopic.ApiVersion = 50.0; pushTopic.Name = 'AllAccounts'; pushTopic.Description = 'All records for the Account object'; pushTopic.Query = 'SELECT Id, Name FROM Account'; insert pushTopic; System.debug('Created new PushTopic: '+ pushTopic.Id); ``` ### Subscribing to a PushTopic To subscribe to a PushTopic, add the **Replay topic listener** (`replay-topic-listener`) as a source for your flow. The source acts as an inbound endpoint. Each time the subscription receives an event, the source executes the rest of the flow in your Mule app. In the following XML example, Mule prints a message to the log at the INFO level when the `AccountUpdates` PushTopic receives an event: ```xml ``` You can subscribe to a PushTopic that was not previously published in Salesforce. However, after the PushTopic is published, you won’t receive notifications for that PushTopic unless you resubscribe to it. ### Replaying Messages from a PushTopic A subscriber can specify which events to receive. By default, a subscriber receives only the events that occur after subscribing. Events outside of the retention period are discarded. The **Replay topic listener** source provides these options: - `ALL` Subscriber receives all events, including past events that are within the retention period and new events that are sent after the client subscribes. - `ONLY_NEW` Subscriber receives new events that are sent after the client subscribes. - `FROM_REPLAY_ID` Subscriber receives all events after the specified event `replayId`. - `FROM_LAST_REPLAY_ID` Subscriber uses the highest replay ID stored in the object store regardless of whether it’s processed successfully or not. If you deploy the Mule app to CloudHub, then use the Object Store V2 option to retain the last processed `ReplayId`. If you specify either the `ALL` replay option or `ONLY_NEW` replay option, the `replayId` value is ignored. The **Resume from the Last Replay Id** checkbox enables you to specify an automatic replay of stored events based on the Replay ID of the last event processed by the connector. You can use this functionality when the connector stops listening, such as a during a server shutdown or dropped connection. If the stored Replay ID is outside the retention period, the replay option determines which events to replay. To support the resume from last replay ID functionality, the connector uses a persistent object store to keep different details regarding the processed messages. This feature reduces the possibility of message loss and avoids processing duplicate messages. For more information about how the object store is used, see [Object Store Usage in Events](#objectstoreusage). In the following XML example, the **Replay topic listener** operation (`replay-topic-listener`) acts like an inbound endpoint for the **Logger** component message: ```xml ``` ## Working with Generic Events (Legacy) Work with generic events by creating a streaming channel, subscribing to a streaming channel, replaying generic events, and pushing events to a streaming channel. > [!NOTE] Generic Events is a legacy product. Salesforce no longer enhances Generic Events with new > features and provides limited support for this product. Instead of Generic Events, you can use > Platform Events, as described in the > [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.platform_events.meta/platform_events/platform_events_intro.htm) > and the > [Platform Events Basics](https://trailhead.salesforce.com/content/learn/modules/platform_events_basics) > Trailhead module. ### Creating a Streaming Channel To create a streaming channel, you must have the proper Salesforce Streaming API permissions enabled in your organization. Follow these steps to create a streaming channel: 1. Log in to your Salesforce Developer Edition organization. 2. Under **All Tabs (+)**, select **Streaming Channels**. 3. On the **Streaming Channels** tab, select **New**. 4. Enter `/u/notifications/ExampleUserChannel` in the **Streaming Channel Name** field. 5. Enter an optional description. You can also create a streaming channel by using either the connector **Create** operation or the connector **Publish streaming channel** (`publish-streaming-channel`) operation. The following example uses the `publish-streaming-channel` operation: ```xml ``` ### Subscribing to a Streaming Channel After you create a streaming channel, you can start receiving events by subscribing to the channel. The **Replay channel listener** (`replay-channel-listener`) source acts like an inbound endpoint. In this example, every time a subscription to `/u/TestStreaming` receives an event, it executes the rest of the flow and logs a message at the INFO level: ```xml ``` ### Replaying Messages from a Streaming Channel A streaming channel can replay notifications. The **Replay channel listener** (`replay-channel-listener`) source acts as an inbound endpoint, for example: ```xml ``` If you specify either the `ALL` replay option or the `ONLY_NEW` replay option, the `replayId` value is ignored. The **Resume from the Last Replay Id** checkbox enables you to specify an automatic replay of stored events based on the Replay ID of the last event processed by the connector. You can use this functionality when the connector stops listening, such as a during a server shutdown or dropped connection. If the stored Replay ID is outside the retention period, the replay option determines which events to replay. To support the resume from the last replay ID feature, the connector uses a persistent object store to keep details regarding the processed messages. This feature reduces the possibility of message loss and avoids processing duplicate messages. For more information about how the object store is used, see [Object Store Usage in Events](#objectstoreusage). ### Pushing Events to a Streaming Channel with No Listener Users can push events to a streaming channel, even if the channel does not have a listener for reading published events. After a listener is started for the channel, Salesforce Streaming API pushes as many messages as it can to the listener, based on the maximum daily limit. For example, the maximum number of delivered event notifications within a 24-hour period for a free Salesforce organization is 10,000. Suppose you publish 15,000 events to that channel. When Salesforce Connector subscribes to that channel, Streaming API attempts to push 10,000 events, thus consuming the daily quota. The API then attempts to push the remaining 5,000 events the next day, before pushing any new events. In this scenario, the connector streams the events one-by-one into the Mule app. If the app takes too long to process a message, Streaming API might instruct the connector to reconnect. If this happens, Streaming API drops all of the unprocessed messages. You can avoid this situation by implementing a reliability pattern, as described in [Reliability Patterns](https://docs.mulesoft.com/mule-runtime/latest/reliability-patterns). ### Obtaining Generic Event Notifications Salesforce Connector enables you to obtain custom event notifications, which apply to general events that are not tied to Salesforce data changes. To obtain generic event notifications: 1. Use the **Publish streaming channel** operation to create a streaming channel. `StreamingChannel` is a special Salesforce object that represents a channel used to notify listeners of generic Streaming API events. You can also create a streaming channel through Salesforce. 2. Use the **Replay channel listener** operation to subscribe to the channel. Salesforce Connector converts the custom events in your streaming channel to Mule events. ### Pushing Generic Events to a Streaming Channel Salesforce enables you to push custom events to a specific streaming channel through the REST API. To do this, use this connector. The following example uses the connector’s **Push generic event** (`push-generic-event`) operation to push custom events to the channel with the ID `0M6j0000000KyjBCAS`: ```xml ``` You can retrieve the channel ID from the response map of the **Publish streaming channel** operation. Alternatively, you can retrieve the channel ID from the Salesforce page: 1. Log in to your Salesforce Developer Edition organization. 2. Under **All Tabs (+)**, select **Streaming Channels**. If the channel ID field is not visible on the channel list, follow these steps: 1. Click **Create New View**. 2. Type a name for the view in the **Name** input field. 3. In the **Available Fields** list, select **Streaming Channel ID** and click **Add**. You should see the channel ID for each streaming channel in the list. 4. Add any other fields. 5. Click **Save**. The JSON received as a response from the push event operation looks something like this: ```json [ { "userOnlineStatus": {}, "fanoutCount": 0 } ] ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-config-topics) - [Examples](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-examples) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.5 --- # Processing Events with Salesforce Connector 11.5 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use Anypoint Connector for Salesforce (Salesforce Connector) as an inbound connector to stream data from Salesforce into your application. To use the connector this way, you can use these sources for any type of events (platform events, change data capture events, and the legacy PushTopic and generic events): - **Replay topic listener** - **Replay channel listener** > [!NOTE] If you’re adding a new connector for platform events and change data capture events, you > can use [Salesforce Pub/Sub Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/), which is based > on the Pub/Sub API. When deploying apps in a distributed environment such as a runtime cluster, the source must run on the primary node. Running the source on multiple nodes causes duplicate event consumption and object store data corruption for the data stored by Salesforce Connector. When deploying apps in non-cluster mode with multiple workers, then the source runs on all the nodes which consumes duplicate events. Each event that travels through your flow contains information about the Salesforce data that changed, including how the data changed and when the change occurred. Salesforce stores events for 72 hours (or 24 hours for legacy PushTopic and generic events). A subscriber to a topic or channel can retrieve events related to that topic or channel during this retention window, after which the subscriber can retrieve only newer events that haven’t yet expired. Salesforce assigns a replay ID to each broadcast event, which you can use to replay stored event messages. For more information, refer to [Message Durability](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/using_streaming_api_durability.htm) in the Streaming API Developer Guide. > [!NOTE] Migrating a Salesforce instance to Hyperforce can result in an invalid replay ID error. > This occurs if the Mule app tries to access a replay ID from an object store that is no longer > valid on the new Hyperforce instance. To avoid this error, see this > [knowledge article](https://help.salesforce.com/s/articleView?id=001117442&type=1). ## Before You Begin To process events with Salesforce Connector, ensure that you have: - Access to the Salesforce target resource - The required Salesforce Streaming API permissions enabled in your organization To receive events for Salesforce changes associated with a topic, either create a new topic or use an existing one. ## Object Store Usage in Events Both Salesforce Connector and Mule runtime engine (Mule) use an object store to persist data for features such as automatic message replay and message redelivery: - The object store included in Mule for on-premises deployments of Mule apps has no transaction limits. - The free version of Object Store for CloudHub and CloudHub 2.0 deployments of Mule apps has a limit of 10 transactions per second (TPS), however other Anypoint Connectors using the object store internally have a limit of 100 TPS. For more information about Object Store versions, see [Object Store Notes](https://docs.mulesoft.com/object-store/#object-store-notes). ### Replay Topic Listener and Replay Channel Listener Sources The **Replay topic listener** and **Replay channel listener** sources can continue from the last replay ID they received before restarting the application. When a Mule app starts for the first time, the connector creates an object store that saves data: - If there are no failed events, the source starts from the event associated with the last successfully processed event ID. - If there are one or more failed events, the source starts with the event associated with the lowest replay ID that failed. Saving this change data capture in an object store ensures that no message is processed twice and that when the application restarts, it can reprocess any failed messages. The IDs are stored in the object store for 72 hours, after which they are automatically removed. The connector contains an in-memory structure that stores the replay IDs of events, including events that process successfully or events that fail to process. This in-memory structure uses the username in the connector configuration to persist into the object store to build a specific key. A redundancy mechanism avoids processing duplicate events by storing the same data under a backup key. Each persist operation consists of deleting the existing key and storing the new value, and if storing the new value fails, the connector retries, thus consuming 2 or more TPS per key. If you have multiple workers deployed in CloudHub, the **Replay topic listener** and **Replay channel listener** sources process each message on all Mule instances. To avoid this situation, you can deploy your application on a single worker and then use a shared queue to pass the messages to a different worker to process the message. ### Resume from the Last Replay ID To enable the resume from the last replay ID functionality for the **Replay topic listener** and **Replay channel listener** sources, the connector must store information about the events that were successfully processed by the flow in which the source is used. The connector uses an object store to store that information. The way that the object store stores the necessary data for the resume from the last replay ID functionality varies depending on the environment: - When a Mule app runs locally, the connector creates a persistent store in the file system. If the application stops and restarts, or if a connection issue triggers a reconnection, the data saved in the object store enables the connector to continue processing messages at the point where it stopped. - When a Mule app runs in a cluster with the nodes either on the same machine or on different machines, Mule uses a distributed in-memory object store: - If the primary node (the one consuming the messages) shuts down, the node that takes over for the primary node does not reprocess the same messages. Instead, the node continues from where the previous node stopped processing the messages. - If the cluster stops, the data from the object store is lost. When the cluster restarts, the configuration at the source level determines whether the connector reprocesses the messages. To persist data so that the app continues processing events when restarted, create a persistent object store, as described in [Create and Manage a Cluster Manually](https://docs.mulesoft.com/on-premises/latest/creating-and-managing-a-cluster-manually). - If you use multiple workers when running the app in CloudHub, all of the workers receive and process the events. ### Replay Sources Field Configurations Learn how to handle the priority in the replay sources field setup by using different configurations: - **Replay failed events if any or resume from last replay id** If enabled, this field overwrites anything selected in the **Replay option** field and anything entered in the **Replay id** field. The **Replay failed events if any or resume from last replay id** field checks the Object Store for failed event IDs or last known successfully processed event IDs. If there are failed events, processing starts with the lowest failed event, thus receiving all events from `lowestFailedEventId` until now. For example, if `FailedEventIdInObjectStore` is `10` and `LastSuccessfullyProcessedEventIdInObjectStore` is `15`, processing starts with 10 and the streaming client receives events 10 through 15 and consumes the quota. However, these events are not reprocessed by the flow and are filtered by the connector. If there are no failed event IDs stored, then processing starts with the highest known replay ID. If there is nothing saved in the Object Store, then the **Replay option** field is used. - **ReplayOption.ALL** Subscribes with `-2`. The user receives all events available in Salesforce. - **ReplayOption.ONLY\_NEW** Subscribes with `-1`. The user receives the events created after the connector subscribes. - **ReplayOption.FROM\_REPLAY\_ID** Subscribes with what the user enters in the **Replay id** field. - **ReplayOption.FROM\_LAST\_REPLAY\_ID** Checks the Object Store for the highest received event ID. It doesn’t matter whether the event is processed successfully. This option avoids quota consumption compared to the **Replay failed events if any or resume from last replay id** field, which starts the source with a failed event ID that is lower than the highest processed event ID. If you deploy the Mule app to CloudHub, then use the Object Store V2 option to retain the last processed `ReplayId`. - **Cache events in memory** If enabled, when the application starts, the connector subscribes from a replay ID. The Salesforce API pushes all events that start with the replay ID that is used to subscribe, thus consuming quota. If there are many available events and the Mule app processes them slowly, it can take a while to process all of them. With this option enabled, the events pushed by the API are stored in memory and are consumed sequentially in the order they are received. If there is a connection issue or the token expires and the connector must resubscribe, the events would be lost without this configuration and the quota would be consumed. > [!NOTE] The connector interacts with Object Store to store and retrieve data only when the > **Replay Option** field is set to `FROM_LAST_REPLAY_ID` or when the **Replay failed events if any > or resume from last replay id** checkbox is selected. > > In CloudHub and CloudHub 2.0, when the **Replay Option** field is set to `FROM_LAST_REPLAY_ID` or > when the **Replay failed events if any or resume from last replay id** checkbox is selected, the > last known replay ID might not be found in Object Store, which causes all events to replay when > the application restarts or redeploys. This is because Object Store v2 does not have a distributed > locking mechanism. For more information, refer to > [Last known replayId not found in ObjectStore](https://help.salesforce.com/s/articleView?id=001117329&type=1). ## Multiple Flows That Use the Same Source If you have two or more flows that use a source that listens to events on the same channel or topic, the events are consumed two or more times from your user quota. To avoid this, consider implementing that logic in a single flow instead. > [!WARNING] Having multiple sources listening to the same events and having the **Resume from the > Last Replay Id** option enabled can lead to data corruption and the potential loss of events. ## Multiple Flows with Different Sources Having two or more flows that use different sources with the **Replay Failed Events If Any or Resume from Last Replay Id** option enabled, under certain conditions, might have performance implications. To avoid performance implications, use different Salesforce Connector configurations with different Salesforce usernames. > [!WARNING] Changing the username for a configuration prevents the connector from loading the last > processed and failed replay IDs. Processing resumes from the first event available in Salesforce. > [!WARNING] Avoid using personal user accounts to access Salesforce. ## Working with Platform Events Subscribe to platform events by using Salesforce Connector. The following example is based on the platform events in the [Define and Publish Platform Events](https://trailhead.salesforce.com/content/learn/modules/platform_events_basics/platform_events_define_publish) Trailhead. To receive platform events from Salesforce by using Salesforce Connector: 1. Log in to Salesforce and create a Salesforce platform event, such as `Cloud_News__e`. 2. Go to Anypoint Studio and create a Mule app. 3. Drag the **Replay Channel Listener** source to the canvas and in the **Streaming Channel** field, specify `/event/Cloud_News__e`. 4. Drag a **Logger** component to the canvas to show the payload so you can see the received message on the console, for example: ```xml ``` 5. Publish a platform event message to `Cloud_News__e`. You can use Apex code, process, Salesforce Flow, or Salesforce APIs. For example, you can send a POST request as follows: ```text { "Location__c" : "Mountain City", "Urgent__c" : true, "News_Content__c" : "Lake Road is closed due to mudslides." } ``` The console appears as follows: ```console INFO 2019-10-26 16:11:50,483 [[MuleRuntime].cpuLight.05: [test].SampleFlow.CPU_LITE @2b42bef0] [event: e00096e0-f7bf-11e9-b534-8c85907d741e] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: {data={schema=eGRz2Sfoy-YO9mVvH8J4fg, payload= {News_Content__c=Lake Road is closed due to mudslides., CreatedById=0050o00000U3Q8vAAF, CreatedDate=2019-10-26T07:12:01.026Z, Location__c=Mountain City, Urgent__c=true}, event={replayId=49544589}}, channel=/event/Cloud_News__e} ``` ## Working with Change Data Capture Events Subscribe to change data capture events, such as Salesforce object creations, updates, or deletions, by using Salesforce Connector. This example uses the **Replay Channel Listener** source, which enables you to replay events. 1. Log in to Salesforce. 2. Go to **Setup > Integrations > Change Data Capture** and select a Salesforce object, such as Account. 3. Go to Anypoint Studio and create a Mule app. 4. Drag the **Replay Channel Listener** source to the canvas and in the **Streaming Channel** field, specify `/data/AccountChangeEvent`. For a list of channel names, refer to [Subscription Channels](https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_subscribe_channels.htm). 5. Drag a **Logger** component to the canvas to show the payload so you can see the received message on the console, for example: ```xml ``` 6. Log in to Salesforce and update any Account record; for example, update the name of the account to `TestName2`. The console appears as follows: ```console INFO 2019-11-12 08:17:27,496 [[MuleRuntime].cpuLight.05: [sample].sampleFlow.CPU_LITE @14741f50] [event: xxx] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: {data={schema=CEjkFTwpfASSecY9UGNoOg, payload={LastModifiedDate=2019-11-11T23:17:30.000Z, ChangeEventHeader={commitNumber=10743571519745, commitUser=0050o00000XTesxAAD, sequenceNumber=1, entityName=Account, changeType=UPDATE, changedFields=[Ljava.lang.Object;@4f738b9d, changeOrigin=com/salesforce/api/soap/47.0;client=SfdcInternalAPI/, transactionKey=0002463d-1e88-1d80-5638-15c821f06b79, commitTimestamp=1573514251000, recordIds=[Ljava.lang.Object;@6e812151}, Name=TestName2}, event={replayId=1065378}}, channel=/data/AccountChangeEvent} ``` ## Working with PushTopic Events (Legacy) Work with PushTopic events by creating a PushTopic, subscribing to a PushTopic, and replaying PushTopic messages. > [!NOTE] PushTopic events is a legacy product. Salesforce no longer enhances PushTopic events with > new features and provides limited support for this product. Instead of PushTopic events, use > Change Data Capture events, as described in the > [Change Data Capture Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.change_data_capture.meta/change_data_capture/cdc_intro.htm) > and the > [Change Data Capture Basics](https://trailhead.salesforce.com/content/learn/modules/change-data-capture) > Trailhead module. ### Creating a PushTopic to Receive Data from Salesforce When you create a topic, the connector creates a `PushTopic`, which is a special object in Salesforce that binds a name (in this case, the topic’s name) and a Salesforce Object Query Language (SOQL) query together. After creating a PushTopic, you can subscribe to it by name. You can use either the **Create** (`create`) operation or **Publish topic** (`publish-topic`) operation to create a PushTopic. The following example uses the `publish-topic` operation to create a PushTopic: `` Alternatively, you can create a topic in Salesforce by executing code from an **Enter Apex Code** window, which is accessible through the system logs, for example: ```text PushTopic pushTopic = new PushTopic(); pushTopic.ApiVersion = 50.0; pushTopic.Name = 'AllAccounts'; pushTopic.Description = 'All records for the Account object'; pushTopic.Query = 'SELECT Id, Name FROM Account'; insert pushTopic; System.debug('Created new PushTopic: '+ pushTopic.Id); ``` ### Subscribing to a PushTopic To subscribe to a PushTopic, add the **Replay topic listener** (`replay-topic-listener`) as a source for your flow. The source acts as an inbound endpoint. Each time the subscription receives an event, the source executes the rest of the flow in your Mule app. In the following XML example, Mule prints a message to the log at the INFO level when the `AccountUpdates` PushTopic receives an event: ```xml ``` You can subscribe to a PushTopic that was not previously published in Salesforce. However, after the PushTopic is published, you won’t receive notifications for that PushTopic unless you resubscribe to it. ### Replaying Messages from a PushTopic A subscriber can specify which events to receive. By default, a subscriber receives only the events that occur after subscribing. Events outside of the retention period are discarded. The **Replay topic listener** source provides these options: - `ALL` Subscriber receives all events, including past events that are within the retention period and new events that are sent after the client subscribes. - `ONLY_NEW` Subscriber receives new events that are sent after the client subscribes. - `FROM_REPLAY_ID` Subscriber receives all events after the specified event `replayId`. - `FROM_LAST_REPLAY_ID` Subscriber uses the highest replay ID stored in the object store regardless of whether it’s processed successfully or not. If you deploy the Mule app to CloudHub, then use the Object Store V2 option to retain the last processed `ReplayId`. If you specify either the `ALL` replay option or `ONLY_NEW` replay option, the `replayId` value is ignored. The **Resume from the Last Replay Id** checkbox enables you to specify an automatic replay of stored events based on the Replay ID of the last event processed by the connector. You can use this functionality when the connector stops listening, such as a during a server shutdown or dropped connection. If the stored Replay ID is outside the retention period, the replay option determines which events to replay. To support the resume from last replay ID functionality, the connector uses a persistent object store to keep different details regarding the processed messages. This feature reduces the possibility of message loss and avoids processing duplicate messages. For more information about how the object store is used, see [Object Store Usage in Events](#objectstoreusage). In the following XML example, the **Replay topic listener** operation (`replay-topic-listener`) acts like an inbound endpoint for the **Logger** component message: ```xml ``` ## Working with Generic Events (Legacy) Work with generic events by creating a streaming channel, subscribing to a streaming channel, replaying generic events, and pushing events to a streaming channel. > [!NOTE] Generic Events is a legacy product. Salesforce no longer enhances Generic Events with new > features and provides limited support for this product. Instead of Generic Events, you can use > Platform Events, as described in the > [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.platform_events.meta/platform_events/platform_events_intro.htm) > and the > [Platform Events Basics](https://trailhead.salesforce.com/content/learn/modules/platform_events_basics) > Trailhead module. ### Creating a Streaming Channel To create a streaming channel, you must have the proper Salesforce Streaming API permissions enabled in your organization. Follow these steps to create a streaming channel: 1. Log in to your Salesforce Developer Edition organization. 2. Under **All Tabs (+)**, select **Streaming Channels**. 3. On the **Streaming Channels** tab, select **New**. 4. Enter `/u/notifications/ExampleUserChannel` in the **Streaming Channel Name** field. 5. Enter an optional description. You can also create a streaming channel by using either the connector **Create** operation or the connector **Publish streaming channel** (`publish-streaming-channel`) operation. The following example uses the `publish-streaming-channel` operation: ```xml ``` ### Subscribing to a Streaming Channel After you create a streaming channel, you can start receiving events by subscribing to the channel. The **Replay channel listener** (`replay-channel-listener`) source acts like an inbound endpoint. In this example, every time a subscription to `/u/TestStreaming` receives an event, it executes the rest of the flow and logs a message at the INFO level: ```xml ``` ### Replaying Messages from a Streaming Channel A streaming channel can replay notifications. The **Replay channel listener** (`replay-channel-listener`) source acts as an inbound endpoint, for example: ```xml ``` If you specify either the `ALL` replay option or the `ONLY_NEW` replay option, the `replayId` value is ignored. The **Resume from the Last Replay Id** checkbox enables you to specify an automatic replay of stored events based on the Replay ID of the last event processed by the connector. You can use this functionality when the connector stops listening, such as a during a server shutdown or dropped connection. If the stored Replay ID is outside the retention period, the replay option determines which events to replay. To support the resume from the last replay ID feature, the connector uses a persistent object store to keep details regarding the processed messages. This feature reduces the possibility of message loss and avoids processing duplicate messages. For more information about how the object store is used, see [Object Store Usage in Events](#objectstoreusage). ### Pushing Events to a Streaming Channel with No Listener Users can push events to a streaming channel, even if the channel does not have a listener for reading published events. After a listener is started for the channel, Salesforce Streaming API pushes as many messages as it can to the listener, based on the maximum daily limit. For example, the maximum number of delivered event notifications within a 24-hour period for a free Salesforce organization is 10,000. Suppose you publish 15,000 events to that channel. When Salesforce Connector subscribes to that channel, Streaming API attempts to push 10,000 events, thus consuming the daily quota. The API then attempts to push the remaining 5,000 events the next day, before pushing any new events. In this scenario, the connector streams the events one-by-one into the Mule app. If the app takes too long to process a message, Streaming API might instruct the connector to reconnect. If this happens, Streaming API drops all of the unprocessed messages. You can avoid this situation by implementing a reliability pattern, as described in [Reliability Patterns](https://docs.mulesoft.com/mule-runtime/latest/reliability-patterns). ### Obtaining Generic Event Notifications Salesforce Connector enables you to obtain custom event notifications, which apply to general events that are not tied to Salesforce data changes. To obtain generic event notifications: 1. Use the **Publish streaming channel** operation to create a streaming channel. `StreamingChannel` is a special Salesforce object that represents a channel used to notify listeners of generic Streaming API events. You can also create a streaming channel through Salesforce. 2. Use the **Replay channel listener** operation to subscribe to the channel. Salesforce Connector converts the custom events in your streaming channel to Mule events. ### Pushing Generic Events to a Streaming Channel Salesforce enables you to push custom events to a specific streaming channel through the REST API. To do this, use this connector. The following example uses the connector’s **Push generic event** (`push-generic-event`) operation to push custom events to the channel with the ID `0M6j0000000KyjBCAS`: ```xml ``` You can retrieve the channel ID from the response map of the **Publish streaming channel** operation. Alternatively, you can retrieve the channel ID from the Salesforce page: 1. Log in to your Salesforce Developer Edition organization. 2. Under **All Tabs (+)**, select **Streaming Channels**. If the channel ID field is not visible on the channel list, follow these steps: 1. Click **Create New View**. 2. Type a name for the view in the **Name** input field. 3. In the **Available Fields** list, select **Streaming Channel ID** and click **Add**. You should see the channel ID for each streaming channel in the list. 4. Add any other fields. 5. Click **Save**. The JSON received as a response from the push event operation looks something like this: ```json [ { "userOnlineStatus": {}, "fanoutCount": 0 } ] ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-config-topics) - [Examples](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-examples) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 12.0 is-latest-version: true --- # Processing Events with Salesforce Connector 12.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use Anypoint Connector for Salesforce (Salesforce Connector) as an inbound connector to stream data from Salesforce into your application. To use the connector this way, you can use these sources for any type of events (platform events, change data capture events, and the legacy PushTopic and generic events): - **Replay topic listener** - **Replay channel listener** > [!NOTE] If you’re adding a new connector for platform events and change data capture events, you > can use [Salesforce Pub/Sub Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/), which is based > on the Pub/Sub API. When deploying apps in a distributed environment such as a runtime cluster, the source must run on the primary node. Running the source on multiple nodes causes duplicate event consumption and object store data corruption for the data stored by Salesforce Connector. When deploying apps in non-cluster mode with multiple workers, then the source runs on all the nodes which consumes duplicate events. Each event that travels through your flow contains information about the Salesforce data that changed, including how the data changed and when the change occurred. Salesforce stores events for 72 hours (or 24 hours for legacy PushTopic and generic events). A subscriber to a topic or channel can retrieve events related to that topic or channel during this retention window, after which the subscriber can retrieve only newer events that haven’t yet expired. Salesforce assigns a replay ID to each broadcast event, which you can use to replay stored event messages. For more information, refer to [Message Durability](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/using_streaming_api_durability.htm) in the Streaming API Developer Guide. > [!NOTE] Migrating a Salesforce instance to Hyperforce can result in an invalid replay ID error. > This occurs if the Mule app tries to access a replay ID from an object store that is no longer > valid on the new Hyperforce instance. To avoid this error, see this > [knowledge article](https://help.salesforce.com/s/articleView?id=001117442&type=1). ## Before You Begin To process events with Salesforce Connector, ensure that you have: - Access to the Salesforce target resource - The required Salesforce Streaming API permissions enabled in your organization To receive events for Salesforce changes associated with a topic, either create a new topic or use an existing one. ## Object Store Usage in Events Both Salesforce Connector and Mule runtime engine (Mule) use an object store to persist data for features such as automatic message replay and message redelivery: - The object store included in Mule for on-premises deployments of Mule apps has no transaction limits. - The free version of Object Store for CloudHub and CloudHub 2.0 deployments of Mule apps has a limit of 10 transactions per second (TPS), however other Anypoint Connectors using the object store internally have a limit of 100 TPS. For more information about Object Store versions, see [Object Store Notes](https://docs.mulesoft.com/object-store/#object-store-notes). ### Replay Topic Listener and Replay Channel Listener Sources The **Replay topic listener** and **Replay channel listener** sources can continue from the last replay ID they received before restarting the application. When a Mule app starts for the first time, the connector creates an object store that saves data: - If there are no failed events, the source starts from the event associated with the last successfully processed event ID. - If there are one or more failed events, the source starts with the event associated with the lowest replay ID that failed. Saving this change data capture in an object store ensures that no message is processed twice and that when the application restarts, it can reprocess any failed messages. The IDs are stored in the object store for 72 hours, after which they are automatically removed. The connector contains an in-memory structure that stores the replay IDs of events, including events that process successfully or events that fail to process. This in-memory structure uses the username in the connector configuration to persist into the object store to build a specific key. A redundancy mechanism avoids processing duplicate events by storing the same data under a backup key. Each persist operation consists of deleting the existing key and storing the new value, and if storing the new value fails, the connector retries, thus consuming 2 or more TPS per key. If you have multiple workers deployed in CloudHub, the **Replay topic listener** and **Replay channel listener** sources process each message on all Mule instances. To avoid this situation, you can deploy your application on a single worker and then use a shared queue to pass the messages to a different worker to process the message. ### Resume from the Last Replay ID To enable the resume from the last replay ID functionality for the **Replay topic listener** and **Replay channel listener** sources, the connector must store information about the events that were successfully processed by the flow in which the source is used. The connector uses an object store to store that information. The way that the object store stores the necessary data for the resume from the last replay ID functionality varies depending on the environment: - When a Mule app runs locally, the connector creates a persistent store in the file system. If the application stops and restarts, or if a connection issue triggers a reconnection, the data saved in the object store enables the connector to continue processing messages at the point where it stopped. - When a Mule app runs in a cluster with the nodes either on the same machine or on different machines, Mule uses a distributed in-memory object store: - If the primary node (the one consuming the messages) shuts down, the node that takes over for the primary node does not reprocess the same messages. Instead, the node continues from where the previous node stopped processing the messages. - If the cluster stops, the data from the object store is lost. When the cluster restarts, the configuration at the source level determines whether the connector reprocesses the messages. To persist data so that the app continues processing events when restarted, create a persistent object store, as described in [Create and Manage a Cluster Manually](https://docs.mulesoft.com/on-premises/latest/creating-and-managing-a-cluster-manually). - If you use multiple workers when running the app in CloudHub, all of the workers receive and process the events. ### Replay Sources Field Configurations Learn how to handle the priority in the replay sources field setup by using different configurations: - **Replay failed events if any or resume from last replay id** If enabled, this field overwrites anything selected in the **Replay option** field and anything entered in the **Replay id** field. The **Replay failed events if any or resume from last replay id** field checks the Object Store for failed event IDs or last known successfully processed event IDs. If there are failed events, processing starts with the lowest failed event, thus receiving all events from `lowestFailedEventId` until now. For example, if `FailedEventIdInObjectStore` is `10` and `LastSuccessfullyProcessedEventIdInObjectStore` is `15`, processing starts with 10 and the streaming client receives events 10 through 15 and consumes the quota. However, these events are not reprocessed by the flow and are filtered by the connector. If there are no failed event IDs stored, then processing starts with the highest known replay ID. If there is nothing saved in the Object Store, then the **Replay option** field is used. - **ReplayOption.ALL** Subscribes with `-2`. The user receives all events available in Salesforce. - **ReplayOption.ONLY\_NEW** Subscribes with `-1`. The user receives the events created after the connector subscribes. - **ReplayOption.FROM\_REPLAY\_ID** Subscribes with what the user enters in the **Replay id** field. - **ReplayOption.FROM\_LAST\_REPLAY\_ID** Checks the Object Store for the highest received event ID. It doesn’t matter whether the event is processed successfully. This option avoids quota consumption compared to the **Replay failed events if any or resume from last replay id** field, which starts the source with a failed event ID that is lower than the highest processed event ID. If you deploy the Mule app to CloudHub, then use the Object Store V2 option to retain the last processed `ReplayId`. - **Cache events in memory** If enabled, when the application starts, the connector subscribes from a replay ID. The Salesforce API pushes all events that start with the replay ID that is used to subscribe, thus consuming quota. If there are many available events and the Mule app processes them slowly, it can take a while to process all of them. With this option enabled, the events pushed by the API are stored in memory and are consumed sequentially in the order they are received. If there is a connection issue or the token expires and the connector must resubscribe, the events would be lost without this configuration and the quota would be consumed. > [!NOTE] The connector interacts with Object Store to store and retrieve data only when the > **Replay Option** field is set to `FROM_LAST_REPLAY_ID` or when the **Replay failed events if any > or resume from last replay id** checkbox is selected. > > In CloudHub and CloudHub 2.0, when the **Replay Option** field is set to `FROM_LAST_REPLAY_ID` or > when the **Replay failed events if any or resume from last replay id** checkbox is selected, the > last known replay ID might not be found in Object Store, which causes all events to replay when > the application restarts or redeploys. This is because Object Store v2 does not have a distributed > locking mechanism. For more information, refer to > [Last known replayId not found in ObjectStore](https://help.salesforce.com/s/articleView?id=001117329&type=1). ## Multiple Flows That Use the Same Source If you have two or more flows that use a source that listens to events on the same channel or topic, the events are consumed two or more times from your user quota. To avoid this, consider implementing that logic in a single flow instead. > [!WARNING] Having multiple sources listening to the same events and having the **Resume from the > Last Replay Id** option enabled can lead to data corruption and the potential loss of events. ## Multiple Flows with Different Sources Having two or more flows that use different sources with the **Replay Failed Events If Any or Resume from Last Replay Id** option enabled, under certain conditions, might have performance implications. To avoid performance implications, use different Salesforce Connector configurations with different Salesforce usernames. > [!WARNING] Changing the username for a configuration prevents the connector from loading the last > processed and failed replay IDs. Processing resumes from the first event available in Salesforce. > [!WARNING] Avoid using personal user accounts to access Salesforce. ## Working with Platform Events Subscribe to platform events by using Salesforce Connector. The following example is based on the platform events in the [Define and Publish Platform Events](https://trailhead.salesforce.com/content/learn/modules/platform_events_basics/platform_events_define_publish) Trailhead. To receive platform events from Salesforce by using Salesforce Connector: 1. Log in to Salesforce and create a Salesforce platform event, such as `Cloud_News__e`. 2. Go to Anypoint Studio and create a Mule app. 3. Drag the **Replay Channel Listener** source to the canvas and in the **Streaming Channel** field, specify `/event/Cloud_News__e`. 4. Drag a **Logger** component to the canvas to show the payload so you can see the received message on the console, for example: ```xml ``` 5. Publish a platform event message to `Cloud_News__e`. You can use Apex code, process, Salesforce Flow, or Salesforce APIs. For example, you can send a POST request as follows: ```text { "Location__c" : "Mountain City", "Urgent__c" : true, "News_Content__c" : "Lake Road is closed due to mudslides." } ``` The console appears as follows: ```console INFO 2019-10-26 16:11:50,483 [[MuleRuntime].cpuLight.05: [test].SampleFlow.CPU_LITE @2b42bef0] [event: e00096e0-f7bf-11e9-b534-8c85907d741e] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: {data={schema=eGRz2Sfoy-YO9mVvH8J4fg, payload= {News_Content__c=Lake Road is closed due to mudslides., CreatedById=0050o00000U3Q8vAAF, CreatedDate=2019-10-26T07:12:01.026Z, Location__c=Mountain City, Urgent__c=true}, event={replayId=49544589}}, channel=/event/Cloud_News__e} ``` ### Recover from Platform Event Listener Connection Issues Salesforce Connector receives platform events through the CometD-based Streaming API. Connection issues can interrupt event delivery even while the Mule app remains running. #### Recover from an Unknown Client Error The `403::Unknown client` error can occur after a network interruption causes the CometD server to time out the client and delete its connection state. This error can be expected during connection recovery and doesn’t necessarily indicate an authentication or permissions problem. When Salesforce returns this error with `reconnect=handshake` advice, the connector attempts to reconnect and resubscribe. A replay listener can resume from a stored replay ID, depending on its replay configuration and whether the events are still within the Salesforce retention window. For more information about the error and handshake advice, see [Handling Streaming API Errors](https://developer.salesforce.com/docs/platform/api-streaming/guide/streaming-handling-errors.html). > [!NOTE] Earlier Salesforce Connector versions can stop receiving events after > `403::Unknown client` errors. Salesforce Connector version 10.22.5 added recovery handling for > this error with `reconnect=handshake` advice for **Subscribe Channel Listener**, **Subscribe Topic > Listener**, **Replay Channel Listener**, and **Replay Topic Listener**. Salesforce Connector > version 11.3.3 also fixed a **Replay Channel Listener** connection leak during `403` or `401` > recovery that could cause duplicate event consumption. > > Use the latest supported version compatible with your Mule runtime to receive these and subsequent > fixes. See > [Salesforce Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-connector-release-notes-mule-4) > and [Upgrading and Migrating Salesforce Connector](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-upgrade-migrate). #### Handle Persistent Errors and Event Limits The `403::Organization total events daily limit exceeded` error isn’t a transient connection failure. It indicates that the Salesforce organization has exhausted its event delivery allocation. The listener can enter a continuous reconnect loop without quota-specific backoff while the limit remains exceeded. Reconnecting doesn’t restore the allocation. If the listener repeatedly reconnects with this error, stop the affected listener or app to interrupt the loop. Check event usage with your Salesforce administrator and reduce unnecessary subscriptions or replay requests, or review whether your organization needs additional event delivery allocation. Wait until the allocation is available again before restarting the listener or app. Repeatedly restarting the app doesn’t resolve the limit. To throw an exception during deployment when the daily limit is already exceeded, set **Throw Exception When Organization Daily Limit Exceeded** to `true` on **Replay Channel Listener**. This setting doesn’t control retry delays. See [**Replay Channel Listener**](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-reference#replay-channel-listener). #### Configure Resilient Event Consumption To reduce event loss and unnecessary replay after a connection interruption: - Persist replay IDs across application restarts. See [Resume from the Last Replay ID](#resume-from-the-last-replay-id) for object store requirements in your deployment environment. - Set **Replay Option** to `FROM_LAST_REPLAY_ID` (`replayOption="FROM_LAST_REPLAY_ID"`) to resume from the highest received replay ID stored in the object store. This option doesn’t account for whether the flow successfully processed that event. - If you also need to replay failed events, enable **Replay Failed Events If Any or Resume from Last Replay Id**. This setting overrides **Replay Option** and can consume additional event quota. See [Replay Sources Field Configurations](#replay-sources-field-configurations). - Configure the source’s **Reconnection Strategy** with an appropriate retry interval and retry count for connectivity errors reported to Mule. These settings don’t restore event allocation or automatically wait until the allocation is available again. See [Reconnection Strategies](https://docs.mulesoft.com/mule-runtime/latest/reconnection-strategy-about). - Monitor event consumption, not just application status. If events stop arriving and don’t resume after the connection issue is resolved, check the logs and restart the stopped listener or app as needed. As an alternative to CometD-based streaming, consider migrating to [Salesforce Pub/Sub Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/), which uses the Pub/Sub API. Review its replay and recovery configuration before migrating. Salesforce event limits and retention requirements still apply. ## Working with Change Data Capture Events Subscribe to change data capture events, such as Salesforce object creations, updates, or deletions, by using Salesforce Connector. This example uses the **Replay Channel Listener** source, which enables you to replay events. 1. Log in to Salesforce. 2. Go to **Setup > Integrations > Change Data Capture** and select a Salesforce object, such as Account. 3. Go to Anypoint Studio and create a Mule app. 4. Drag the **Replay Channel Listener** source to the canvas and in the **Streaming Channel** field, specify `/data/AccountChangeEvent`. For a list of channel names, refer to [Subscription Channels](https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_subscribe_channels.htm). 5. Drag a **Logger** component to the canvas to show the payload so you can see the received message on the console, for example: ```xml ``` 6. Log in to Salesforce and update any Account record; for example, update the name of the account to `TestName2`. The console appears as follows: ```console INFO 2019-11-12 08:17:27,496 [[MuleRuntime].cpuLight.05: [sample].sampleFlow.CPU_LITE @14741f50] [event: xxx] org.mule.runtime.core.internal.processor.LoggerMessageProcessor: {data={schema=CEjkFTwpfASSecY9UGNoOg, payload={LastModifiedDate=2019-11-11T23:17:30.000Z, ChangeEventHeader={commitNumber=10743571519745, commitUser=0050o00000XTesxAAD, sequenceNumber=1, entityName=Account, changeType=UPDATE, changedFields=[Ljava.lang.Object;@4f738b9d, changeOrigin=com/salesforce/api/soap/47.0;client=SfdcInternalAPI/, transactionKey=0002463d-1e88-1d80-5638-15c821f06b79, commitTimestamp=1573514251000, recordIds=[Ljava.lang.Object;@6e812151}, Name=TestName2}, event={replayId=1065378}}, channel=/data/AccountChangeEvent} ``` ## Working with PushTopic Events (Legacy) Work with PushTopic events by creating a PushTopic, subscribing to a PushTopic, and replaying PushTopic messages. > [!NOTE] PushTopic events is a legacy product. Salesforce no longer enhances PushTopic events with > new features and provides limited support for this product. Instead of PushTopic events, use > Change Data Capture events, as described in the > [Change Data Capture Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.change_data_capture.meta/change_data_capture/cdc_intro.htm) > and the > [Change Data Capture Basics](https://trailhead.salesforce.com/content/learn/modules/change-data-capture) > Trailhead module. ### Creating a PushTopic to Receive Data from Salesforce When you create a topic, the connector creates a `PushTopic`, which is a special object in Salesforce that binds a name (in this case, the topic’s name) and a Salesforce Object Query Language (SOQL) query together. After creating a PushTopic, you can subscribe to it by name. You can use either the **Create** (`create`) operation or **Publish topic** (`publish-topic`) operation to create a PushTopic. The following example uses the `publish-topic` operation to create a PushTopic: `` Alternatively, you can create a topic in Salesforce by executing code from an **Enter Apex Code** window, which is accessible through the system logs, for example: ```text PushTopic pushTopic = new PushTopic(); pushTopic.ApiVersion = 50.0; pushTopic.Name = 'AllAccounts'; pushTopic.Description = 'All records for the Account object'; pushTopic.Query = 'SELECT Id, Name FROM Account'; insert pushTopic; System.debug('Created new PushTopic: '+ pushTopic.Id); ``` ### Subscribing to a PushTopic To subscribe to a PushTopic, add the **Replay topic listener** (`replay-topic-listener`) as a source for your flow. The source acts as an inbound endpoint. Each time the subscription receives an event, the source executes the rest of the flow in your Mule app. In the following XML example, Mule prints a message to the log at the INFO level when the `AccountUpdates` PushTopic receives an event: ```xml ``` You can subscribe to a PushTopic that was not previously published in Salesforce. However, after the PushTopic is published, you won’t receive notifications for that PushTopic unless you resubscribe to it. ### Replaying Messages from a PushTopic A subscriber can specify which events to receive. By default, a subscriber receives only the events that occur after subscribing. Events outside of the retention period are discarded. The **Replay topic listener** source provides these options: - `ALL` Subscriber receives all events, including past events that are within the retention period and new events that are sent after the client subscribes. - `ONLY_NEW` Subscriber receives new events that are sent after the client subscribes. - `FROM_REPLAY_ID` Subscriber receives all events after the specified event `replayId`. - `FROM_LAST_REPLAY_ID` Subscriber uses the highest replay ID stored in the object store regardless of whether it’s processed successfully or not. If you deploy the Mule app to CloudHub, then use the Object Store V2 option to retain the last processed `ReplayId`. If you specify either the `ALL` replay option or `ONLY_NEW` replay option, the `replayId` value is ignored. The **Resume from the Last Replay Id** checkbox enables you to specify an automatic replay of stored events based on the Replay ID of the last event processed by the connector. You can use this functionality when the connector stops listening, such as a during a server shutdown or dropped connection. If the stored Replay ID is outside the retention period, the replay option determines which events to replay. To support the resume from last replay ID functionality, the connector uses a persistent object store to keep different details regarding the processed messages. This feature reduces the possibility of message loss and avoids processing duplicate messages. For more information about how the object store is used, see [Object Store Usage in Events](#objectstoreusage). In the following XML example, the **Replay topic listener** operation (`replay-topic-listener`) acts like an inbound endpoint for the **Logger** component message: ```xml ``` ## Working with Generic Events (Legacy) Work with generic events by creating a streaming channel, subscribing to a streaming channel, replaying generic events, and pushing events to a streaming channel. > [!NOTE] Generic Events is a legacy product. Salesforce no longer enhances Generic Events with new > features and provides limited support for this product. Instead of Generic Events, you can use > Platform Events, as described in the > [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.platform_events.meta/platform_events/platform_events_intro.htm) > and the > [Platform Events Basics](https://trailhead.salesforce.com/content/learn/modules/platform_events_basics) > Trailhead module. ### Creating a Streaming Channel To create a streaming channel, you must have the proper Salesforce Streaming API permissions enabled in your organization. Follow these steps to create a streaming channel: 1. Log in to your Salesforce Developer Edition organization. 2. Under **All Tabs (+)**, select **Streaming Channels**. 3. On the **Streaming Channels** tab, select **New**. 4. Enter `/u/notifications/ExampleUserChannel` in the **Streaming Channel Name** field. 5. Enter an optional description. You can also create a streaming channel by using either the connector **Create** operation or the connector **Publish streaming channel** (`publish-streaming-channel`) operation. The following example uses the `publish-streaming-channel` operation: ```xml ``` ### Subscribing to a Streaming Channel After you create a streaming channel, you can start receiving events by subscribing to the channel. The **Replay channel listener** (`replay-channel-listener`) source acts like an inbound endpoint. In this example, every time a subscription to `/u/TestStreaming` receives an event, it executes the rest of the flow and logs a message at the INFO level: ```xml ``` ### Replaying Messages from a Streaming Channel A streaming channel can replay notifications. The **Replay channel listener** (`replay-channel-listener`) source acts as an inbound endpoint, for example: ```xml ``` If you specify either the `ALL` replay option or the `ONLY_NEW` replay option, the `replayId` value is ignored. The **Resume from the Last Replay Id** checkbox enables you to specify an automatic replay of stored events based on the Replay ID of the last event processed by the connector. You can use this functionality when the connector stops listening, such as a during a server shutdown or dropped connection. If the stored Replay ID is outside the retention period, the replay option determines which events to replay. To support the resume from the last replay ID feature, the connector uses a persistent object store to keep details regarding the processed messages. This feature reduces the possibility of message loss and avoids processing duplicate messages. For more information about how the object store is used, see [Object Store Usage in Events](#objectstoreusage). ### Pushing Events to a Streaming Channel with No Listener Users can push events to a streaming channel, even if the channel does not have a listener for reading published events. After a listener is started for the channel, Salesforce Streaming API pushes as many messages as it can to the listener, based on the maximum daily limit. For example, the maximum number of delivered event notifications within a 24-hour period for a free Salesforce organization is 10,000. Suppose you publish 15,000 events to that channel. When Salesforce Connector subscribes to that channel, Streaming API attempts to push 10,000 events, thus consuming the daily quota. The API then attempts to push the remaining 5,000 events the next day, before pushing any new events. In this scenario, the connector streams the events one-by-one into the Mule app. If the app takes too long to process a message, Streaming API might instruct the connector to reconnect. If this happens, Streaming API drops all of the unprocessed messages. You can avoid this situation by implementing a reliability pattern, as described in [Reliability Patterns](https://docs.mulesoft.com/mule-runtime/latest/reliability-patterns). ### Obtaining Generic Event Notifications Salesforce Connector enables you to obtain custom event notifications, which apply to general events that are not tied to Salesforce data changes. To obtain generic event notifications: 1. Use the **Publish streaming channel** operation to create a streaming channel. `StreamingChannel` is a special Salesforce object that represents a channel used to notify listeners of generic Streaming API events. You can also create a streaming channel through Salesforce. 2. Use the **Replay channel listener** operation to subscribe to the channel. Salesforce Connector converts the custom events in your streaming channel to Mule events. ### Pushing Generic Events to a Streaming Channel Salesforce enables you to push custom events to a specific streaming channel through the REST API. To do this, use this connector. The following example uses the connector’s **Push generic event** (`push-generic-event`) operation to push custom events to the channel with the ID `0M6j0000000KyjBCAS`: ```xml ``` You can retrieve the channel ID from the response map of the **Publish streaming channel** operation. Alternatively, you can retrieve the channel ID from the Salesforce page: 1. Log in to your Salesforce Developer Edition organization. 2. Under **All Tabs (+)**, select **Streaming Channels**. If the channel ID field is not visible on the channel list, follow these steps: 1. Click **Create New View**. 2. Type a name for the view in the **Name** input field. 3. In the **Available Fields** list, select **Streaming Channel ID** and click **Add**. You should see the channel ID for each streaming channel in the list. 4. Add any other fields. 5. Click **Save**. The JSON received as a response from the push event operation looks something like this: ```json [ { "userOnlineStatus": {}, "fanoutCount": 0 } ] ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-config-topics) - [Examples](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-examples) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.2 --- # Salesforce Connector 11.2 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce (Salesforce Connector) enables you to create apps that react to Salesforce events such as adding, changing, or deleting objects, topics, documents, and channels. Salesforce Connector enables you to connect to the Salesforce APIs. This connector exposes methods for accessing Salesforce, including working with the [Salesforce Apex classes](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_dev_process_chapter.htm). This connector works with the Salesforce SOAP API, REST API, Bulk API, and Streaming API, depending on the operation you configure. Each API call uses a request/response pattern over an HTTPS connection. All required request headers, error handling, and HTTPS connection configurations are built into the connector. For compatibility information and fixed issues, see the Salesforce Connector release notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce SOAP, REST, Bulk, and Streaming APIs - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Access to the Salesforce target resource, which requires a [Salesforce developer account](https://developer.salesforce.com) and [Salesforce security token](https://help.salesforce.com/s/articleView?language=en_US&id=user_security_token.htm). You can receive a new security token by email if you run **Reset Security Token** through **My Personal Information** from the Salesforce Setup pages. - A consumer key and secret (available in your Salesforce developer account) - The namespace and schema location, if you are using OAuth authentication. If you plan to create the XML for your Mule app, include the correct namespace and schema location in your XML file. Studio adds this information to the XML file automatically when you add Salesforce Connector to a flow in a Mule app. ## Limitations - Salesforce Connector does not expose all possible operations of the Salesforce APIs. - Salesforce Connector does not provide access to the Chatter API or Tooling API. ## Audience - New users Read this document and create your Mule app in [Anypoint Studio](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-studio). The [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-config-topics) topic helps you extend your understanding of the connector. - Advanced users Read [XML and Maven Support](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-xml-maven), the [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-config-topics) topic, and [Examples](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-examples). ## Common Use Cases for the Connector Common use cases for Salesforce Connector include: - **ERP Integration** Give your sales team access to all relevant customer data from one system via real-time synchronization of data between Salesforce and your ERP & finance applications. For example, use Anypoint Connector for SAP (SAP Connector) to sync data between Salesforce and SAP and Anypoint Connector for NetSuite (NetSuite Connector) to sync data between Salesforce and NetSuite. - **Data Aggregation** Collect data from multiple Salesforce orgs, other CRMs, ERP systems, and databases into one Salesforce instance or use that information to generate reports. - **Legacy Modernization** Easily manage data post-acquisition, move off of a legacy CRM system, or migrate ERP data into Salesforce by automatically moving your data into Salesforce. - **Customer Experience** Deliver a consistent, connected customer experience across channels, increase customer satisfaction, and drive revenue growth by integrating Salesforce to applications such as ServiceNow, Marketo, and others. For examples of these use cases, refer to [Salesforce Connector Examples](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-examples). ## Authentication Types Salesforce Connector connections use the following authentication types: - Basic authentication Uses a username and password for authentication - OAuth 2.0 Delegates user authentication to the service hosting the user account - OAuth JWT Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication - OAuth Client Credentials Uses a client ID and client secret for authentication - OAuth SAML Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token - OAuth Username password Uses OAuth 2.0 with a user and password for authentication For information about configuring these authentication types, see [Using Anypoint Studio to Configure Salesforce Connector](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-studio). ## Salesforce Connector Configurations and Examples The following table provides links to specific Salesforce Connector information:
SubjectDescription

Accept and Transform Data

Accept and transform data from Salesforce example

Apex SOAP and REST

Configure for APEX SOAP API and APEX REST API

APIs

List of Salesforce APIs that this connector can access

Application Development

Process order and integration patterns

Batched Data

Batch data using the Salesforce Bulk API

Lead Convert Request ID

Specify a lead ID using DataWeave

Parent Child Relationships

Create and update parent and child relationships example

Anypoint Exchange Templates and Examples

Simplify Salesforce Connector development with a template or example

Subscribe Topic

Subscribe to a Salesforce topic

Subscribe Streaming Channel

Subscribe to a Salesforce streaming channel

Replay Topic

Replay events from a Topic

Replay Streaming Channel

Replay Events from a Salesforce streaming channel

Custom Event Notifications

Get custom event notifications over a streaming channel

Push Event Notifications

Push Events to a Streaming Channel

Object Store Usage

Object Store usage and limitations

## Develop an Application To build an app, perform the following tasks: 1. Configure the connector. 2. Test the connection. 3. Build the rest of your flow. 4. Add and configure DataWeave. When developing an app, Salesforce Connector provides these integration patterns you can use with the Salesforce APIs: - Batch Data Synchronization An external system accesses, changes, deletes, or adds data in Salesforce in batches, and vice versa (Salesforce to external system). - Remote Call-In An external system accesses, changes, deletes, or adds data in Salesforce, and vice versa (Salesforce to external system). - Fire and Forget Remote Process Invocation Salesforce initiates a process in a third-party system and receives an acknowledgment that the process has started. The third-party system continues processing independent of Salesforce. - Request-Reply Remote Process Invocation Salesforce initiates a process in a remote system, waits for the remote system to finish processing, and accepts control returned from the remote system. - User Interface Update Based on Data Changes The Salesforce UI updates in response to a change in a third-party system. ## Salesforce APIs Salesforce Connector works with the Salesforce Apex SOAP API, Apex REST API, Bulk API, Metadata API, and Streaming API, but does not provide access to the Chatter API or the Tooling API. Each API call uses a request/response pattern over an HTTPS connection. All required request headers, error handling, and HTTPS connection configurations are built into the connector. - Apex SOAP API Salesforce [Apex SOAP API](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_api.htm?search_text=soap) exposes Apex class methods as custom SOAP web service calls. This allows an external app to invoke an Apex web service to perform an action in Salesforce. - Apex REST API Salesforce [Apex REST API](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest.htm) creates your own REST-based web services using Apex. This API has all of the advantages of the REST architecture, while adding the ability to define custom logic and including automatic argument or object mapping. - Bulk API Salesforce [Bulk API](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) quickly and securely loads batches of your organization’s data into Salesforce. See also [Load Data in Batches](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-config-topics#batchdata). - Metadata API Salesforce [Metadata API](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_intro.htm) manages customizations and build tools that work with the metadata model, not the data itself. - SOAP API Salesforce [SOAP API](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_quickstart_intro.htm) provides secure access to your organization’s information on Salesforce. Most of the operations that Salesforce Connector performs map to this API. All the Salesforce operations performed through the SOAP API have an optional parameter called `Headers` that can take any of the [Salesforce SOAP headers](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/soap_headers.htm). - Streaming API Salesforce [Streaming API](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/intro_stream.htm) securely receives notifications about changes to your organization’s information in Salesforce. See [Create a Streaming Channel to Receive Data from Salesforce](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-processing-events#createchannel) for more information about the use of the Streaming API. ## Anypoint Exchange Templates and Examples [Anypoint Exchange](https://www.mulesoft.com/exchange/) provides templates you can use as a starting point for your app, as well as examples that illustrate a complete solution. ### Salesforce Connector Templates in Exchange [Anypoint Exchange templates](https://www.mulesoft.com/exchange/?search=salesforce&type=template) provide starting points for Studio projects such as: - Account Broadcast template [Salesforce to Salesforce, Workday, SAP, and database account broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc.wday.sap.db-account-broadcast/) - Aggregation [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-contact-aggregation/), [opportunity](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-aggregation/), [user](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-user-aggregation/) - Bidirectional Sync template - Between Salesforce organizations [accounts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-account-bidirectional-sync/), [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-contact-bidirectional-sync/), [custom objects](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-casecustomobject-bidirectional-sync/), [opportunities](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-bidirectional-sync/), [users](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-user-bidirectional-sync/) - Other sources [database](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2db-account-bidirectional-sync/), [Microsoft Dynamics CRM](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2msdyn-account-bidirectional-sync/), [Siebel](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sieb-account-bidirectional-sync/) - Migration [accounts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-account-migration/), [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-contact-migration/), [opportunities](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-migration/) ### Salesforce Connector Examples in Exchange [Anypoint Exchange examples](https://www.mulesoft.com/exchange/?search=salesforce&type=example) enable you to create complete Studio projects such as: - Batch processing [database](https://www.mulesoft.com/exchange/org.mule.examples/salesforce-to-MySQL-DB-using-Batch-Processing/) and [import leads](https://www.mulesoft.com/exchange/org.mule.examples/import-leads-into-salesforce/) - [Contacts](https://www.mulesoft.com/exchange/org.mule.examples/cache-scope-with-salesforce-contacts/) - [Data retrieval](https://www.mulesoft.com/exchange/org.mule.examples/salesforce-data-retrieval/) - [DataWeave](https://www.mulesoft.com/exchange/org.mule.examples/dataweave-with-flowreflookup/) ## Next Steps After you complete the prerequisites and experiment with templates and examples, you are ready to create an app with [Anypoint Studio](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce APIs: What they are and when to use them](https://developer.salesforce.com/) - [Which Salesforce API should I use?](https://help.salesforce.com/s/articleView?id=integrate_what_is_api.htm&language=en_US&type=5) - [Salesforce Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-connector-release-notes-mule-4) - [Salesforce Connector in Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-salesforce-connector/) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.2 --- # Salesforce Connector 11.2 Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Configure Anypoint Connector for Salesforce (Salesforce Connector) to: - Load data in batches - Specify a Lead ID for a Lead Convert Request operation - Update field values to `null` - Generate an OAuth 2.0 keystore file - Invoke an APEX Rest method ## Load Data in Batches The Salesforce Bulk API loads batches of your organization’s data into Salesforce. Salesforce Connector provides the **Create** and **Create Bulk** operations for working with the Bulk API. For all bulk operations, Salesforce handles the creation process in the background. The connector replies with a `BatchInfo` object, which contains the ID of the batch and the ID of the job it creates to upload the batched objects. In Salesforce, you can track the status of bulk data load jobs and their associated batches by using the job ID for Bulk Data Load Jobs: 1. Click ** Setup > Monitoring > Bulk Data Load Jobs**. 2. Click the job ID to view the job detail page. The job detail page includes a list of all the batches related to the job. The list provides `View Request` and `View Response` links for each batch. If the batch is a CSV file, the links return the request or response in CSV format. If the batch is an XML file, the links return the request or response in XML format. ## Specify a Lead Convert Request ID To specify a lead ID for a `LeadConvertRequest` operation, use a DataWeave transform message. When you use a transform message before the operation, you must add the `leadId` field, because the metadata for the operation doesn’t specify it: ```example ``` ## Update Field Values to Null To set field values to `null`, use an **Update** or **Upsert** request operation and insert the names of the fields you want to nullify in the **Transform Message** component’s **fieldsToNull** field: ![Transform Message properties window for setting a field to null](/mulesoft/current/en-us/salesforce-connector/11.2/_images/salesforce-connector-10-set-fields-to-null.png) Figure 1. Specify the field names you want to nullify in the **Transform Message** component **fieldsToNull** field. ## Generate a Keystore File Salesforce Connector uses the Bouncy Castle cryptographic library to load the certificate from the keystore and sign the payload for the authentication requests. The library has a [vulnerability (CVE-2018-5382)](https://nvd.nist.gov/vuln/detail/CVE-2018-5382) that relates to the BKS-V1 keystore file type. By default, Salesforce Connector uses JKS or PKCS12 keystores. Avoid using BKS-V1 keystore files, as documented in the [Bouncy Castle proposed solution](https://www.kb.cert.org/vuls/id/306792). To generate a JKS keystore file: 1. Go to your Mule workspace and open the command prompt (for Windows) or Terminal (for Mac). 2. Enter this command: ```none keytool -genkeypair -alias salesforce-cert -keyalg RSA -keystore salesforce-cert.jks ``` 3. Enter the following information: - Password for the keystore - Your first name and last name - Your organization unit - Your city and state, and the two-letter code for your country The system generates a Java keystore file (JKS format) that contains a private or public key pair in your workspace. 4. Provide the file path for the keystore in your connector configuration. Enter this command: ```none keytool -exportcert -alias salesforce-cert -file salesforce-cert.crt -keystore salesforce-cert.jks ``` The system exports the public key from the keystore into the workspace. This is the public key to enter in your Salesforce instance. 5. Verify that you have both the keystore (`salesforce-cert.jks`) and the public key (`salesforce-cert.crt`) files in your workspace. ## Invoke APEX Rest Method The Invoke APEX Rest operation enables users to invoke a method from an Apex class that is exposed as a REST service. The following example shows a payload for this operation: ```example ``` In this example: - The `body` element contains `URLParameters`, which is a map containing the parameters that replace the wildcards in the path of the REST resource described in the Apex class. For example, if the REST resource is set to `@RestResource(urlMapping='/myResource/*/mySubResource/*')`, the value of `Parameter1` replaces the first `*`, and the value of `Parameter2` replaces the second `*`. - Key names must start with `Parameter`, followed by a number that shows the position of the `*` to be replaced. - After the `URLParameters` block, provide the content of the `body` value to send to the REST resource, as shown in the example `account` block. - The `headers` and `cookies` fields describe the headers and cookies to pass along with the HTTP request to the desired service. - The `queryParameters` field describes the query parameters to use, and the keys and values in this map that the specified Apex Class must accept. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.2 --- # Salesforce Connector 11.2 Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following examples show several Mule flows for Salesforce Connector: - [Accept and Transform Data](#accandtrans) - [Create or Update an Object in a Parent-Child Relationship](#parentchild) - [Delete Accounts](#delete-accounts) - [Find Duplicate Accounts](#find-duplicate-accounts) ## Accept and Transform Data This example shows how to configure Salesforce Connector to create a new Salesforce account and query new accounts, and to use [File Connector](https://docs.mulesoft.com/file-connector/latest/) to write the new account data to a file. The example contains three flows: - The first flow configures a template for the HTML input form used to provide data for the new account. - The second flow creates a new Salesforce account based on information in the HTML input form. - The third flow queries new accounts by name and writes new account data to a CSV file. ![Accept and transform data flows](/mulesoft/current/en-us/salesforce-connector/11.2/_images/accept-and-transform-data-flows.png) ### Configure the First Flow Configure the first flow that configures an HTML template that provides the data used to create a new account. Creating the first flow involves configuring a **Listener** component and a **Parse Template** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/account` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/account`. #### Add the Parse Template Component Add the **Parse Template** component to create a template for an HTML form (`form.html`), which is located in the main resources folder and is used to convey information for creating a new account: 1. From the **Mule Palette** view, select **Core** and drag a **Parse Template** component to the right of **Listener**. 2. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the component, such as Parse Template.

Location

form.html

The following image shows an example of the **Parse Template** configuration in the properties window: ![Parse Template properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.2/_images/parse-template-properties-window.png) ### Configure the Second Flow Configure the second flow that creates a new Salesforce account based on the data in the HTTP input form. Creating the second flow involves configuring a **Listener** component, a **Transform Message** component, a **Create** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/createAccount` path: 1. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Accept the defaults. 4. In the properties window, set the **Path** field value to `/createAccount`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Create** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [{ Name: payload.Name, AccountNumber: payload.AccountNumber, BillingCity: payload.BillingCity }] ``` #### Add the Create Operation Add the **Create** operation to create a new Salesforce account using the field values passed by the **Transform Message** component: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Create** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Create** configuration of the global element: ![Create global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.2/_images/create-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

You can successfully pass a variable into Type, but there could be an issue when displaying the input metadata if the runtime fails to properly resolve the value of that variable.

Records

payload

The following image shows an example of the **Create** configuration in the properties window: ![Create properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.2/_images/create-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the field values to JSON format so the values can be used with [File Connector](https://docs.mulesoft.com/file-connector/latest/): 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Create**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { id:$.id, errors:$.errors, success:$.success } ``` ### Configure the Third Flow Configure the third flow that queries new Salesforce accounts by name and writes the matching accounts data to a Java file. Creating the third flow involves configuring an **On New Object** source, a **Query result list** operation, a **Query result stream by id** operation, a **Transform Message** component, and a **Write** operation. #### Configure the On New Object Source Configure the **On New Object** source to initiate a Mule flow when a new account is created on the `/account` path: 1. From the **Mule Palette** view, select **Salesforce** and drag the **On New Object** source to the canvas. 2. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

The following image shows an example of the **On New Object** configuration in the properties window: ![On New Object properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.2/_images/on-new-object-properties-window.png) #### Add the Query Result List Operation Add the **Query result list** operation to return a list of result IDs: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Query result list** operation to the right of **On New Object**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Query result list** configuration of the global element: ![Query result list global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.2/_images/query-result-list-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Batch info

payload

The following image shows an example of the **Query result list** configuration in the properties window: ![Query result list properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.2/_images/query-result-list-properties-window.png) #### Add the Query Result Stream by Id Operation Add the **Query result stream by id** operation to obtain the final query results: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Query result stream by id** operation to the right of **Query result list**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Query result stream by id** configuration of the global element: ![Query result stream by id global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.2/_images/query-result-stream-by-id-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Batch info

payload

The following image shows an example of the **Query result stream by id** configuration in the properties window: ![Query result stream by id properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.2/_images/query-result-stream-by-id-properties-window.png) #### Add the Transform Message Component Add the **Transform Message** component to convert the field values to JSON format so the values can be used with [File Connector](https://docs.mulesoft.com/file-connector/latest/): 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Query result stream by id**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { AccountNumber:$.AccountNumber, BillingAddress:$.BillingAddress, Id:$.Id, Name:$.Name } ``` #### Add the Write Operation Add the **Write** operation to write the new account data to a CSV file: 1. From the **Mule Palette** view, select **File** and drag the **Write** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Working Directory

If Connection is selected, the directory to consider the root of every relative path used with this connector. If not provided, it defaults to the value of the user.home system property. If that system property is not set, then the connector fails to initialize.

The following image shows an example of the **Write** configuration of the global element: ![Write global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.2/_images/write-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Path

/account

Content

payload

The following image shows an example of the **Write** configuration in the properties window: ![Write properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.2/_images/write-properties-window.png) ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Create or Update an Object in a Parent-Child Relationship This example shows how to create the object relationship structure in Salesforce needed to perform an upsert using Salesforce Connector. ![Create or Update an Object in a Parent-Child Relationship flow](/mulesoft/current/en-us/salesforce-connector/11.2/_images/create-update-flow.png) ### Configure the Flow A Salesforce object can have standard or custom relationships between objects. The relationships between objects are usually one-to-many (parent-child) relationships, but can be any link between two objects residing in Salesforce. The example uses two custom Salesforce object types that have a parent-child relationship: - `Plane__c`, the parent object that must exist in Salesforce - `Component__c`, the object to upsert using Salesforce Connector The relationship between the two custom objects is represented by a `Plane__r` field whose value is an object with two fields: - The `type` field, which has the referenced object type name as its value. In this example, the value of `type` is `Plane_c`. - A field that identifies the instance of the parent object to reference. In this example, the `Name` field references the `Cobra` instance of `Plane__c`. When you upsert `Component__c`, the POJO sent as input to Salesforce Connector looks like this: ```linenums ---- [{ // Component__c's fields ... Plane__r: { "type": "Plane__c", "Name": "Cobra" } }] ---- ``` Creating the flow involves configuring a **Listener** component, a **Transform Message** component, an **Upsert** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Upsert** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [{ Name: "NewPlaneComponent", Plane__r: { "type": "Plane__c", "Name": "Cobra" } }] ``` #### Add the Upsert Operation Add the **Upsert** operation to create or update a Salesforce object that is in a parent-child relationship: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Upsert** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Upsert** configuration of the global element: ![Upsert global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.2/_images/upsert-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Object type

Component_c

External id field name

Id

Records

payload

The following image shows an example of the **Upsert** configuration in the properties window: ![Upsert properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.2/_images/upsert-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Upsert**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Delete Accounts This example shows how to use Salesforce Connector to delete Salesforce accounts. ![Delete Accounts flow](/mulesoft/current/en-us/salesforce-connector/11.2/_images/delete-accounts-flow.png) ### Configure the Flow Creating the flow involves configuring a **Listener** component, a **Transform Message** component, a **Delete** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Delete** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [payload.Id] ``` #### Add the Delete Operation Add the **Delete** operation to delete Salesforce accounts: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Delete** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Delete** configuration of the global element: ![Delete global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.2/_images/delete-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Records to Delete Ids

payload

The following image shows an example of the **Delete** configuration in the properties window: ![Delete properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.2/_images/delete-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Delete**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { id:$.id, errors:$.errors, success:$.success } ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Find Duplicate Accounts This example shows how to use Salesforce Connector to find duplicate Salesforce accounts. ![Find Duplicate Accounts flow](/mulesoft/current/en-us/salesforce-connector/11.2/_images/find-duplicates-accounts-flow.png) ### Configure the Flow Creating the flow involves configuring a **Listener** component, a **Transform Message** component, a **Find duplicates** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/findDuplicates` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/findDuplicates`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Delete** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [ payload ] ``` #### Add the Find Duplicates Operation Add the **Find duplicates** operation to find duplicate Salesforce accounts: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Find duplicates** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Find duplicates** configuration of the global element: ![Find Duplicates global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.2/_images/find-duplicates-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

Criteria

payload

The following image shows an example of the **Find duplicates** configuration in the properties window: ![Find Duplicates properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.2/_images/find-duplicates-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Find duplicates**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- { success: payload.success, duplicateResults: { (payload.duplicateResults map { matchRecords: $.matchResults } ) }, duplicateRuleEntityType: payload.duplicateRuleEntityType, duplicateRule: payload.duplicateRule, allowSave: payload.allowSave, errorMessage: payload.errorMessage } ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.2 --- # Salesforce Connector 11.2 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt > [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality. > We maintained certain terms to avoid any effect on customer implementations. Anypoint Connector for Salesforce (Salesforce Connector) enables you to accelerate your Salesforce integrations across Sales Cloud, Service Cloud, Salesforce Platform, and Force.com. This connector gives you access to all Salesforce entities to enable automation of your business processes to help maximize your investments in services and solutions, such as enabling your sales teams, increasing revenue, and serving your customers better. ## Configuration Default Configuration for Salesforce Connector.
NameTypeDescriptionDefault ValueRequired

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Read Timeout

Number

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

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

SECONDS

Name

String

Identifier of this element used to reference it in other components.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Fetch All Apex SOAP Metadata

Boolean

If true, DataSense is performed for all Apex classes in the organization. If false, DataSense is performed only for classes in Apex Class Names. If the organization contains many Apex classes, this might cause a ConnectionTimeout during DataSense.

false

Fetch All Apex REST Metadata

Boolean

If true, DataSense is performed for all Apex classes in the organization. If false, DataSense is performed only for classes in Apex Class Names. If the organization contains many Apex classes, this might cause a ConnectionTimeout during DataSense.

false

Apex Class Names

Array of String

List of Apex class names involved in metadata retrieval via DataSense.

Include null values

Boolean

Includes null values in the Apex Rest API request. This parameter applies to the Invoke Apex Rest Method operation only.

false

### Basic Authentication Connection Type Uses a username and a password for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP is allowlisted on Salesforce.

Authorization URL

String

Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, https://login.salesforce.com/services/Soap/u/64.0. Always use lowercase when specifying the protocol (e.g., http, https).

Session Id

String

Value that identifies an active Salesforce session.

Service Endpoint

String

Specifies the service endpoint. This value is used only if the Session Id configuration property is used.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth v2.0 Connection Type Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint. Always use lowercase when specifying the protocol (e.g., http, https).

https://login.salesforce.com/services/oauth2/authorize

Access Token Url

String

URL of the service provider’s access token endpoint. Always use lowercase when specifying the protocol (e.g., http, https).

https://login.salesforce.com/services/oauth2/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after receiving an access token.

Listener Config

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

### OAuth JWT Connection Type Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication. > [!NOTE] Salesforce Connector supports providing a signed certificate only if you use the > `SHA256withRSA` algorithm for the OAuth JWT connection type. You can only enable **JSON Web Token-based access tokens** option on Salesforce server for REST API calls. This option isn’t compatible with Salesforce Connector.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Certificate Alias

String

Alias of the certificate.

Principal

String

Username of the desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

Audience Url

String

URL that identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.

Use the authorization server’s URL for the audience value if implementing for a community: https://login.salesforce.com, https://test.salesforce.com, or https://community.force.com/customers.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth Client Credentials Uses a client ID and client secret for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Client ID

String

The OAuth client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret that corresponds to the client ID.

x

Token URL

String

Service provider’s token endpoint URL. Always use lowercase when specifying the protocol (e.g., http, https).

https://{domain}.my.salesforce.com/services/oauth2/token

Scopes

String

The OAuth scopes to request during the OAuth dance.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

### OAuth Username Password Connection Type Uses OAuth 2.0 with a user and password for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Consumer Secret

String

Your application’s client secret (consumer secret in Remote Access Detail).

x

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP is allowlisted on Salesforce.

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth SAML Connection Type > [!NOTE] OAuth SAML currently uses only Salesforce as an identity provider. Refer to > [Salesforce as a SAML Identity Provider](https://help.salesforce.com/s/articleView?id=xcloud.sso_sfdc_idp_saml_parent.htm&type=5) > to enable Salesforce as an identity provider. Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Certificate Alias

String

Alias of the certificate.

Principal

String

Username of the desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

## Sources - [On Deleted Object](#deleted-object-listener) - [On Modified Object](#modified-object-listener) - [On New Object](#new-object-listener) - [Replay Channel Listener](#replay-channel-listener) - [Replay Topic Listener](#replay-topic-listener) > [!NOTE] The **On Deleted Object**, **On Modified Object**, and **On New Object** sources in > Salesforce Connector use Object Store to save watermarks. You might experience limitations that > are specific to the Object Store implementation you are using (Object Store for CloudHub > deployments or Object Store for on-premises deployments), so configure Object Store to suit your > needs. > For more information, see > [The Different Types of Object Stores Explained](https://help.salesforce.com/s/articleView?id=001123185&type=1). ### On Deleted Object `` Source that adds one or more `whereConditions` in the query calling the method.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### On Modified Object `` Source for modified objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### On New Object `` Source for new objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### Replay Channel Listener `` Source that subscribes to a streaming channel. First, the streaming channel must be published, and after that, a subscription to that streaming channel must be created. Salesforce allows you to subscribe to a nonexistent streaming channel but won’t send you notifications after the topic is created.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Streaming Channel

String

Name of the streaming channel to subscribe to.

x

Cache Events In Memory

Boolean

When the processing flow is slow, cache events in memory to reduce quota consumption.

false

Replay Option

Enumeration, one of:

  • ONLY_NEW

  • ALL

  • FROM_REPLAY_ID

  • FROM_LAST_REPLAY_ID

  • ONLY_NEW: -1

    Subscriber receives new events that are broadcast after the client subscribes.

  • ALL: -2

    Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription.

  • FROM_REPLAY_ID

    Subscriber receives only events that have a replay ID value greater than the specified replay ID.

  • FROM_LAST_REPLAY_ID

    Subscriber uses the highest replay ID stored in the object store regardless of whether it is processed successfully or not.

x

Replay Id

String

Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to ALL or ONLY_NEW.

Replay Failed Events If Any or Resume from Last Replay Id

Boolean

If true, the source starts consuming data with any failed events (if any) or starts consuming data from the last replay ID that is processed successfully.

false

The size (in bytes) of the event queue (DEPRECATED)

Number

In previous versions, this field was used to specify the size of the event queue which can lead to memory issues. Now, the messages are streamed and no buffering is needed.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

true

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Throw Exception When Organization Daily Limit Exceeded

Boolean

Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded.

false

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Attributes

Object

Attributes.

#[message.attributes]

#### Output

Type

Any

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### Replay Topic Listener `` Salesforce stores events for 24 hours and enables you to retrieve stored and new events. Source in which subscribers choose which events to receive by using replay options.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Topic

String

Name of the topic to subscribe to.

x

Cache Events In Memory

Boolean

When the processing flow is slow, cache events in memory to reduce quota consumption.

false

Replay Option

Enumeration, one of:

  • ONLY_NEW

  • ALL

  • FROM_REPLAY_ID

  • FROM_LAST_REPLAY_ID

  • ONLY_NEW: -1

    Subscriber receives new events that are broadcast after the client subscribes.

  • ALL: -2

    Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription.

  • FROM_REPLAY_ID

    Subscriber receives only events that have a replay ID value greater than the specified replay ID.

  • FROM_LAST_REPLAY_ID

    Subscriber uses the highest replay ID stored in the object store regardless of whether it is processed successfully or not.

x

Replay Id

String

Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to ALL or ONLY_NEW.

Replay Failed Events If Any or Resume from Last Replay Id

Boolean

If true, the source starts consuming data with any failed events (if any) or starts consuming data from the last replay ID that is processed successfully.

false

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

true

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Throw Exception When Organization Daily Limit Exceeded

Boolean

Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded.

false

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Attributes

Object

Attributes.

#[message.attributes]

#### Output

Type

Any

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ## Operations > [!NOTE] If you set `LocalDate` for a field in the payload, the input time is automatically > converted to `GMT` or the server’s time zone based on the Gregorian calendar. This conversion > impacts date calculations or comparisons in Salesforce Connector operations, as `LocalDate` is > adjusted to align with the server’s time zone or defaults to GMT. - [Abort Job](#abortJob) - [Abort Job Bulk Api V2](#abortJobBulkApiV2) - [Abort Query Job Bulk Api V2](#abortQueryJobBulkApiV2) - [Batch Info](#batchInfo) - [Batch Info List](#batchInfoList) - [Batch Result](#batchResult) - [Batch Result Stream](#batchResultStream) - [Change Own Password](#changeOwnPassword) - [Close Job](#closeJob) - [Convert Lead](#convertLead) - [Create](#create) - [Create Batch](#createBatch) - [Create Batch For Query](#createBatchForQuery) - [Create Batch Stream](#createBatchStream) - [Create Job](#createJob) - [Create Job Bulk Api V2](#createJobBulkApiV2) - [Create Metadata](#createMetadata) - [Create Query Job Bulk Api V2](#createQueryJobBulkApiV2) - [Delete](#delete) - [Delete Job Bulk Api V2](#deleteJobBulkApiV2) - [Delete Metadata](#deleteMetadata) - [Delete Query Job Bulk Api V2](#deleteQueryJobBulkApiV2) - [Deploy Metadata](#deployMetadata) - [Describe Global](#describeGlobal) - [Describe Metadata](#describeMetadata) - [Describe Sobject](#describeSobject) - [Find Duplicates](#findDuplicates) - [Find Duplicates By Ids](#findDuplicatesByIds) - [Get All Jobs Bulk Api V2](#getAllJobsBulkApiV2) - [Get All Query Jobs Bulk Api V2](#getAllQueryJobsBulkApiV2) - [Get Deleted](#getDeleted) - [Get Job State Bulk Api V2](#getJobStateBulkApiV2) - [Get Query Job Info Bulk Api V2](#getQueryJobInfoBulkApiV2) - [Get Query Job Results Bulk Api V2](#getQueryJobResultsBulkApiV2) - [Get Server Timestamp](#getServerTimestamp) - [Get updated objects](#getUpdated) - [Get User Info](#getUserInfo) - [Invoke Apex Rest Method](#invokeApexRestMethod) - [Invoke Apex Soap Method](#invokeApexSoapMethod) - [Job Info](#jobInfo) - [List Metadata](#listMetadata) - [Merge](#merge) - [Merge Multiple](#mergemultiple) - [Publish Platform Event Message](#publishPlatformEventMessage) - [Publish Streaming Channel](#publishStreamingChannel) - [Publish Topic](#publishTopic) - [Push Generic Event](#pushGenericEvent) - [Query (Deprecated)](#query) - [Query All](#queryAll) - [Query Result List](#queryResultList) - [Query Result Stream By Id](#queryResultStreamById) - [Query Xml Stream](#queryXmlStream) - [Read Metadata](#readMetadata) - [Rename Metadata](#renameMetadata) - [Reset Password](#resetPassword) - [Retrieve](#retrieve) - [Retrieve Job Failed Results Bulk V2](#retrieveJobFailedResultsBulkV2) - [Retrieve Job Successful Results Bulk V2](#retrieveJobSuccessfulResultsBulkV2) - [Retrieve Job Unprocessed Results Bulk V2](#retrieveJobUnprocessedResultsBulkV2) - [Retrieve Metadata](#retrieveMetadata) - [Search](#search) - [Set Password](#setPassword) - [Unauthorize](#unauthorize) - [Update](#update) - [Update Metadata](#updateMetadata) - [Upsert](#upsert) - [Upsert Metadata](#upsertMetadata) ### Abort Job `` Aborts an open job given its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID that identifies the job to abort.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Abort Job Bulk Api V2 `` Aborts an ongoing Bulk API v2 Job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Abort Query Job Bulk Api V2 `` Abort the indicated query job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job to abort.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job Info

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Info `` Accesses the latest BatchInfo of a submitted BatchInfo. Enables you to track the execution status.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo that is monitored.

#[payload]

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Info List `` Gets information about all batches in a job.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job Id

String

ID of the job to retrieve batch information for.

x

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Result `` Accesses `com.sforce.async.BatchResult` of a submitted BatchInfo.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch To Retrieve

com.sforce.async.BatchInfo that is monitored.

#[payload]

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Result Stream `` Accesses `com.sforce.async.BatchResult` of a submitted BatchInfo.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch To Retrieve

com.sforce.async.BatchInfo that is monitored.

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Change Own Password `` Changes the password of the user linked to the connector’s configuration.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Old Password

String

Old password to change.

x

New Password

String

New password to change.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Close Job `` Closes an open job given its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID identifying the job to close.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Convert Lead `` Converts a lead into an account, contact, or (optionally) an opportunity.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Lead Convert Request

Information for lead conversion.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Lead Convert Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Create `` Adds one or more new records to your organization’s data. > [!IMPORTANT] When you map your objects to the input of this message processor, the objects must > match the expected type of the object at Salesforce. For example, if you set the **CloseDate** > field of an opportunity to a string of value `2011-12-13`, it is sent to Salesforce as a string. > The operation is rejected because the CloseDate is not of the expected type. The correct way to > map it is to generate a Java Date object. You can do so using the Groovy expression evaluator as > `#[groovy:Date.parse("yyyy-MM-dd", "2011-12-13")]`.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to add.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Create Batch `` Creates a batch using the given objects within the specified Job. The job can be of XML or CSV type. This call uses the Bulk API. This operation is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

com.sforce.async.JobInfo in which the batch is created. The job can be of XML, JSON, or CSV type.

x

SObjects

Array of Object

List of one or more SObject objects.

#[payload]

SObject Max Depth

Number

Asynchronous SObject recursive MAX_DEPTH check.

5

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Batch For Query `` Creates a batch using the given query. This call uses the Bulk API. This operation is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

JobInfo in which the batch is created.

x

Query

String

Query to execute.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Batch Stream `` Creates a batch using the given stream within the specified job. The stream can have a CSV, XML, ZIP\_CSV, or ZIP\_XML format. This call uses the Bulk API and is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

JobInfo in which the batch is created.

#[payload]

x

Stream

Any

Stream containing the data. The stream can have a CSV, XML, ZIP_CSV, or ZIP_XML format.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Job `` Creates a job to perform one or more batches through Bulk API operations.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

  • queryAll

OperationEnum that is executed by the job.

x

Type

String

Type of Salesforce object that the job processes.

x

Create Job Request

Creates the job request.

If you input the value in literal mode, an example value is:

{
    “externalIdFieldName”: “employeeId”,
    “contentType”: “XML”,
    “concurrencyMode”: “Serial”
}

If you input the value in expression mode, then the input can be dynamic using output application/json or output application/java, and can be transformed into the required input.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Job Bulk Api V2 `` Creates a Bulk API v2 job containing the data to insert, update, delete, or upsert. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Type of object to work with.

x

sObjects

Binary

Array of one or more SObject objects.

#[payload]

Operation

Enumeration, one of:

  • insert

  • update

  • delete

  • hardDelete

  • upsert

Operation to execute.

x

Line Ending

String

Line ending of CSV data.

LF

Column Delimiter

String

Column delimiter of CSV data.

COMMA

Assignment Rule Id

String

ID of an assignment rule to run for a case or a lead. The assignment rule can be active or inactive.

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the ID lookup field property for standard objects.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Salesforce headers. For information, see Create a Job in the Salesforce documentation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Metadata `` Adds one or more new metadata components to your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type to create.

x

Metadata Objects

Array of Object

List of Map<String,Object> representing the metadata to create.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Create Query Job Bulk Api V2 `` Creates a query job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Query

String

Query used to create the job.

x

Operation

Enumeration, one of:

  • QUERY

  • QUERY_ALL

Operation used.

QUERY

Column Delimiter

String

Type of delimiter used.

COMMA

Line Ending

String

Line ending used.

CRLF

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Salesforce headers. For information, see Create a Query Job in the Salesforce documentation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job State

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Delete `` Deletes one or more records from your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Records To Delete Ids

Array of String

Array of one or more IDs associated with the objects to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Delete Job Bulk Api V2 `` Deletes a Bulk API v2 Job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Delete Metadata `` Deletes one or more metadata components from your organization, given the API name of the objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to delete.

x

Full Names

Array of String

Full names of the components to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Delete Query Job Bulk Api V2 `` Deletes a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Deploy Metadata `` A file-based call to deploy XML components. Use this operation to take file representations of components and deploy them into an organization by creating, updating, or deleting the components they represent.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Deploy Metadata Request

Data needed by this operation.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Global `` Retrieves a list of available objects for your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe Global Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Metadata `` Retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other components.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Sobject `` Describes metadata (field list and object properties) for the specified object.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Object. The specified value must be a valid object for your organization. For a complete list of objects, see Standard Objects.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe S Object Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Find Duplicates `` Performs rule-based searches for duplicate records. The input is an array of Salesforce objects, each of which specifies the values to search for and the type of object that supplies the duplicate rules. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the values to do the search. The output identifies the detected duplicates for each SObject.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of SObjects to find duplicates for.

x

Criteria

Array of Object

List of SObjects used as a criterion when searching for duplicates.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Find Duplicates Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Find Duplicates By Ids `` Performs rule-based searches for duplicate records. The input is an array of IDs, each of which specifies the records for which to search for duplicates. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the record IDs to do the search. The output identifies the detected duplicates for each ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Ids List

Array of String

List of IDs to find duplicates.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Find Duplicates Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get All Jobs Bulk Api V2 `` Retrieves all Bulk jobs. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Desired concurrency mode.

Parallel

Pk Chunking

Boolean

Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Bulk Job V2 Result

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get All Query Jobs Bulk Api V2 `` Retrieves all Bulk query jobs.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Pk Chunking

Boolean

Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Job Type

Enumeration, one of:

  • BigObjectIngest

  • Classic

  • V2Query

Job type.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Desired concurrency mode.

Parallel

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Query Jobs Info Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Deleted `` Retrieves the list of records deleted from a particular time in the past (specified in minutes).
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type. The specified value must be a valid object for your organization.

x

Start Date

DateTime

Starting date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

x

End Date

DateTime

Ending date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC).

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get Deleted Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get Job State Bulk Api V2 `` Gets the state of a v2 Bulk job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Query Job Info Bulk Api V2 `` Returns the details of a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Query Job Results Bulk Api V2 `` Returns the results of a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Max Records Per Page

Number

Number of records that are on each page retrieved from the API. This number influences the number of API requests and the memory used by the connector to handle the results.

Salesforce Connector automatically handles pagination and retrieves all pages before the next processing job starts.

2000

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Server Timestamp `` Retrieves the current system timestamp, in Coordinated Universal Time (UTC), from the API.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

DateTime

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get updated objects `` Retrieves the list of individual records that are created or updated between the specified start and end date.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type. The specified value must be a valid object for your organization.

x

Start Date

DateTime

Starting date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

x

End Date

DateTime

Ending date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If a value is not provided, the current server time is used.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get Updated Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get User Info `` Retrieves personal information for the user associated with the current session.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get User Info Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Invoke Apex Rest Method `` Invokes any operation from an Apex class that is exposed as a REST web service.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Request

Object

Object containing request information, some of which can include object queryParams with key-value pairs. These parameters are passed as URL parameters to the Apex Rest endpoint, for example:

queryParams: {AccountId : "a0w0E0000069MDxQAM" , ContactId: "0030E00000rRSJ6QAO" }

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Apex Class Name

String

Apex class name.

x

Apex Class Method Name

String

Apex class method name. The method name format is:

ApexMethodName^RestResourceURL^HttpMethod^OutputType^InputParameterName1=ParameterType1,InputParameterName2=ParameterType2

For example:

getAccountInfo^/accountInfo/*^HttpGet^void

Special characters aren’t allowed in ApexMethodName.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Invoke Apex Soap Method `` Invokes any operation from an Apex class that is exposed as a SOAP web service.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Input

Binary

InputStream with XML that contains information about the method to invoke and its parameters. The XML must adhere to the WSDL standards.

#[payload]

Apex Headers

Object

Parameters specifying the SOAP Headers to send to the API. For more information about the supported headers, see SOAP API and SOAP Headers for Apex.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Apex Class Name

String

Apex class name.

x

Apex Class Method Name

String

Apex class method name.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Job Info `` Accesses the latest JobInfo of a submitted JobInfo ID. This operation enables you to track the execution status.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID of the job that is monitored.

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### List Metadata `` Retrieves property information about metadata components in your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type used as a criterion when querying for information.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of File Properties

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Merge `` Merges up to three records into one record.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Records To Merge Ids

Array of String

List of IDs of the objects to merge.

#[payload]

Type

String

Type of record to merge.

x

Master Record

Object

Must provide the ID of the object that other records are merged into. Optionally, provide the fields to update and their values.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Merge Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Merge Multiple `` Combines up to three records of the same type into one record. The input is an array of MergeRequest elements, each of which specifies the records to combine. #### Limitations - The only supported object types are: - Lead - Contact - Account - Person Account - Individual Only objects of the same type can be merged. For example, merge leads only with leads. - The **Merge Multiple** operation enables you to specify a list of a maximum of 200 merge requests. - A merge request can contain a maximum of three IDs: - The master record ID - Up to two IDs for the records to merge into the primary record
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

List of Merge Records

Array of Merge Record

List of merge records. Each merge record contains the primary record, the record to merge IDs into, and an optional additional information map.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Map<String, Object>

Declares the request headers to use with this operation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Merge Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Platform Event Message `` Adds one new platform event to your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Platform Event name

String

Name of the platform event to create.

x

Platform Event Message

Array of Object

List<PlatformEventMessage> to create.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Streaming Channel `` Creates a streaming channel in which generic, custom messages are pushed.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Channel name

String

Descriptive name of the streaming channel. Limit of 80 characters, and must start with /u/. This value identifies the channel and must be unique.

x

Owner Id

String

Identifier for the channel owner.

Description

String

Description of what kinds of records are returned by the query. Limit of 255 characters.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Topic `` Creates a topic representing a query that is used to notify listeners when changes are made to records in an organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Topic Name

String

Topic name.

x

Query

String

Query name.

x

Description

String

Description.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Push Generic Event `` Pushes generic streaming custom events to the specified streaming channel.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Events

Event list.

#[payload]

Channel Id

String

Streaming channel name.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Push Event Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query (Deprecated) `` Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are strings and, if necessary, you can convert them to the appropriate type, for example, by using DataWeave and **Transform Message**. The **Query** operation is now deprecated. Use the [**Query Xml Stream**](#queryXmlStream) operation instead.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query All `` Retrieves data from specified objects, whether or not they have been deleted.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query Result List `` Returns a list of result IDs for a specific batch. If the batch requires retries, there is more than one element in the output. Use this operation with [Query Result Stream By Id](#queryResultStreamById) to obtain the results of the query.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo to retrieve the results for.

#[payload]

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation.

XML

Output Mime Type

String

MIME type of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of a variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of String

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Query Result Stream By Id `` Returns an InputStream with the query results for a specific result ID of a submitted BatchInfo. Obtain the result IDs first by using the [Query Result List](#queryResultList) operation.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo that returns the result ID.

#[payload]

x

Result ID

String

Result ID obtained with Query Result List.

x

Output Mime Type

String

MIME type of the payload output of this operation.

Output Encoding

String

Encoding of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configure how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of a variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Binary

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Query Xml Stream `` Executes a query against the specified object and returns data that matches the specified criteria. This operation returns paginated results. Each result is an InputStream of XML records.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Output Mime Type

String

MIME type of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Headers

Object

Headers to include in the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of String payload and Void attributes

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Read Metadata `` Returns one or more metadata components from your organization, given the objects' API names.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to read.

x

Full Names

Array of String

List of full names of the components to read.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Rename Metadata `` Renames a metadata component in your organization, given its old API name and the new name.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the component to rename.

x

Old Full Name

String

Current component full name.

x

New Full Name

String

New component full name.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Reset Password `` Resets the password of the user corresponding to the provided user ID, or the user linked to the connector’s configuration, if the user ID field is null.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User to reset the password for. If unspecified, the current user is used.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Reset Password Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Retrieve `` Retrieves one or more records based on the specified IDs.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to retrieve.

x

Retrieve Request

Must provide the IDs and specify the fields for the records to retrieve.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Retrieve Job Failed Results Bulk V2 `` Gets the status of the failed processed SObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Job Failed Record Results

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Job Successful Results Bulk V2 `` Gets the status of the successfully processed SObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Job Successful Record Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Job Unprocessed Results Bulk V2 `` Gets the status of the unprocessed sObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Metadata `` Retrieves XML file representations of components in an organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Package Names

Array of String

List of package names to retrieve. If you are retrieving only unpackaged components, do not specify a name. You can retrieve packaged and unpackaged components in the same retrieval operation.

Specific Files

Array of String

List of file names to retrieve. If a value is specified for this property, Package Names must be set to null.

Unpackaged

Binary

Stream containing a list of components to retrieve that are not in a package.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Binary

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Search `` Searches for objects using Salesforce Object Search Language (SOSL). Mimics using the search box inside the Salesforce UI.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Search String

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Search Language (SOSL).

x

Parameters

Object

Map with values for placeholders in Search String.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Search Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Set Password `` Changes the password of a user or a self service user to a value that you specify.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User to set the password for.

x

New Password

String

New password for the user.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Unauthorize `` Deletes all of the access token information of a given resource owner ID so that it is impossible to execute an operation for that user without performing the OAuth dance.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner for whom to invalidate access.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

#### Associated Configurations - [Configuration](#sfdc-config) ### Update `` Updates one or more existing records in your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to update.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Update Metadata `` Updates one or more metadata components in your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to update.

x

Metadata Objects

Array of Object

List of Map<String, Object> representing the metadata to update.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Upsert `` Upserts a homogeneous list of objects. Creates new records and updates existing records using a custom field to determine the presence of existing records. In most cases, use `#upsert(String, String, List, Map)` over `#create(String, List, Map)` to avoid creating unwanted, duplicate records. > [!NOTE] Although you cannot change the **Content Type** value for a bulk upsert, you can use the > [**Create Job**](#createJob) operation to set the content type to CSV (or zipped CSV if you reach > the character limit) and then follow up with the [**Create Batch**](#createBatch) operation.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Type of record to upsert.

x

External Id Field Name

String

Either of the following:

  • For a custom object, the name of the field that contains the external ID field name

  • For a standard object, the name of the field that contains the ID lookup field name

Unless you configure the External Id Field Name field for the SObject to upsert, the Upsert operation fails.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Upsert Metadata `` Creates or updates one or more metadata components in your organization. For a picklist field in an object, the **Upsert Metadata** operation updates only the picklist mapping for that specific object. To update the actual picklist values, such as adding or removing values in the picklist, use the [**Deploy Metadata**](#deployMetadata) operation. You must perform a metadata deploy for **Custom Field** or **Global Picklist** based on whether the picklist is tied to a custom field or is a global picklist.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to create or update.

x

Metadata Objects

Array of Object

List of Map<String, Object> representing the metadata to upsert.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Upsert Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ## Object Types - [Action Override](#ActionOverride) - [Additional Information Map](#AdditionalInformationMap) - [Batch Info](#BatchInfo) - [Bulk Item](#BulkItem) - [Bulk Job State](#BulkJobState) - [Bulk Job V2 Result](#BulkJobV2Result) - [Bulk Operation Result](#BulkOperationResult) - [Child Relationship](#ChildRelationship) - [Create Job Request](#CreateJobRequest) - [CRL File](#crl-file) - [Cron](#cron) - [Custom OCSP Responder](#custom-ocsp-responder) - [Deleted Record](#DeletedRecord) - [Deploy Metadata Request](#DeployMetadataRequest) - [Describe Global Result](#DescribeGlobalResult) - [Describe Global S Object Result](#DescribeGlobalSObjectResult) - [Describe Metadata Object](#DescribeMetadataObject) - [Describe Metadata Result](#DescribeMetadataResult) - [Describe S Object Result](#DescribeSObjectResult) - [Duplicate Result](#DuplicateResult) - [Entity Search Metadata](#EntitySearchMetadata) - [Error](#Error) - [Error Mapping](#ErrorMapping) - [Expiration Policy](#ExpirationPolicy) - [Field](#Field) - [Field Diff](#FieldDiff) - [Field Level Search Metadata](#FieldLevelSearchMetadata) - [File Properties](#FileProperties) - [Filtered Lookup Info](#FilteredLookupInfo) - [Find Duplicates Result](#FindDuplicatesResult) - [Fixed Frequency](#fixed-frequency) - [Generic Streaming Event](#GenericStreamingEvent) - [Get Deleted Result](#GetDeletedResult) - [Get Updated Result](#GetUpdatedResult) - [Get User Info Result](#GetUserInfoResult) - [Job Failed Record Results](#JobFailedRecordResults) - [Job Info](#JobInfo) - [Job Successful Record Result](#JobSuccessfulRecordResult) - [Job Unprocessed Record Result](#JobUnprocessedRecordResult) - [Keystore](#KeyStore) - [Labels Search Metadata](#LabelsSearchMetadata) - [Lead Convert Result](#LeadConvertResult) - [Lead Convert Request](#LeadConvertRequest) - [Match Record](#MatchRecord) - [Match Result](#MatchResult) - [Merge Record](#MergeRecord) - [Merge Result](#MergeResult) - [Metadata Result](#MetadataResult) - [Name Value Pair](#NameValuePair) - [Named Layout Info](#NamedLayoutInfo) - [Non-Repeatable Stream](#non-repeatable-stream) - [Pick List Entry](#PickListEntry) - [Proxy](#ProxyConfiguration) - [Push Event Result](#PushEventResult) - [Query Job Info](#QueryJobInfo) - [Query Job State](#QueryJobState) - [Query Jobs Info Result](#QueryJobsInfoResult) - [Reconnect](#reconnect) - [Reconnect Forever](#reconnect-forever) - [Reconnection](#reconnection) - [Record Type Info](#RecordTypeInfo) - [Redelivery Policy](#RedeliveryPolicy) - [Redelivery Policy Message Identifier](#RedeliveryPolicyMessageIdentifier) - [Repeatable File Store Iterable](#repeatable-file-store-iterable) - [Repeatable File Store Stream](#repeatable-file-store-stream) - [Repeatable In Memory Iterable](#repeatable-in-memory-iterable) - [Repeatable In Memory Stream](#repeatable-in-memory-stream) - [Reset Password Result](#ResetPasswordResult) - [Result](#Result) - [Retrieve Request](#RetrieveRequest) - [Search Record](#SearchRecord) - [Search Record Metadata](#SearchRecordMetadata) - [Search Result](#SearchResult) - [Search Results Metadata](#SearchResultsMetadata) - [Search Snippet](#SearchSnippet) - [Simple Error](#SimpleError) - [Standard Revocation Check](#standard-revocation-check) - [TLS](#Tls) - [Truststore](#TrustStore) - [Upsert Metadata Result](#UpsertMetadataResult) ### Action Override Action override.
FieldTypeDescriptionDefault ValueRequired

Available In Touch

Boolean

Indicates whether available in touch or not.

From Factor

String

From factor.

Name

String

Name.

Page Id

String

Page ID.

Url

String

URL.

### Additional Information Map Additional information map.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name of the map.

Value

String

Value of the map.

### Batch Info Batch information.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Created Date

DateTime

Date created.

Id

String

ID name.

Job Id

String

Job ID.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

State

Enumeration, one of:

  • Queued

  • InProgress

  • Completed

  • Failed

  • NotProcessed

State.

State Message

String

State message.

System Modstamp

DateTime

System modstamp.

Total Processing Time

Number

Total processing time.

### Bulk Item Bulk item.
FieldTypeDescriptionDefault ValueRequired

Exception

Any

Exception.

Id

Any

ID.

Message

String

Message.

Payload

Payload.

Status Code

String

Status code.

Successful

Boolean

Determines if successful or not.

### Bulk Job State Bulk job state.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Api Version

Number

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Error Message

String

Error message.

External Id Field Name

String

External ID field name.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

Object

String

Object.

Operation

String

Operation name.

Retries

Number

Number of retries.

State

String

State.

System Modstamp

String

System modstamp.

Total Processing Time

Number

Total processing time.

### Bulk Job V2 Result Bulk job v2 result.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Content Url

String

Content URL.

Created By Id

String

Created by ID.

Created Date

String

Date created.

External Id Field Name

String

External ID field name.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Bulk Operation Result Bulk operation result.
FieldTypeDescriptionDefault ValueRequired

Id

Any

ID.

Items

Array of Bulk Item

Array of the Bulk Item type.

Successful

Boolean

Determines if successful or not.

### Child Relationship Child relationship.
FieldTypeDescriptionDefault ValueRequired

Cascade Delete

Boolean

Cascade delete.

Child S Object

String

Child SObject.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Field

String

Field.

Junction Id List Names

Array of String

Junction ID list names.

Junction Reference To

Array of String

Junction reference to.

Relationship Name

String

Relationship name.

### Create Job Request Create job request.
FieldTypeDescriptionDefault ValueRequired

External Id Field Name

String

Name of the field on this object. Use this attribute for custom objects or the ID lookup field property for standard objects (only required for upsert operations).

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type for the job results.

When specifying a content type different from XML for a query type, use the queryResultStream(BatchInfo) method to retrieve results.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Concurrency mode of the job.

### CRL File Specifies the location of the certification revocation list (CRL) file.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the CRL file.

### Cron CRON.
FieldTypeDescriptionDefault ValueRequired

Expression

String

Cron expression.

x

Time zone

String

ID of the time zone on which to base the expression. Refer to the java.util.TimeZone Javadoc for the format and valid values for this ID.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.
FieldTypeDescriptionDefault ValueRequired

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

### Deleted Record Deleted record.
FieldTypeDescriptionDefault ValueRequired

Deleted Date

DateTime

Deleted date.

Id

String

ID name.

### Deploy Metadata Request Deploy metadata request.
FieldTypeDescriptionDefault ValueRequired

Stream

Binary

Stream containing the data. This parameter defaults to the payload content.

x

Ignore Warnings

Boolean

If true, a warning allows a deployment to complete successfully.

false

Purge On Delete

Boolean

If true, the deleted components in the destructiveChanges.xml manifest file are not stored in the Recycle Bin. This option only works in the Developer Edition or in sandbox organizations; it does not work in production organizations.

false

Rollback On Error

Boolean

If true, failures cause a complete rollback.

true

### Describe Global Result Describe global result.
FieldTypeDescriptionDefault ValueRequired

Encoding

String

Encoding.

Max Batch Size

Number

Maximum batch size.

Sobjects

SObject results.

### Describe Global S Object Result Describe global SObject results.
FieldTypeDescriptionDefault ValueRequired

Activateable

Boolean

Indicates whether activateable or not.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Custom Setting

Boolean

Indicates whether there is a custom setting or not.

Deletable

Boolean

Indicates whether deletable or not.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Feed Enabled

Boolean

Indicates whether the feed is enabled.

Key Prefix

String

Key prefix.

Label

String

Label.

Label Plural

String

Label plural.

Layoutable

Boolean

Indicates whether layoutable or not.

Mergeable

Boolean

Indicates whether mergeable or not.

Mru Enabled

Boolean

Indicates whether MRU is enabled or not.

Name

String

Name.

Queryable

Boolean

Indicates whether queryable or not.

Replicateable

Boolean

Indicates whether replicateable or not.

Retrieveable

Boolean

Indicates whether retrieveable or not.

Searchable

Boolean

Indicates whether searchable or not.

Triggerable

Boolean

Indicates whether triggerable or not.

Undeleteable

Boolean

Indicates whether undeleteable or not.

Updateable

Boolean

Indicates whether updateable or not.

### Describe Metadata Object Describe metadata object.
FieldTypeDescriptionDefault ValueRequired

Child Xml Names

Array of String

Child XML names.

Directory Name

String

Directory name.

In Folder

Boolean

Indicates whether the metadata object is in the folder.

Meta File

Boolean

Indicates whether the metadata object is a meta file.

Suffix

String

Suffix.

Xml Name

String

XML name.

### Describe Metadata Result Describe metadata result.
FieldTypeDescriptionDefault ValueRequired

Metadata Objects

Metadata objects.

Organization Namespace

String

Organization namespace.

Partial Save Allowed

Boolean

Indicates whether partial save is allowed.

Test Required

Boolean

Indicates whether a test is required.

### Describe S Object Result Describe SObject result.
FieldTypeDescriptionDefault ValueRequired

Action Overrides

Action overrides.

Activateble

Boolean

Indicates whether activateable or not.

Child Relationships

Child relationships.

Compact Layoutable

Boolean

Compact layoutable.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Custom Setting

Boolean

Indicates whether there is a custom setting or not.

Deletable

Boolean

Indicates whether deletable or not.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Feed Enabled

Boolean

Indicates whether the feed is enabled.

Fields

Array of Field

Fields.

Key Prefix

String

Key prefix.

Label

String

Label.

Label Plural

String

Label plural.

Layoutable

Boolean

Indicates whether layoutable or not.

Mergeable

Boolean

Indicates whether mergeable or not.

Mru Enabled

Boolean

Indicates whether MRU is enabled or not.

Name

String

Name.

Named Layout Infos

Named layout information.

Network Scope Field Name

String

Network scope field name.

Queryable

Boolean

Indicates whether queryable or not.

Record Type Infos

Record type information.

Replicateable

Boolean

Indicates whether replicateable or not.

Retrieveable

Boolean

Indicates whether retrieveable or not.

Search Layoutable

Boolean

Indicates whether the search is layoutable or not.

Searchable

Boolean

Indicates whether searchable or not.

Triggerable

Boolean

Indicates whether triggerable or not.

Undeleteable

Boolean

Indicates whether undeleteable or not.

Updateable

Boolean

Indicates whether updateable or not.

Url Detail

String

URL detail.

Url Edit

String

URL edit.

Url New

String

URL new.

### Duplicate Result Duplicate result.
FieldTypeDescriptionDefault ValueRequired

Allow Save

Boolean

Determines whether to allow saving or not.

Duplicate Rule

String

Duplicate rule.

Duplicate Rule Entity Type

String

Duplicate rule entity type.

Error Message

String

Error message.

Match Results

Array of Match Result

Match results.

### Entity Search Metadata Entity search metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Name

String

Entity name.

Field Metadata

Field metadata.

### Error Error.
FieldTypeDescriptionDefault ValueRequired

Duplicate Result

Duplicate result.

Fields

Array of String

Fields.

Message

String

Message.

Status Code

String

Status code.

### Error Mapping Error mapping.
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Source.

Target

String

Target.

x

### Expiration Policy Configures an expiration policy strategy.
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

### Field Field.
FieldTypeDescriptionDefault ValueRequired

Autonumber

Boolean

Indicates autonumber.

Byte Length

Number

Byte length.

Calculated

Boolean

Indicates whether calculated or not.

Case Sensitive

Boolean

Indicates whether case sensitive or not.

Controller Name

String

Controller name.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Default Value

Any

Default value.

Default Value Formula

String

Default value formula.

Defaulted On Create

Boolean

Indicates whether defaulted on create.

Dependent Pick List

Boolean

Indicates whether dependent pick list or not.

Deprecate And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Digits

Number

Digits.

Display Location In Decimal

Boolean

Indicates whether the display location is in decimal.

Encrypted

Boolean

Indicates whether encrypted or not.

Extra Type Info

String

Extra type information.

Field Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INT

  • DOUBLE

  • DATE

  • DATETIME

  • TIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANYTYPE

  • DATACATEGORYGROUPREFERENCE

  • ENCRYPTEDSTRING

  • ADDRESS

  • COMPLEXVALUE

  • LOCATION

  • JSON

  • LONG

Field type.

Filterable

Boolean

Indicates whether filterable or not.

Filtered Lookup Info

Filtered lookup information.

Formula

String

Formula.

Groupable

Boolean

Indicates whether groupable or not.

High Scale Number

Boolean

Indicates whether high scale number or not.

Html Formatted

Boolean

Indicates whether HTML formatted or not.

Id Lookup

Boolean

Indicates ID lookup.

Inline Help Text

String

Inline help text.

Label

String

Label.

Length

Number

Length.

Mask

String

Mask.

Mask Type

String

Mask type.

Name

String

Name.

Name Field

Boolean

Indicates name field.

Name Pointing

Boolean

Indicates name pointing.

Nullable

Boolean

Indicates whether nullable or not.

Permissinable

Boolean

Indicates whether permissionable or not.

Picklist Values

Picklist values.

Polymorphic Foreign Key

Boolean

Indicates polymorphic foreign key.

Precision

Number

Precision.

Reference Target Field

String

Reference target field.

Reference To

Array of String

Reference to.

Relationship Name

String

Relationship name.

Relationship Order

Number

Relationship order.

Required

Boolean

Indicates whether required or not.

Restricted Picklist

Boolean

Indicates whether restricted picklist or not.

Scale

Number

Scale.

Search Filterable

Boolean

Indicates whether search filterable or not.

Sortable

Boolean

Indicates whether sortable or not.

Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INT

  • DOUBLE

  • DATE

  • DATETIME

  • TIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANYTYPE

  • DATACATEGORYGROUPREFERENCE

  • ENCRYPTEDSTRING

  • ADDRESS

  • COMPLEXVALUE

  • LOCATION

  • JSON

  • LONG

Type.

Unique

Boolean

Indicates whether unique or not.

Updateable

Boolean

Indicates whether updateable or not.

Write Requires Master Read

Boolean

Indicates whether write requires master read or not.

### Field Diff Field difference.
FieldTypeDescriptionDefault ValueRequired

Difference

Enumeration, one of:

  • DIFFERENT

  • NULL

  • SAME

  • SIMILAR

Field differences.

Name

String

Name of the field.

### Field Level Search Metadata Field level search metadata.
FieldTypeDescriptionDefault ValueRequired

Label

String

Label.

Name

String

Name.

Type

String

Type.

### File Properties File properties.
FieldTypeDescriptionDefault ValueRequired

Created By

String

Created by.

Created By Name

String

Created by name.

Created Date

DateTime

Date created.

File Name

String

File name.

Full Name

String

Full name.

Id

String

ID name.

Last Modified By Id

String

Last modified by ID.

Last Modified By Name

String

Last modified by name.

Last Modified Date

String

Last modified date.

Manageable State

Enumeration, one of:

  • released

  • deleted

  • deprecated

  • installed

  • beta

  • unmanaged

Manageable state.

Namespace Prefix

String

Namespace prefix.

Type

String

Type.

### Filtered Lookup Info Filtered lookup information.
FieldTypeDescriptionDefault ValueRequired

Controlling Fields

Array of String

Controlling fields.

Dependent

Boolean

Indicates dependent or not.

Optional Filter

Boolean

Indicates optional filter or not.

### Find Duplicates Result Find duplicates result.
FieldTypeDescriptionDefault ValueRequired

Duplicate Results

Duplicate results.

Errors

Array of Error

Errors.

Success

Boolean

Determines if successful or not.

### Fixed Frequency Fixed frequency.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

Frequency at which the scheduler initiates the flow, based on the time unit specified in the Time Unit field.

1000 (MILLISECONDS)

x

Start delay

Number

Amount of time that the scheduler waits before initiating the flow for the first time after the app starts. This value is based on the time unit specified in the Time Unit field.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Frequency and Start delay fields.

MILLISECONDS

### Generic Streaming Event Generic streaming event.
FieldTypeDescriptionDefault ValueRequired

Payload

String

Payload.

User Ids

Array of String

User IDs.

### Get Deleted Result Get deleted result.
FieldTypeDescriptionDefault ValueRequired

Deleted Records

Deleted records.

Earliest Date Available

DateTime

Earliest date available.

Latest Date Covered

DateTime

Latest date covered.

### Get Updated Result Get updated result.
FieldTypeDescriptionDefault ValueRequired

Ids

Array of String

IDs.

Latest Date Covered

DateTime

Latest date covered.

### Get User Info Result Get user information result.
FieldTypeDescriptionDefault ValueRequired

Accessibility Mode

Boolean

Indicates accessibility mode.

Currency Symbol

String

Currency symbol.

Org Attachment File Size Limit

Number

Organization attachment file size limit.

Org Default Currency Iso Code

String

Organization default currency ISO code.

Org Default Currency Locale

String

Organization default currency locale.

Org Disallow Html Attachments

Boolean

Indicates whether the organization disallows HTML attachments.

Org Has Person Accounts

Boolean

Indicates whether the organization contains person accounts.

Organization Id

String

Organization ID.

Organization Multi Currency

Boolean

Organization multicurrency.

Organization Name

String

Organization name.

Profile Id

String

Profile ID.

Role Id

String

Role ID.

Session Seconds Valid

Number

Session seconds valid.

User Default Currency Iso Code

String

User default currency ISO code.

User Email

String

User email.

User Full Name

String

User full name.

User Id

String

User ID.

User Language

String

User language.

User Locale

String

User locale.

User Name

String

User name.

User Time Zone

String

User time zone.

User Type

String

User type.

User Ui Skin

String

User UI skin.

### Job Failed Record Results Job failed record results.
FieldTypeDescriptionDefault ValueRequired

Error Message

String

Error message.

Id

String

ID name.

Original Fields

Object

Original fields.

### Job Info Job info.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Api Version

Number

API version.

Assignment Rule Id

String

ID of an assignment rule for a case or lead. The assignment rule can be active or inactive.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Concurrency mode.

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type.

Created By Id

String

Created by ID.

Created Date

DateTime

Date created.

External Id Field Name

String

External ID field name.

Fast Path Enabled

Boolean

Determines whether fast path is enabled.

Id

String

ID name.

Number Batches Completed

Number

Number of batches that are completed.

Number Batches Failed

Number

Number of batches that failed.

Number Batches In Progress

Number

Number of batches in progress.

Number Batches Queued

Number

Number of batches that are queued.

Number Batches Total

Number

Number of batches in total.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

Number Retries

Number

Number of retries.

Object

String

Object.

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

  • queryAll

Operation name.

State

Enumeration, one of:

  • Open

  • Closed

  • Aborted

  • Failed

State.

System Modstamp

DateTime

System modstamp.

Total Processing Time

Number

Total processing time.

### Job Successful Record Result Job successful record result.
FieldTypeDescriptionDefault ValueRequired

Created

Boolean

Indicates whether the job is created or not.

Id

String

ID name.

Original Fields

Object

Original fields.

### Job Unprocessed Record Result Job unprocessed record result.
FieldTypeDescriptionDefault ValueRequired

Original Fields

Object

Original fields.

### Keystore Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

### Labels Search Metadata Labels search metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Field Labels

Entity field labels.

Entity Name

String

Entity name.

### Lead Convert Result Lead convert result.
FieldTypeDescriptionDefault ValueRequired

Account Id

String

Account ID.

Contact Id

String

Contact ID.

Errors

Array of Error

Errors.

Lead Id

String

Lead ID.

Opportunity Id

String

Opportunity ID.

Success

Boolean

Determines if successful or not.

### Lead Convert Request Lead convert request.
FieldTypeDescriptionDefault ValueRequired

Contact Id

String

ID of the contact into which the lead is merged (this contact must be associated with the specified account ID, and an account ID must be specified). Required only when updating an existing contact.

If you are converting a lead into a person account, do not specify the contact ID or else an error results. Specify only the account ID of the person account. If no contact ID is specified, then the API creates a new contact that is implicitly associated with the account. To create a new contact, the client application must be logged in with sufficient access rights. To merge a lead into an existing contact, the client application must be logged in with read or write access to the specified contact. The contact name and other existing data are not overwritten (unless Over Write Lead Source is set to true, in which case only the lead source field is overwritten). For information on IDs, see ID Field Type.

Account Id

String

ID of the account into which the lead is merged. Required only when updating an existing account, including person accounts. If no account ID is specified, then the API creates a new account. To create a new account, the client application must be logged in with sufficient access rights. To merge a lead into an existing account, the client application must be logged in with read or write access to the specified account. The account name and other existing data are not overwritten. For information on IDs, see ID Field Type.

Send Email To Owner

Boolean

If true, specifies whether to send a notification email to the owner specified in the Owner ID.

false

Opportunity Name

String

Name of the opportunity to create. If unspecified, this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If Do Not Create Opportunity is true, then no opportunity is created and this field must be left blank; otherwise, an error is returned.

Do Not Create Opportunity

Boolean

Specifies whether to create an opportunity during lead conversion. Set this flag to true only if you do not want to create an opportunity from the lead. An opportunity is created by default.

false

Over Write Lead Source

Boolean

Specifies whether to overwrite the lead source field on the target contact object with the contents of the lead source field in the source lead object. To set this field to true, the client application must specify a Contact Id for the target contact.

false

Opportunity Id

String

ID of an existing opportunity to relate to a lead during lead conversion.

Owner Id

String

Name associated with the owner ID that owns this lead.

Related Person Account Id

String

When converting a lead to a business account and an existing person account, this value specifies the ID of the person account.

Related Person Account Record

Object

When converting a lead to a business account and a new person account, this value specifies the entity record of the new person account.

### Match Record Match record.
FieldTypeDescriptionDefault ValueRequired

Additional Information

Additional information.

Field Diffs

Array of Field Diff

Field differences.

Match Confidence

Number

Match confidence.

Record

Object

Record.

### Match Result Match result.
FieldTypeDescriptionDefault ValueRequired

Entity Type

String

Entity type.

Errors

Array of Simple Error

Errors.

Match Engine

String

Match engine name.

Match Records

Array of Match Record

Match records.

Rule

String

Rule name.

Size

Number

Size.

Success

Boolean

Determines if successful or not.

### Merge Record Merge record.
FieldTypeDescriptionDefault ValueRequired

Master Record

Object

Master record that contains at least the ID and the type of the object that other records merge into. Optionally, provide the fields and their values to update.

x

Record To Merge Ids

Array of String

Additional records to merge into the primary record. Minimum of one record and maximum of two records.

x

Additional Information Map

Object

Field-value map. When a portal user ID is merged, it must contain two entries: name: PortalUserId and value: ID of the portal user. In all other merge cases, set to null or leave empty.

### Merge Result Merge result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Errors.

Id

String

ID name.

Merged Record Ids

Array of String

Merged record IDs.

Success

Boolean

Determines if successful or not.

Updated Related Ids

Array of String

Updated related IDs.

### Metadata Result Metadata result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Errors.

Full Name

String

Full name.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

### Name Value Pair Name value pair.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name.

Value

String

Value.

### Named Layout Info Named layout information.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name.

### Non-Repeatable Stream Configures the non-repeatable streaming strategy, in which Mule disables repeatable streams. Use this strategy if your use case requires reading the content only once. In some cases, you might want to disable the repeatable stream functionality and use non-repeatable streams, which can have less performance overhead, memory use, and cost. ### Pick List Entry Pick list entry.
FieldTypeDescriptionDefault ValueRequired

Active

Boolean

Indicates active or not.

Default Value

Boolean

Indicates default value.

Label

String

Label.

Valid For

Binary

Indicates when valid for.

Value

String

Value.

### Proxy Configures a proxy for outbound connections.
FieldTypeDescriptionDefault ValueRequired

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

### Push Event Result Push event result.
FieldTypeDescriptionDefault ValueRequired

Fanout Count

Number

Fanout count.

User Online Status

Object

User online status.

### Query Job Info Query job information.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Number Records Processed

Number

Number of records that are processed.

Object

String

Object.

Operation

String

Operation name.

Pk Chunking Supported

Boolean

Whether or not PK chunking is supported.

Retries

Number

Number of retries.

State

String

State.

System Modstamp

String

System modstamp.

Total Processing Time

Number

Total processing time.

### Query Job State Query job state.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Query Jobs Info Result Query jobs information result.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Reconnect Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

### Reconnection Configures a reconnection strategy for an operation.
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

### Record Type Info Record type information.
FieldTypeDescriptionDefault ValueRequired

Available

Boolean

Indicates whether available or not.

Default Record Type Mapping

Boolean

Indicates default record type mapping.

Id

String

ID name.

Master

Boolean

Indicates master.

Name

String

Name.

### Redelivery Policy Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
FieldTypeDescriptionDefault ValueRequired

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

### Redelivery Policy Message Identifier Configures the redelivery policy message identifier type.
FieldTypeDescriptionDefault ValueRequired

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if the Use Secure Hash field is false.

### Repeatable File Store Iterable Repeatable file store iterable.
FieldTypeDescriptionDefault ValueRequired

In Memory Objects

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Repeatable In Memory Iterable Repeatable in memory iterable.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower means that the buffer must not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### Reset Password Result Reset password result.
FieldTypeDescriptionDefault ValueRequired

Password

String

Password to authenticate against the proxy server.

### Result Result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Array of the Error type.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

### Retrieve Request Retrieve request.
FieldTypeDescriptionDefault ValueRequired

Fields

Array of String

Fields.

Ids

Array of String

IDs.

### Search Record Search record.
FieldTypeDescriptionDefault ValueRequired

Record

Object

Record.

Search Record Metadata

Search record metadata.

Snippet

Snippet.

### Search Record Metadata Search record metadata.
FieldTypeDescriptionDefault ValueRequired

Spell Corrected

Boolean

Indicates whether the search is spelled correctly.

### Search Result Search result.
FieldTypeDescriptionDefault ValueRequired

Query Id

String

Query ID.

Search Records

Array of Search Record

Search records.

Search Results Metadata

Search results metadata.

### Search Results Metadata Search results metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Label Metadata

Entity label metadata.

Entity Metadata

Entity metadata.

### Search Snippet Search snippet.
FieldTypeDescriptionDefault ValueRequired

Text

String

Text.

Whole Fields

Whole fields.

### Simple Error Simple error.
FieldTypeDescriptionDefault ValueRequired

Fields

Array of String

Fields.

Message

String

Message.

Status Code

String

Status code.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

### TLS Configures TLS to provide secure communications for the Mule app.
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

### Truststore Configures the truststore for TLS.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

### Upsert Metadata Result Upsert metadata result.
FieldTypeDescriptionDefault ValueRequired

Created

Boolean

Indicates whether created or not.

Errors

Array of Error

Errors.

Full Name

String

Full name.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.2 --- # Salesforce Connector 11.2 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule app in XML either from the Anypoint Studio XML editor or a text editor, perform the following actions to get access to the connector: - Add the namespace for the connector to your XML flow. - Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/salesforce http://www.mulesoft.org/schema/mule/salesforce/current/mule-salesforce.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The Maven `pom.xml` file generated by Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector. ```xml com.mulesoft.connectors mule-salesforce-connector x.x.x mule-plugin ``` Replace `x.x.x` with version information from Exchange. Ensure the connector version corresponds to the one 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 `salesforce`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next After completing your namespace and `pom.xml` file, you can try the [Salesforce Examples](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.3 --- # Salesforce Connector 11.3 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce (Salesforce Connector) enables you to create apps that react to Salesforce events such as adding, changing, or deleting objects, topics, documents, and channels. Salesforce Connector enables you to connect to the Salesforce APIs. This connector exposes methods for accessing Salesforce, including working with the [Salesforce Apex classes](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_dev_process_chapter.htm). This connector works with the Salesforce SOAP API, REST API, Bulk API, and Streaming API, depending on the operation you configure. Each API call uses a request/response pattern over an HTTPS connection. All required request headers, error handling, and HTTPS connection configurations are built into the connector. For compatibility information and fixed issues, see the Salesforce Connector release notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce SOAP, REST, Bulk, and Streaming APIs - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Access to the Salesforce target resource, which requires a [Salesforce developer account](https://developer.salesforce.com) and [Salesforce security token](https://help.salesforce.com/s/articleView?language=en_US&id=user_security_token.htm). You can receive a new security token by email if you run **Reset Security Token** through **My Personal Information** from the Salesforce Setup pages. - A consumer key and secret (available in your Salesforce developer account) - The namespace and schema location, if you are using OAuth authentication. If you plan to create the XML for your Mule app, include the correct namespace and schema location in your XML file. Studio adds this information to the XML file automatically when you add Salesforce Connector to a flow in a Mule app. ## Limitations - Salesforce Connector does not expose all possible operations of the Salesforce APIs. - Salesforce Connector does not provide access to the Chatter API or Tooling API. ## Audience - New users Read this document and create your Mule app in [Anypoint Studio](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-studio). The [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-config-topics) topic helps you extend your understanding of the connector. - Advanced users Read [XML and Maven Support](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-xml-maven), the [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-config-topics) topic, and [Examples](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-examples). ## Common Use Cases for the Connector Common use cases for Salesforce Connector include: - **ERP Integration** Give your sales team access to all relevant customer data from one system via real-time synchronization of data between Salesforce and your ERP & finance applications. For example, use Anypoint Connector for SAP (SAP Connector) to sync data between Salesforce and SAP and Anypoint Connector for NetSuite (NetSuite Connector) to sync data between Salesforce and NetSuite. - **Data Aggregation** Collect data from multiple Salesforce orgs, other CRMs, ERP systems, and databases into one Salesforce instance or use that information to generate reports. - **Legacy Modernization** Easily manage data post-acquisition, move off of a legacy CRM system, or migrate ERP data into Salesforce by automatically moving your data into Salesforce. - **Customer Experience** Deliver a consistent, connected customer experience across channels, increase customer satisfaction, and drive revenue growth by integrating Salesforce to applications such as ServiceNow, Marketo, and others. For examples of these use cases, refer to [Salesforce Connector Examples](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-examples). ## Authentication Types Salesforce Connector connections use the following authentication types: - Basic authentication Uses a username and password for authentication - OAuth 2.0 Delegates user authentication to the service hosting the user account - OAuth JWT Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication - OAuth Client Credentials Uses a client ID and client secret for authentication - OAuth SAML Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token - OAuth Username password Uses OAuth 2.0 with a user and password for authentication For information about configuring these authentication types, see [Using Anypoint Studio to Configure Salesforce Connector](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-studio). ## Salesforce Connector Configurations and Examples The following table provides links to specific Salesforce Connector information:
SubjectDescription

Accept and Transform Data

Accept and transform data from Salesforce example

Apex SOAP and REST

Configure for APEX SOAP API and APEX REST API

APIs

List of Salesforce APIs that this connector can access

Application Development

Process order and integration patterns

Batched Data

Batch data using the Salesforce Bulk API

Lead Convert Request ID

Specify a lead ID using DataWeave

Parent Child Relationships

Create and update parent and child relationships example

Anypoint Exchange Templates and Examples

Simplify Salesforce Connector development with a template or example

Subscribe Topic

Subscribe to a Salesforce topic

Subscribe Streaming Channel

Subscribe to a Salesforce streaming channel

Replay Topic

Replay events from a Topic

Replay Streaming Channel

Replay Events from a Salesforce streaming channel

Custom Event Notifications

Get custom event notifications over a streaming channel

Push Event Notifications

Push Events to a Streaming Channel

Object Store Usage

Object Store usage and limitations

## Develop an Application To build an app, perform the following tasks: 1. Configure the connector. 2. Test the connection. 3. Build the rest of your flow. 4. Add and configure DataWeave. When developing an app, Salesforce Connector provides these integration patterns you can use with the Salesforce APIs: - Batch Data Synchronization An external system accesses, changes, deletes, or adds data in Salesforce in batches, and vice versa (Salesforce to external system). - Remote Call-In An external system accesses, changes, deletes, or adds data in Salesforce, and vice versa (Salesforce to external system). - Fire and Forget Remote Process Invocation Salesforce initiates a process in a third-party system and receives an acknowledgment that the process has started. The third-party system continues processing independent of Salesforce. - Request-Reply Remote Process Invocation Salesforce initiates a process in a remote system, waits for the remote system to finish processing, and accepts control returned from the remote system. - User Interface Update Based on Data Changes The Salesforce UI updates in response to a change in a third-party system. ## Salesforce APIs Salesforce Connector works with the Salesforce Apex SOAP API, Apex REST API, Bulk API, Metadata API, and Streaming API, but does not provide access to the Chatter API or the Tooling API. Each API call uses a request/response pattern over an HTTPS connection. All required request headers, error handling, and HTTPS connection configurations are built into the connector. - Apex SOAP API Salesforce [Apex SOAP API](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_api.htm?search_text=soap) exposes Apex class methods as custom SOAP web service calls. This allows an external app to invoke an Apex web service to perform an action in Salesforce. - Apex REST API Salesforce [Apex REST API](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest.htm) creates your own REST-based web services using Apex. This API has all of the advantages of the REST architecture, while adding the ability to define custom logic and including automatic argument or object mapping. - Bulk API Salesforce [Bulk API](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) quickly and securely loads batches of your organization’s data into Salesforce. See also [Load Data in Batches](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-config-topics#batchdata). - Metadata API Salesforce [Metadata API](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_intro.htm) manages customizations and build tools that work with the metadata model, not the data itself. - SOAP API Salesforce [SOAP API](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_quickstart_intro.htm) provides secure access to your organization’s information on Salesforce. Most of the operations that Salesforce Connector performs map to this API. All the Salesforce operations performed through the SOAP API have an optional parameter called `Headers` that can take any of the [Salesforce SOAP headers](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/soap_headers.htm). - Streaming API Salesforce [Streaming API](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/intro_stream.htm) securely receives notifications about changes to your organization’s information in Salesforce. See [Create a Streaming Channel to Receive Data from Salesforce](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-processing-events#createchannel) for more information about the use of the Streaming API. ## Anypoint Exchange Templates and Examples [Anypoint Exchange](https://www.mulesoft.com/exchange/) provides templates you can use as a starting point for your app, as well as examples that illustrate a complete solution. ### Salesforce Connector Templates in Exchange [Anypoint Exchange templates](https://www.mulesoft.com/exchange/?search=salesforce&type=template) provide starting points for Studio projects such as: - Account Broadcast template [Salesforce to Salesforce, Workday, SAP, and database account broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc.wday.sap.db-account-broadcast/) - Aggregation [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-contact-aggregation/), [opportunity](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-aggregation/), [user](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-user-aggregation/) - Bidirectional Sync template - Between Salesforce organizations [accounts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-account-bidirectional-sync/), [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-contact-bidirectional-sync/), [custom objects](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-casecustomobject-bidirectional-sync/), [opportunities](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-bidirectional-sync/), [users](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-user-bidirectional-sync/) - Other sources [database](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2db-account-bidirectional-sync/), [Microsoft Dynamics CRM](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2msdyn-account-bidirectional-sync/), [Siebel](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sieb-account-bidirectional-sync/) - Migration [accounts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-account-migration/), [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-contact-migration/), [opportunities](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-migration/) ### Salesforce Connector Examples in Exchange [Anypoint Exchange examples](https://www.mulesoft.com/exchange/?search=salesforce&type=example) enable you to create complete Studio projects such as: - Batch processing [database](https://www.mulesoft.com/exchange/org.mule.examples/salesforce-to-MySQL-DB-using-Batch-Processing/) and [import leads](https://www.mulesoft.com/exchange/org.mule.examples/import-leads-into-salesforce/) - [Contacts](https://www.mulesoft.com/exchange/org.mule.examples/cache-scope-with-salesforce-contacts/) - [Data retrieval](https://www.mulesoft.com/exchange/org.mule.examples/salesforce-data-retrieval/) - [DataWeave](https://www.mulesoft.com/exchange/org.mule.examples/dataweave-with-flowreflookup/) ## Next Steps After you complete the prerequisites and experiment with templates and examples, you are ready to create an app with [Anypoint Studio](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce APIs: What they are and when to use them](https://developer.salesforce.com/) - [Which Salesforce API should I use?](https://help.salesforce.com/s/articleView?id=integrate_what_is_api.htm&language=en_US&type=5) - [Salesforce Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-connector-release-notes-mule-4) - [Salesforce Connector in Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-salesforce-connector/) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.3 --- # Salesforce Connector 11.3 Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Configure Anypoint Connector for Salesforce (Salesforce Connector) to: - Load data in batches - Specify a Lead ID for a Lead Convert Request operation - Update field values to `null` - Generate an OAuth 2.0 keystore file - Invoke an APEX Rest method ## Load Data in Batches The Salesforce Bulk API loads batches of your organization’s data into Salesforce. Salesforce Connector provides the **Create** and **Create Bulk** operations for working with the Bulk API. For all bulk operations, Salesforce handles the creation process in the background. The connector replies with a `BatchInfo` object, which contains the ID of the batch and the ID of the job it creates to upload the batched objects. In Salesforce, you can track the status of bulk data load jobs and their associated batches by using the job ID for Bulk Data Load Jobs: 1. Click ** Setup > Monitoring > Bulk Data Load Jobs**. 2. Click the job ID to view the job detail page. The job detail page includes a list of all the batches related to the job. The list provides `View Request` and `View Response` links for each batch. If the batch is a CSV file, the links return the request or response in CSV format. If the batch is an XML file, the links return the request or response in XML format. ## Specify a Lead Convert Request ID To specify a lead ID for a `LeadConvertRequest` operation, use a DataWeave transform message. When you use a transform message before the operation, you must add the `leadId` field, because the metadata for the operation doesn’t specify it: ```example ``` ## Update Field Values to Null To set field values to `null`, use an **Update** or **Upsert** request operation and insert the names of the fields you want to nullify in the **Transform Message** component’s **fieldsToNull** field: ![Transform Message properties window for setting a field to null](/mulesoft/current/en-us/salesforce-connector/11.3/_images/salesforce-connector-10-set-fields-to-null.png) Figure 1. Specify the field names you want to nullify in the **Transform Message** component **fieldsToNull** field. ## Generate a Keystore File Salesforce Connector uses the Bouncy Castle cryptographic library to load the certificate from the keystore and sign the payload for the authentication requests. The library has a [vulnerability (CVE-2018-5382)](https://nvd.nist.gov/vuln/detail/CVE-2018-5382) that relates to the BKS-V1 keystore file type. By default, Salesforce Connector uses JKS or PKCS12 keystores. Avoid using BKS-V1 keystore files, as documented in the [Bouncy Castle proposed solution](https://www.kb.cert.org/vuls/id/306792). To generate a JKS keystore file: 1. Go to your Mule workspace and open the command prompt (for Windows) or Terminal (for Mac). 2. Enter this command: ```none keytool -genkeypair -alias salesforce-cert -keyalg RSA -keystore salesforce-cert.jks ``` 3. Enter the following information: - Password for the keystore - Your first name and last name - Your organization unit - Your city and state, and the two-letter code for your country The system generates a Java keystore file (JKS format) that contains a private or public key pair in your workspace. 4. Provide the file path for the keystore in your connector configuration. Enter this command: ```none keytool -exportcert -alias salesforce-cert -file salesforce-cert.crt -keystore salesforce-cert.jks ``` The system exports the public key from the keystore into the workspace. This is the public key to enter in your Salesforce instance. 5. Verify that you have both the keystore (`salesforce-cert.jks`) and the public key (`salesforce-cert.crt`) files in your workspace. ## Invoke APEX Rest Method The Invoke APEX Rest operation enables users to invoke a method from an Apex class that is exposed as a REST service. The following example shows a payload for this operation: ```example ``` In this example: - The `body` element contains `URLParameters`, which is a map containing the parameters that replace the wildcards in the path of the REST resource described in the Apex class. For example, if the REST resource is set to `@RestResource(urlMapping='/myResource/*/mySubResource/*')`, the value of `Parameter1` replaces the first `*`, and the value of `Parameter2` replaces the second `*`. - Key names must start with `Parameter`, followed by a number that shows the position of the `*` to be replaced. - After the `URLParameters` block, provide the content of the `body` value to send to the REST resource, as shown in the example `account` block. - The `headers` and `cookies` fields describe the headers and cookies to pass along with the HTTP request to the desired service. - The `queryParameters` field describes the query parameters to use, and the keys and values in this map that the specified Apex Class must accept. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.3 --- # Salesforce Connector 11.3 Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt These examples show several Mule flows for Salesforce Connector: - [Accept and Transform Data](#accandtrans) - [Create or Update an Object in a Parent-Child Relationship](#parentchild) - [Delete Accounts](#delete-accounts) - [Find Duplicate Accounts](#find-duplicate-accounts) ## Accept and Transform Data This example shows how to configure Salesforce Connector to create a new Salesforce account and query new accounts, and to use [File Connector](https://docs.mulesoft.com/file-connector/latest/) to write the new account data to a file. The example contains three flows: - The first flow configures a template for the HTML input form used to provide data for the new account. - The second flow creates a new Salesforce account based on information in the HTML input form. - The third flow queries new accounts by name and writes new account data to a CSV file. ![Accept and transform data flows](/mulesoft/current/en-us/salesforce-connector/11.3/_images/accept-and-transform-data-flows.png) ### Configure the First Flow Configure the first flow that configures an HTML template that provides the data used to create a new account. Creating the first flow involves configuring a **Listener** component and a **Parse Template** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/account` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/account`. #### Add the Parse Template Component Add the **Parse Template** component to create a template for an HTML form (`form.html`), which is located in the main resources folder and is used to convey information for creating a new account: 1. From the **Mule Palette** view, select **Core** and drag a **Parse Template** component to the right of **Listener**. 2. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the component, such as Parse Template.

Location

form.html

The following image shows an example of the **Parse Template** configuration in the properties window: ![Parse Template properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.3/_images/parse-template-properties-window.png) ### Configure the Second Flow Configure the second flow that creates a new Salesforce account based on the data in the HTTP input form. Creating the second flow involves configuring a **Listener** component, a **Transform Message** component, a **Create** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/createAccount` path: 1. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Accept the defaults. 4. In the properties window, set the **Path** field value to `/createAccount`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Create** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [{ Name: payload.Name, AccountNumber: payload.AccountNumber, BillingCity: payload.BillingCity }] ``` #### Add the Create Operation Add the **Create** operation to create a new Salesforce account using the field values passed by the **Transform Message** component: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Create** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Create** configuration of the global element: ![Create global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.3/_images/create-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

You can successfully pass a variable into Type, but there could be an issue when displaying the input metadata if the runtime fails to properly resolve the value of that variable.

Records

payload

The following image shows an example of the **Create** configuration in the properties window: ![Create properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.3/_images/create-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the field values to JSON format so the values can be used with [File Connector](https://docs.mulesoft.com/file-connector/latest/): 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Create**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { id:$.id, errors:$.errors, success:$.success } ``` ### Configure the Third Flow Configure the third flow that queries new Salesforce accounts by name and writes the matching accounts data to a Java file. Creating the third flow involves configuring an **On New Object** source, a **Query result list** operation, a **Query result stream by id** operation, a **Transform Message** component, and a **Write** operation. #### Configure the On New Object Source Configure the **On New Object** source to initiate a Mule flow when a new account is created on the `/account` path: 1. From the **Mule Palette** view, select **Salesforce** and drag the **On New Object** source to the canvas. 2. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

The following image shows an example of the **On New Object** configuration in the properties window: ![On New Object properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.3/_images/on-new-object-properties-window.png) #### Add the Query Result List Operation Add the **Query result list** operation to return a list of result IDs: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Query result list** operation to the right of **On New Object**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Query result list** configuration of the global element: ![Query result list global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.3/_images/query-result-list-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Batch info

payload

The following image shows an example of the **Query result list** configuration in the properties window: ![Query result list properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.3/_images/query-result-list-properties-window.png) #### Add the Query Result Stream by Id Operation Add the **Query result stream by id** operation to obtain the final query results: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Query result stream by id** operation to the right of **Query result list**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Query result stream by id** configuration of the global element: ![Query result stream by id global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.3/_images/query-result-stream-by-id-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Batch info

payload

The following image shows an example of the **Query result stream by id** configuration in the properties window: ![Query result stream by id properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.3/_images/query-result-stream-by-id-properties-window.png) #### Add the Transform Message Component Add the **Transform Message** component to convert the field values to JSON format so the values can be used with [File Connector](https://docs.mulesoft.com/file-connector/latest/): 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Query result stream by id**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { AccountNumber:$.AccountNumber, BillingAddress:$.BillingAddress, Id:$.Id, Name:$.Name } ``` #### Add the Write Operation Add the **Write** operation to write the new account data to a CSV file: 1. From the **Mule Palette** view, select **File** and drag the **Write** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Working Directory

If Connection is selected, the directory to consider the root of every relative path used with this connector. If not provided, it defaults to the value of the user.home system property. If that system property is not set, then the connector fails to initialize.

The following image shows an example of the **Write** configuration of the global element: ![Write global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.3/_images/write-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Path

/account

Content

payload

The following image shows an example of the **Write** configuration in the properties window: ![Write properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.3/_images/write-properties-window.png) ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Create or Update an Object in a Parent-Child Relationship This example shows how to create the object relationship structure in Salesforce needed to perform an upsert using Salesforce Connector. ![Create or Update an Object in a Parent-Child Relationship flow](/mulesoft/current/en-us/salesforce-connector/11.3/_images/create-update-flow.png) ### Configure the Flow A Salesforce object can have standard or custom relationships between objects. The relationships between objects are usually one-to-many (parent-child) relationships, but can be any link between two objects residing in Salesforce. The example uses two custom Salesforce object types that have a parent-child relationship: - `Plane__c`, the parent object that must exist in Salesforce - `Component__c`, the object to upsert using Salesforce Connector The relationship between the two custom objects is represented by a `Plane__r` field whose value is an object with two fields: - The `type` field, which has the referenced object type name as its value. In this example, the value of `type` is `Plane_c`. - A field that identifies the instance of the parent object to reference. In this example, the `Name` field references the `Cobra` instance of `Plane__c`. When you upsert `Component__c`, the POJO sent as input to Salesforce Connector looks like this: ```linenums ---- [{ // Component__c's fields ... Plane__r: { "type": "Plane__c", "Name": "Cobra" } }] ---- ``` Creating the flow involves configuring a **Listener** component, a **Transform Message** component, an **Upsert** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Upsert** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [{ Name: "NewPlaneComponent", Plane__r: { "type": "Plane__c", "Name": "Cobra" } }] ``` #### Add the Upsert Operation Add the **Upsert** operation to create or update a Salesforce object that is in a parent-child relationship: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Upsert** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Upsert** configuration of the global element: ![Upsert global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.3/_images/upsert-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Object type

Component_c

External id field name

Id

Records

payload

The following image shows an example of the **Upsert** configuration in the properties window: ![Upsert properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.3/_images/upsert-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Upsert**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Delete Accounts This example shows how to use Salesforce Connector to delete Salesforce accounts. ![Delete Accounts flow](/mulesoft/current/en-us/salesforce-connector/11.3/_images/delete-accounts-flow.png) ### Configure the Flow Creating the flow involves configuring a **Listener** component, a **Transform Message** component, a **Delete** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Delete** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [payload.Id] ``` #### Add the Delete Operation Add the **Delete** operation to delete Salesforce accounts: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Delete** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Delete** configuration of the global element: ![Delete global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.3/_images/delete-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Records to Delete Ids

payload

The following image shows an example of the **Delete** configuration in the properties window: ![Delete properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.3/_images/delete-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Delete**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { id:$.id, errors:$.errors, success:$.success } ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Find Duplicate Accounts This example shows how to use Salesforce Connector to find duplicate Salesforce accounts. ![Find Duplicate Accounts flow](/mulesoft/current/en-us/salesforce-connector/11.3/_images/find-duplicates-accounts-flow.png) ### Configure the Flow Creating the flow involves configuring a **Listener** component, a **Transform Message** component, a **Find duplicates** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/findDuplicates` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/findDuplicates`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Delete** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [ payload ] ``` #### Add the Find Duplicates Operation Add the **Find duplicates** operation to find duplicate Salesforce accounts: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Find duplicates** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Find duplicates** configuration of the global element: ![Find Duplicates global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.3/_images/find-duplicates-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

Criteria

payload

The following image shows an example of the **Find duplicates** configuration in the properties window: ![Find Duplicates properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.3/_images/find-duplicates-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Find duplicates**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- { success: payload.success, duplicateResults: { (payload.duplicateResults map { matchRecords: $.matchResults } ) }, duplicateRuleEntityType: payload.duplicateRuleEntityType, duplicateRule: payload.duplicateRule, allowSave: payload.allowSave, errorMessage: payload.errorMessage } ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.3 --- # Salesforce Connector 11.3 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt > [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality. > We maintained certain terms to avoid any effect on customer implementations. Anypoint Connector for Salesforce (Salesforce Connector) simplifies and accelerates integration across Sales Cloud, Service Cloud, Salesforce Platform, and Force.com. With comprehensive access to Salesforce entities, this connector streamlines automation of business processes—helping you unlock more value from your Salesforce investments, empower your sales teams, increase revenue, and provide better customer service. ## Configuration Default Configuration for Salesforce Connector.
NameTypeDescriptionDefault ValueRequired

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Read Timeout

Number

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

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

SECONDS

Name

String

Identifier of this element used to reference it in other components.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Fetch All Apex SOAP Metadata

Boolean

If true, DataSense is performed for all Apex classes in the organization. If false, DataSense is performed only for classes in Apex Class Names. If the organization contains many Apex classes, this might cause a ConnectionTimeout during DataSense.

false

Fetch All Apex REST Metadata

Boolean

If true, DataSense is performed for all Apex classes in the organization. If false, DataSense is performed only for classes in Apex Class Names. If the organization contains many Apex classes, this might cause a ConnectionTimeout during DataSense.

false

Apex Class Names

Array of String

List of Apex class names involved in metadata retrieval via DataSense.

Include null values

Boolean

Includes null values in the Apex Rest API request. This parameter applies to the Invoke Apex Rest Method operation only.

false

### Basic Authentication Connection Type (Supported by Salesforce API v64.0 and below) Uses a username and a password for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP is allowlisted on Salesforce.

Authorization URL

String

Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, https://login.salesforce.com/services/Soap/u/65.0. Always use lowercase when specifying the protocol (e.g., http, https).

Session Id

String

Value that identifies an active Salesforce session.

Service Endpoint

String

Specifies the service endpoint. This value is used only if the Session Id configuration property is used.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth v2.0 Connection Type Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint. Always use lowercase when specifying the protocol (e.g., http, https).

https://login.salesforce.com/services/oauth2/authorize

Access Token Url

String

URL of the service provider’s access token endpoint. Always use lowercase when specifying the protocol (e.g., http, https).

https://login.salesforce.com/services/oauth2/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after receiving an access token.

Listener Config

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

### OAuth JWT Connection Type Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication. > [!NOTE] Salesforce Connector supports providing a signed certificate only if you use the > `SHA256withRSA` algorithm for the OAuth JWT connection type. You can only enable **JSON Web Token-based access tokens** option on Salesforce server for REST API calls. This option isn’t compatible with Salesforce Connector.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Certificate Alias

String

Alias of the certificate.

Principal

String

Username of the desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

Audience Url

String

URL that identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.

Use the authorization server’s URL for the audience value if implementing for a community: https://login.salesforce.com, https://test.salesforce.com, or https://community.force.com/customers.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth Client Credentials Uses a client ID and client secret for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Client ID

String

The OAuth client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret that corresponds to the client ID.

x

Token URL

String

Service provider’s token endpoint URL. Always use lowercase when specifying the protocol (e.g., http, https).

https://{domain}.my.salesforce.com/services/oauth2/token

Scopes

String

The OAuth scopes to request during the OAuth dance.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

### OAuth Username Password Connection Type Uses OAuth 2.0 with a user and password for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Consumer Secret

String

Your application’s client secret (consumer secret in Remote Access Detail).

x

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP is allowlisted on Salesforce.

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth SAML Connection Type > [!NOTE] OAuth SAML currently uses only Salesforce as an identity provider. Refer to > [Salesforce as a SAML Identity Provider](https://help.salesforce.com/s/articleView?id=xcloud.sso_sfdc_idp_saml_parent.htm&type=5) > to enable Salesforce as an identity provider. Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Certificate Alias

String

Alias of the certificate.

Principal

String

Username of the desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

## Sources - [On Deleted Object](#deleted-object-listener) - [On Modified Object](#modified-object-listener) - [On New Object](#new-object-listener) - [Replay Channel Listener](#replay-channel-listener) - [Replay Topic Listener](#replay-topic-listener) > [!NOTE] The **On Deleted Object**, **On Modified Object**, and **On New Object** sources in > Salesforce Connector use Object Store to save watermarks. You might experience limitations that > are specific to the Object Store implementation you are using (Object Store for CloudHub > deployments or Object Store for on-premises deployments), so configure Object Store to suit your > needs. > For more information, see > [The Different Types of Object Stores Explained](https://help.salesforce.com/s/articleView?id=001123185&type=1). ### On Deleted Object `` Source that adds one or more `whereConditions` in the query calling the method.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### On Modified Object `` Source for modified objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### On New Object `` Source for new objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### Replay Channel Listener `` Source that subscribes to a streaming channel. First, the streaming channel must be published, and after that, a subscription to that streaming channel must be created. Salesforce allows you to subscribe to a nonexistent streaming channel but won’t send you notifications after the topic is created.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Streaming Channel

String

Name of the streaming channel to subscribe to.

x

Cache Events In Memory

Boolean

When the processing flow is slow, cache events in memory to reduce quota consumption.

false

Replay Option

Enumeration, one of:

  • ONLY_NEW

  • ALL

  • FROM_REPLAY_ID

  • FROM_LAST_REPLAY_ID

  • ONLY_NEW: -1

    Subscriber receives new events that are broadcast after the client subscribes.

  • ALL: -2

    Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription.

  • FROM_REPLAY_ID

    Subscriber receives only events that have a replay ID value greater than the specified replay ID.

  • FROM_LAST_REPLAY_ID

    Subscriber uses the highest replay ID stored in the object store regardless of whether it is processed successfully or not.

x

Replay Id

String

Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to ALL or ONLY_NEW.

Replay Failed Events If Any or Resume from Last Replay Id

Boolean

If true, the source starts consuming data with any failed events (if any) or starts consuming data from the last replay ID that is processed successfully.

false

The size (in bytes) of the event queue (DEPRECATED)

Number

In previous versions, this field was used to specify the size of the event queue which can lead to memory issues. Now, the messages are streamed and no buffering is needed.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

true

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Throw Exception When Organization Daily Limit Exceeded

Boolean

Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded.

false

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Attributes

Object

Attributes.

#[message.attributes]

#### Output

Type

Any

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### Replay Topic Listener `` Salesforce stores events for 24 hours and enables you to retrieve stored and new events. Source in which subscribers choose which events to receive by using replay options.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Topic

String

Name of the topic to subscribe to.

x

Cache Events In Memory

Boolean

When the processing flow is slow, cache events in memory to reduce quota consumption.

false

Replay Option

Enumeration, one of:

  • ONLY_NEW

  • ALL

  • FROM_REPLAY_ID

  • FROM_LAST_REPLAY_ID

  • ONLY_NEW: -1

    Subscriber receives new events that are broadcast after the client subscribes.

  • ALL: -2

    Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription.

  • FROM_REPLAY_ID

    Subscriber receives only events that have a replay ID value greater than the specified replay ID.

  • FROM_LAST_REPLAY_ID

    Subscriber uses the highest replay ID stored in the object store regardless of whether it is processed successfully or not.

x

Replay Id

String

Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to ALL or ONLY_NEW.

Replay Failed Events If Any or Resume from Last Replay Id

Boolean

If true, the source starts consuming data with any failed events (if any) or starts consuming data from the last replay ID that is processed successfully.

false

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

true

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Throw Exception When Organization Daily Limit Exceeded

Boolean

Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded.

false

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Attributes

Object

Attributes.

#[message.attributes]

#### Output

Type

Any

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ## Operations > [!NOTE] If you set `LocalDate` for a field in the payload, the input time is automatically > converted to `GMT` or the server’s time zone based on the Gregorian calendar. This conversion > impacts date calculations or comparisons in Salesforce Connector operations, as `LocalDate` is > adjusted to align with the server’s time zone or defaults to GMT. - [Abort Job](#abortJob) - [Abort Job Bulk Api V2](#abortJobBulkApiV2) - [Abort Query Job Bulk Api V2](#abortQueryJobBulkApiV2) - [Batch Info](#batchInfo) - [Batch Info List](#batchInfoList) - [Batch Result](#batchResult) - [Batch Result Stream](#batchResultStream) - [Change Own Password](#changeOwnPassword) - [Close Job](#closeJob) - [Convert Lead](#convertLead) - [Create](#create) - [Create Batch](#createBatch) - [Create Batch For Query](#createBatchForQuery) - [Create Batch Stream](#createBatchStream) - [Create Job](#createJob) - [Create Job Bulk Api V2](#createJobBulkApiV2) - [Create Metadata](#createMetadata) - [Create Query Job Bulk Api V2](#createQueryJobBulkApiV2) - [Delete](#delete) - [Delete Job Bulk Api V2](#deleteJobBulkApiV2) - [Delete Metadata](#deleteMetadata) - [Delete Query Job Bulk Api V2](#deleteQueryJobBulkApiV2) - [Deploy Metadata](#deployMetadata) - [Describe Global](#describeGlobal) - [Describe Metadata](#describeMetadata) - [Describe Sobject](#describeSobject) - [Find Duplicates](#findDuplicates) - [Find Duplicates By Ids](#findDuplicatesByIds) - [Get All Jobs Bulk Api V2](#getAllJobsBulkApiV2) - [Get All Query Jobs Bulk Api V2](#getAllQueryJobsBulkApiV2) - [Get Deleted](#getDeleted) - [Get Job State Bulk Api V2](#getJobStateBulkApiV2) - [Get Query Job Info Bulk Api V2](#getQueryJobInfoBulkApiV2) - [Get Query Job Results Bulk Api V2](#getQueryJobResultsBulkApiV2) - [Get Server Timestamp](#getServerTimestamp) - [Get updated objects](#getUpdated) - [Get User Info](#getUserInfo) - [Invoke Apex Rest Method](#invokeApexRestMethod) - [Invoke Apex Soap Method](#invokeApexSoapMethod) - [Job Info](#jobInfo) - [List Metadata](#listMetadata) - [Merge](#merge) - [Merge Multiple](#mergemultiple) - [Publish Platform Event Message](#publishPlatformEventMessage) - [Publish Streaming Channel](#publishStreamingChannel) - [Publish Topic](#publishTopic) - [Push Generic Event](#pushGenericEvent) - [Query (Deprecated)](#query) - [Query All](#queryAll) - [Query Result List](#queryResultList) - [Query Result Stream By Id](#queryResultStreamById) - [Query Xml Stream](#queryXmlStream) - [Read Metadata](#readMetadata) - [Rename Metadata](#renameMetadata) - [Reset Password](#resetPassword) - [Retrieve](#retrieve) - [Retrieve Job Failed Results Bulk V2](#retrieveJobFailedResultsBulkV2) - [Retrieve Job Successful Results Bulk V2](#retrieveJobSuccessfulResultsBulkV2) - [Retrieve Job Unprocessed Results Bulk V2](#retrieveJobUnprocessedResultsBulkV2) - [Retrieve Metadata](#retrieveMetadata) - [Search](#search) - [Set Password](#setPassword) - [Unauthorize](#unauthorize) - [Update](#update) - [Update Metadata](#updateMetadata) - [Upsert](#upsert) - [Upsert Metadata](#upsertMetadata) ### Abort Job `` Aborts an open job given its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID that identifies the job to abort.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Abort Job Bulk Api V2 `` Aborts an ongoing Bulk API v2 Job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Abort Query Job Bulk Api V2 `` Abort the indicated query job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job to abort.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job Info

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Info `` Accesses the latest BatchInfo of a submitted BatchInfo. Enables you to track the execution status.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo that is monitored.

#[payload]

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Info List `` Gets information about all batches in a job.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job Id

String

ID of the job to retrieve batch information for.

x

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Result `` Accesses `com.sforce.async.BatchResult` of a submitted BatchInfo.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch To Retrieve

com.sforce.async.BatchInfo that is monitored.

#[payload]

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Result Stream `` Accesses `com.sforce.async.BatchResult` of a submitted BatchInfo.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch To Retrieve

com.sforce.async.BatchInfo that is monitored.

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Change Own Password `` Changes the password of the user linked to the connector’s configuration.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Old Password

String

Old password to change.

x

New Password

String

New password to change.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Close Job `` Closes an open job given its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID identifying the job to close.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Convert Lead `` Converts a lead into an account, contact, or (optionally) an opportunity.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Lead Convert Request

Information for lead conversion.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Lead Convert Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Create `` Adds one or more new records to your organization’s data. > [!IMPORTANT] When you map your objects to the input of this message processor, the objects must > match the expected type of the object at Salesforce. For example, if you set the **CloseDate** > field of an opportunity to a string of value `2011-12-13`, it is sent to Salesforce as a string. > The operation is rejected because the CloseDate is not of the expected type. The correct way to > map it is to generate a Java Date object. You can do so using the Groovy expression evaluator as > `#[groovy:Date.parse("yyyy-MM-dd", "2011-12-13")]`.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to add.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Create Batch `` Creates a batch using the given objects within the specified Job. The job can be of XML or CSV type. This call uses the Bulk API. This operation is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

com.sforce.async.JobInfo in which the batch is created. The job can be of XML, JSON, or CSV type.

x

SObjects

Array of Object

List of one or more SObject objects.

#[payload]

SObject Max Depth

Number

Asynchronous SObject recursive MAX_DEPTH check.

5

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Batch For Query `` Creates a batch using the given query. This call uses the Bulk API. This operation is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

JobInfo in which the batch is created.

x

Query

String

Query to execute.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Batch Stream `` Creates a batch using the given stream within the specified job. The stream can have a CSV, XML, ZIP\_CSV, or ZIP\_XML format. This call uses the Bulk API and is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

JobInfo in which the batch is created.

#[payload]

x

Stream

Any

Stream containing the data. The stream can have a CSV, XML, ZIP_CSV, or ZIP_XML format.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Job `` Creates a job to perform one or more batches through Bulk API operations.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

  • queryAll

OperationEnum that is executed by the job.

x

Type

String

Type of Salesforce object that the job processes.

x

Create Job Request

Creates the job request.

If you input the value in literal mode, an example value is:

{
    “externalIdFieldName”: “employeeId”,
    “contentType”: “XML”,
    “concurrencyMode”: “Serial”
}

If you input the value in expression mode, then the input can be dynamic using output application/json or output application/java, and can be transformed into the required input.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Job Bulk Api V2 `` Creates a Bulk API v2 job containing the data to insert, update, delete, or upsert. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Type of object to work with.

x

sObjects

Binary

Array of one or more SObject objects.

#[payload]

Operation

Enumeration, one of:

  • insert

  • update

  • delete

  • hardDelete

  • upsert

Operation to execute.

x

Line Ending

String

Line ending of CSV data.

LF

Column Delimiter

String

Column delimiter of CSV data.

COMMA

Assignment Rule Id

String

ID of an assignment rule to run for a case or a lead. The assignment rule can be active or inactive.

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the ID lookup field property for standard objects.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Salesforce headers. For information, see Create a Job in the Salesforce documentation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Metadata `` Adds one or more new metadata components to your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type to create.

x

Metadata Objects

Array of Object

List of Map<String,Object> representing the metadata to create.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Create Query Job Bulk Api V2 `` Creates a query job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Query

String

Query used to create the job.

x

Operation

Enumeration, one of:

  • QUERY

  • QUERY_ALL

Operation used.

QUERY

Column Delimiter

String

Type of delimiter used.

COMMA

Line Ending

String

Line ending used.

CRLF

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Salesforce headers. For information, see Create a Query Job in the Salesforce documentation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job State

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Delete `` Deletes one or more records from your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Records To Delete Ids

Array of String

Array of one or more IDs associated with the objects to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Delete Job Bulk Api V2 `` Deletes a Bulk API v2 Job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Delete Metadata `` Deletes one or more metadata components from your organization, given the API name of the objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to delete.

x

Full Names

Array of String

Full names of the components to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Delete Query Job Bulk Api V2 `` Deletes a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Deploy Metadata `` A file-based call to deploy XML components. Use this operation to take file representations of components and deploy them into an organization by creating, updating, or deleting the components they represent.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Deploy Metadata Request

Data needed by this operation.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Global `` Retrieves a list of available objects for your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe Global Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Metadata `` Retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other components.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Sobject `` Describes metadata (field list and object properties) for the specified object.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Object. The specified value must be a valid object for your organization. For a complete list of objects, see Standard Objects.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe S Object Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Find Duplicates `` Performs rule-based searches for duplicate records. The input is an array of Salesforce objects, each of which specifies the values to search for and the type of object that supplies the duplicate rules. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the values to do the search. The output identifies the detected duplicates for each SObject.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of SObjects to find duplicates for.

x

Criteria

Array of Object

List of SObjects used as a criterion when searching for duplicates.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Find Duplicates Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Find Duplicates By Ids `` Performs rule-based searches for duplicate records. The input is an array of IDs, each of which specifies the records for which to search for duplicates. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the record IDs to do the search. The output identifies the detected duplicates for each ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Ids List

Array of String

List of IDs to find duplicates.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Find Duplicates Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get All Jobs Bulk Api V2 `` Retrieves all Bulk jobs. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Desired concurrency mode.

Parallel

Pk Chunking

Boolean

Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Bulk Job V2 Result

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get All Query Jobs Bulk Api V2 `` Retrieves all Bulk query jobs.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Pk Chunking

Boolean

Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Job Type

Enumeration, one of:

  • BigObjectIngest

  • Classic

  • V2Query

Job type.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Desired concurrency mode.

Parallel

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Query Jobs Info Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Deleted `` Retrieves the list of records deleted from a particular time in the past (specified in minutes).
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type. The specified value must be a valid object for your organization.

x

Start Date

DateTime

Starting date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

x

End Date

DateTime

Ending date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC).

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get Deleted Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get Job State Bulk Api V2 `` Gets the state of a v2 Bulk job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Query Job Info Bulk Api V2 `` Returns the details of a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Query Job Results Bulk Api V2 `` Returns the results of a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Max Records Per Page

Number

Number of records that are on each page retrieved from the API. This number influences the number of API requests and the memory used by the connector to handle the results.

Salesforce Connector automatically handles pagination and retrieves all pages before the next processing job starts.

2000

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Server Timestamp `` Retrieves the current system timestamp, in Coordinated Universal Time (UTC), from the API.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

DateTime

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get updated objects `` Retrieves the list of individual records that are created or updated between the specified start and end date.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type. The specified value must be a valid object for your organization.

x

Start Date

DateTime

Starting date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

x

End Date

DateTime

Ending date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If a value is not provided, the current server time is used.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get Updated Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get User Info `` Retrieves personal information for the user associated with the current session.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get User Info Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Invoke Apex Rest Method `` Invokes any operation from an Apex class that is exposed as a REST web service.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Request

Object

Object containing request information, some of which can include object queryParams with key-value pairs. These parameters are passed as URL parameters to the Apex Rest endpoint, for example:

queryParams: {AccountId : "a0w0E0000069MDxQAM" , ContactId: "0030E00000rRSJ6QAO" }

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Apex Class Name

String

Apex class name.

x

Apex Class Method Name

String

Apex class method name. The method name format is:

ApexMethodName^RestResourceURL^HttpMethod^OutputType^InputParameterName1=ParameterType1,InputParameterName2=ParameterType2

For example:

getAccountInfo^/accountInfo/*^HttpGet^void

Special characters aren’t allowed in ApexMethodName.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Invoke Apex Soap Method `` Invokes any operation from an Apex class that is exposed as a SOAP web service.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Input

Binary

InputStream with XML that contains information about the method to invoke and its parameters. The XML must adhere to the WSDL standards.

#[payload]

Apex Headers

Object

Parameters specifying the SOAP Headers to send to the API. For more information about the supported headers, see SOAP API and SOAP Headers for Apex.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Apex Class Name

String

Apex class name.

x

Apex Class Method Name

String

Apex class method name.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Job Info `` Accesses the latest JobInfo of a submitted JobInfo ID. This operation enables you to track the execution status.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID of the job that is monitored.

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### List Metadata `` Retrieves property information about metadata components in your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type used as a criterion when querying for information.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of File Properties

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Merge `` Merges up to three records into one record.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Records To Merge Ids

Array of String

List of IDs of the objects to merge.

#[payload]

Type

String

Type of record to merge.

x

Master Record

Object

Must provide the ID of the object that other records are merged into. Optionally, provide the fields to update and their values.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Merge Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Merge Multiple `` Combines up to three records of the same type into one record. The input is an array of MergeRequest elements, each of which specifies the records to combine. #### Limitations - The only supported object types are: - Lead - Contact - Account - Person Account - Individual Only objects of the same type can be merged. For example, merge leads only with leads. - The **Merge Multiple** operation enables you to specify a list of a maximum of 200 merge requests. - A merge request can contain a maximum of three IDs: - The master record ID - Up to two IDs for the records to merge into the primary record
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

List of Merge Records

Array of Merge Record

List of merge records. Each merge record contains the primary record, the record to merge IDs into, and an optional additional information map.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Map<String, Object>

Declares the request headers to use with this operation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Merge Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Platform Event Message `` Adds one new platform event to your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Platform Event name

String

Name of the platform event to create.

x

Platform Event Message

Array of Object

List<PlatformEventMessage> to create.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Streaming Channel `` Creates a streaming channel in which generic, custom messages are pushed.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Channel name

String

Descriptive name of the streaming channel. Limit of 80 characters, and must start with /u/. This value identifies the channel and must be unique.

x

Owner Id

String

Identifier for the channel owner.

Description

String

Description of what kinds of records are returned by the query. Limit of 255 characters.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Topic `` Creates a topic representing a query that is used to notify listeners when changes are made to records in an organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Topic Name

String

Topic name.

x

Query

String

Query name.

x

Description

String

Description.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Push Generic Event `` Pushes generic streaming custom events to the specified streaming channel.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Events

Event list.

#[payload]

Channel Id

String

Streaming channel name.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Push Event Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query (Deprecated) `` Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are strings and, if necessary, you can convert them to the appropriate type, for example, by using DataWeave and **Transform Message**. The **Query** operation is now deprecated. Use the [**Query Xml Stream**](#queryXmlStream) operation instead.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query All `` Retrieves data from specified objects, whether or not they have been deleted.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query Result List `` Returns a list of result IDs for a specific batch. If the batch requires retries, there is more than one element in the output. Use this operation with [Query Result Stream By Id](#queryResultStreamById) to obtain the results of the query.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo to retrieve the results for.

#[payload]

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation.

XML

Output Mime Type

String

MIME type of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of a variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of String

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Query Result Stream By Id `` Returns an InputStream with the query results for a specific result ID of a submitted BatchInfo. Obtain the result IDs first by using the [Query Result List](#queryResultList) operation.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo that returns the result ID.

#[payload]

x

Result ID

String

Result ID obtained with Query Result List.

x

Output Mime Type

String

MIME type of the payload output of this operation.

Output Encoding

String

Encoding of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configure how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of a variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Binary

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Query Xml Stream `` Executes a query against the specified object and returns data that matches the specified criteria. This operation returns paginated results. Each result is an InputStream of XML records.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Output Mime Type

String

MIME type of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Headers

Object

Headers to include in the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of String payload and Void attributes

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED - SALESFORCE:RETRY\_EXHAUSTED ### Read Metadata `` Returns one or more metadata components from your organization, given the objects' API names.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to read.

x

Full Names

Array of String

List of full names of the components to read.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Rename Metadata `` Renames a metadata component in your organization, given its old API name and the new name.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the component to rename.

x

Old Full Name

String

Current component full name.

x

New Full Name

String

New component full name.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Reset Password `` Resets the password of the user corresponding to the provided user ID, or the user linked to the connector’s configuration, if the user ID field is null.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User to reset the password for. If unspecified, the current user is used.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Reset Password Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Retrieve `` Retrieves one or more records based on the specified IDs.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to retrieve.

x

Retrieve Request

Must provide the IDs and specify the fields for the records to retrieve.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Retrieve Job Failed Results Bulk V2 `` Gets the status of the failed processed SObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Job Failed Record Results

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Job Successful Results Bulk V2 `` Gets the status of the successfully processed SObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Job Successful Record Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Job Unprocessed Results Bulk V2 `` Gets the status of the unprocessed sObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Metadata `` Retrieves XML file representations of components in an organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Package Names

Array of String

List of package names to retrieve. If you are retrieving only unpackaged components, do not specify a name. You can retrieve packaged and unpackaged components in the same retrieval operation.

Specific Files

Array of String

List of file names to retrieve. If a value is specified for this property, Package Names must be set to null.

Unpackaged

Binary

Stream containing a list of components to retrieve that are not in a package.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Binary

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Search `` Searches for objects using Salesforce Object Search Language (SOSL). Mimics using the search box inside the Salesforce UI.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Search String

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Search Language (SOSL).

x

Parameters

Object

Map with values for placeholders in Search String.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Search Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Set Password `` Changes the password of a user or a self service user to a value that you specify.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User to set the password for.

x

New Password

String

New password for the user.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Unauthorize `` Deletes all of the access token information of a given resource owner ID so that it is impossible to execute an operation for that user without performing the OAuth dance.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner for whom to invalidate access.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

#### Associated Configurations - [Configuration](#sfdc-config) ### Update `` Updates one or more existing records in your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to update.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Update Metadata `` Updates one or more metadata components in your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to update.

x

Metadata Objects

Array of Object

List of Map<String, Object> representing the metadata to update.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Upsert `` Upserts a homogeneous list of objects. Creates new records and updates existing records using a custom field to determine the presence of existing records. In most cases, use `#upsert(String, String, List, Map)` over `#create(String, List, Map)` to avoid creating unwanted, duplicate records. > [!NOTE] Although you cannot change the **Content Type** value for a bulk upsert, you can use the > [**Create Job**](#createJob) operation to set the content type to CSV (or zipped CSV if you reach > the character limit) and then follow up with the [**Create Batch**](#createBatch) operation.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Type of record to upsert.

x

External Id Field Name

String

Either of the following:

  • For a custom object, the name of the field that contains the external ID field name

  • For a standard object, the name of the field that contains the ID lookup field name

Unless you configure the External Id Field Name field for the SObject to upsert, the Upsert operation fails.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Upsert Metadata `` Creates or updates one or more metadata components in your organization. For a picklist field in an object, the **Upsert Metadata** operation updates only the picklist mapping for that specific object. To update the actual picklist values, such as adding or removing values in the picklist, use the [**Deploy Metadata**](#deployMetadata) operation. You must perform a metadata deploy for **Custom Field** or **Global Picklist** based on whether the picklist is tied to a custom field or is a global picklist.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to create or update.

x

Metadata Objects

Array of Object

List of Map<String, Object> representing the metadata to upsert.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Upsert Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ## Object Types - [Action Override](#ActionOverride) - [Additional Information Map](#AdditionalInformationMap) - [Batch Info](#BatchInfo) - [Bulk Item](#BulkItem) - [Bulk Job State](#BulkJobState) - [Bulk Job V2 Result](#BulkJobV2Result) - [Bulk Operation Result](#BulkOperationResult) - [Child Relationship](#ChildRelationship) - [Create Job Request](#CreateJobRequest) - [CRL File](#crl-file) - [Cron](#cron) - [Custom OCSP Responder](#custom-ocsp-responder) - [Deleted Record](#DeletedRecord) - [Deploy Metadata Request](#DeployMetadataRequest) - [Describe Global Result](#DescribeGlobalResult) - [Describe Global S Object Result](#DescribeGlobalSObjectResult) - [Describe Metadata Object](#DescribeMetadataObject) - [Describe Metadata Result](#DescribeMetadataResult) - [Describe S Object Result](#DescribeSObjectResult) - [Duplicate Result](#DuplicateResult) - [Entity Search Metadata](#EntitySearchMetadata) - [Error](#Error) - [Error Mapping](#ErrorMapping) - [Expiration Policy](#ExpirationPolicy) - [Field](#Field) - [Field Diff](#FieldDiff) - [Field Level Search Metadata](#FieldLevelSearchMetadata) - [File Properties](#FileProperties) - [Filtered Lookup Info](#FilteredLookupInfo) - [Find Duplicates Result](#FindDuplicatesResult) - [Fixed Frequency](#fixed-frequency) - [Generic Streaming Event](#GenericStreamingEvent) - [Get Deleted Result](#GetDeletedResult) - [Get Updated Result](#GetUpdatedResult) - [Get User Info Result](#GetUserInfoResult) - [Job Failed Record Results](#JobFailedRecordResults) - [Job Info](#JobInfo) - [Job Successful Record Result](#JobSuccessfulRecordResult) - [Job Unprocessed Record Result](#JobUnprocessedRecordResult) - [Keystore](#KeyStore) - [Labels Search Metadata](#LabelsSearchMetadata) - [Lead Convert Result](#LeadConvertResult) - [Lead Convert Request](#LeadConvertRequest) - [Match Record](#MatchRecord) - [Match Result](#MatchResult) - [Merge Record](#MergeRecord) - [Merge Result](#MergeResult) - [Metadata Result](#MetadataResult) - [Name Value Pair](#NameValuePair) - [Named Layout Info](#NamedLayoutInfo) - [Non-Repeatable Stream](#non-repeatable-stream) - [Pick List Entry](#PickListEntry) - [Proxy](#ProxyConfiguration) - [Push Event Result](#PushEventResult) - [Query Job Info](#QueryJobInfo) - [Query Job State](#QueryJobState) - [Query Jobs Info Result](#QueryJobsInfoResult) - [Reconnect](#reconnect) - [Reconnect Forever](#reconnect-forever) - [Reconnection](#reconnection) - [Record Type Info](#RecordTypeInfo) - [Redelivery Policy](#RedeliveryPolicy) - [Redelivery Policy Message Identifier](#RedeliveryPolicyMessageIdentifier) - [Repeatable File Store Iterable](#repeatable-file-store-iterable) - [Repeatable File Store Stream](#repeatable-file-store-stream) - [Repeatable In Memory Iterable](#repeatable-in-memory-iterable) - [Repeatable In Memory Stream](#repeatable-in-memory-stream) - [Reset Password Result](#ResetPasswordResult) - [Result](#Result) - [Retrieve Request](#RetrieveRequest) - [Search Record](#SearchRecord) - [Search Record Metadata](#SearchRecordMetadata) - [Search Result](#SearchResult) - [Search Results Metadata](#SearchResultsMetadata) - [Search Snippet](#SearchSnippet) - [Simple Error](#SimpleError) - [Standard Revocation Check](#standard-revocation-check) - [TLS](#Tls) - [Truststore](#TrustStore) - [Upsert Metadata Result](#UpsertMetadataResult) ### Action Override Action override.
FieldTypeDescriptionDefault ValueRequired

Available In Touch

Boolean

Indicates whether available in touch or not.

From Factor

String

From factor.

Name

String

Name.

Page Id

String

Page ID.

Url

String

URL.

### Additional Information Map Additional information map.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name of the map.

Value

String

Value of the map.

### Batch Info Batch information.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Created Date

DateTime

Date created.

Id

String

ID name.

Job Id

String

Job ID.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

State

Enumeration, one of:

  • Queued

  • InProgress

  • Completed

  • Failed

  • NotProcessed

State.

State Message

String

State message.

System Modstamp

DateTime

System modstamp.

Total Processing Time

Number

Total processing time.

### Bulk Item Bulk item.
FieldTypeDescriptionDefault ValueRequired

Exception

Any

Exception.

Id

Any

ID.

Message

String

Message.

Payload

Payload.

Status Code

String

Status code.

Successful

Boolean

Determines if successful or not.

### Bulk Job State Bulk job state.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Api Version

Number

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Error Message

String

Error message.

External Id Field Name

String

External ID field name.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

Object

String

Object.

Operation

String

Operation name.

Retries

Number

Number of retries.

State

String

State.

System Modstamp

String

System modstamp.

Total Processing Time

Number

Total processing time.

### Bulk Job V2 Result Bulk job v2 result.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Content Url

String

Content URL.

Created By Id

String

Created by ID.

Created Date

String

Date created.

External Id Field Name

String

External ID field name.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Bulk Operation Result Bulk operation result.
FieldTypeDescriptionDefault ValueRequired

Id

Any

ID.

Items

Array of Bulk Item

Array of the Bulk Item type.

Successful

Boolean

Determines if successful or not.

### Child Relationship Child relationship.
FieldTypeDescriptionDefault ValueRequired

Cascade Delete

Boolean

Cascade delete.

Child S Object

String

Child SObject.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Field

String

Field.

Junction Id List Names

Array of String

Junction ID list names.

Junction Reference To

Array of String

Junction reference to.

Relationship Name

String

Relationship name.

### Create Job Request Create job request.
FieldTypeDescriptionDefault ValueRequired

External Id Field Name

String

Name of the field on this object. Use this attribute for custom objects or the ID lookup field property for standard objects (only required for upsert operations).

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type for the job results.

When specifying a content type different from XML for a query type, use the queryResultStream(BatchInfo) method to retrieve results.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Concurrency mode of the job.

### CRL File Specifies the location of the certification revocation list (CRL) file.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the CRL file.

### Cron CRON.
FieldTypeDescriptionDefault ValueRequired

Expression

String

Cron expression.

x

Time zone

String

ID of the time zone on which to base the expression. Refer to the java.util.TimeZone Javadoc for the format and valid values for this ID.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.
FieldTypeDescriptionDefault ValueRequired

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

### Deleted Record Deleted record.
FieldTypeDescriptionDefault ValueRequired

Deleted Date

DateTime

Deleted date.

Id

String

ID name.

### Deploy Metadata Request Deploy metadata request.
FieldTypeDescriptionDefault ValueRequired

Stream

Binary

Stream containing the data. This parameter defaults to the payload content.

x

Ignore Warnings

Boolean

If true, a warning allows a deployment to complete successfully.

false

Purge On Delete

Boolean

If true, the deleted components in the destructiveChanges.xml manifest file are not stored in the Recycle Bin. This option only works in the Developer Edition or in sandbox organizations; it does not work in production organizations.

false

Rollback On Error

Boolean

If true, failures cause a complete rollback.

true

### Describe Global Result Describe global result.
FieldTypeDescriptionDefault ValueRequired

Encoding

String

Encoding.

Max Batch Size

Number

Maximum batch size.

Sobjects

SObject results.

### Describe Global S Object Result Describe global SObject results.
FieldTypeDescriptionDefault ValueRequired

Activateable

Boolean

Indicates whether activateable or not.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Custom Setting

Boolean

Indicates whether there is a custom setting or not.

Deletable

Boolean

Indicates whether deletable or not.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Feed Enabled

Boolean

Indicates whether the feed is enabled.

Key Prefix

String

Key prefix.

Label

String

Label.

Label Plural

String

Label plural.

Layoutable

Boolean

Indicates whether layoutable or not.

Mergeable

Boolean

Indicates whether mergeable or not.

Mru Enabled

Boolean

Indicates whether MRU is enabled or not.

Name

String

Name.

Queryable

Boolean

Indicates whether queryable or not.

Replicateable

Boolean

Indicates whether replicateable or not.

Retrieveable

Boolean

Indicates whether retrieveable or not.

Searchable

Boolean

Indicates whether searchable or not.

Triggerable

Boolean

Indicates whether triggerable or not.

Undeleteable

Boolean

Indicates whether undeleteable or not.

Updateable

Boolean

Indicates whether updateable or not.

### Describe Metadata Object Describe metadata object.
FieldTypeDescriptionDefault ValueRequired

Child Xml Names

Array of String

Child XML names.

Directory Name

String

Directory name.

In Folder

Boolean

Indicates whether the metadata object is in the folder.

Meta File

Boolean

Indicates whether the metadata object is a meta file.

Suffix

String

Suffix.

Xml Name

String

XML name.

### Describe Metadata Result Describe metadata result.
FieldTypeDescriptionDefault ValueRequired

Metadata Objects

Metadata objects.

Organization Namespace

String

Organization namespace.

Partial Save Allowed

Boolean

Indicates whether partial save is allowed.

Test Required

Boolean

Indicates whether a test is required.

### Describe S Object Result Describe SObject result.
FieldTypeDescriptionDefault ValueRequired

Action Overrides

Action overrides.

Activateble

Boolean

Indicates whether activateable or not.

Child Relationships

Child relationships.

Compact Layoutable

Boolean

Compact layoutable.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Custom Setting

Boolean

Indicates whether there is a custom setting or not.

Deletable

Boolean

Indicates whether deletable or not.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Feed Enabled

Boolean

Indicates whether the feed is enabled.

Fields

Array of Field

Fields.

Key Prefix

String

Key prefix.

Label

String

Label.

Label Plural

String

Label plural.

Layoutable

Boolean

Indicates whether layoutable or not.

Mergeable

Boolean

Indicates whether mergeable or not.

Mru Enabled

Boolean

Indicates whether MRU is enabled or not.

Name

String

Name.

Named Layout Infos

Named layout information.

Network Scope Field Name

String

Network scope field name.

Queryable

Boolean

Indicates whether queryable or not.

Record Type Infos

Record type information.

Replicateable

Boolean

Indicates whether replicateable or not.

Retrieveable

Boolean

Indicates whether retrieveable or not.

Search Layoutable

Boolean

Indicates whether the search is layoutable or not.

Searchable

Boolean

Indicates whether searchable or not.

Triggerable

Boolean

Indicates whether triggerable or not.

Undeleteable

Boolean

Indicates whether undeleteable or not.

Updateable

Boolean

Indicates whether updateable or not.

Url Detail

String

URL detail.

Url Edit

String

URL edit.

Url New

String

URL new.

### Duplicate Result Duplicate result.
FieldTypeDescriptionDefault ValueRequired

Allow Save

Boolean

Determines whether to allow saving or not.

Duplicate Rule

String

Duplicate rule.

Duplicate Rule Entity Type

String

Duplicate rule entity type.

Error Message

String

Error message.

Match Results

Array of Match Result

Match results.

### Entity Search Metadata Entity search metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Name

String

Entity name.

Field Metadata

Field metadata.

### Error Error.
FieldTypeDescriptionDefault ValueRequired

Duplicate Result

Duplicate result.

Fields

Array of String

Fields.

Message

String

Message.

Status Code

String

Status code.

### Error Mapping Error mapping.
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Source.

Target

String

Target.

x

### Expiration Policy Configures an expiration policy strategy.
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

### Field Field.
FieldTypeDescriptionDefault ValueRequired

Autonumber

Boolean

Indicates autonumber.

Byte Length

Number

Byte length.

Calculated

Boolean

Indicates whether calculated or not.

Case Sensitive

Boolean

Indicates whether case sensitive or not.

Controller Name

String

Controller name.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Default Value

Any

Default value.

Default Value Formula

String

Default value formula.

Defaulted On Create

Boolean

Indicates whether defaulted on create.

Dependent Pick List

Boolean

Indicates whether dependent pick list or not.

Deprecate And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Digits

Number

Digits.

Display Location In Decimal

Boolean

Indicates whether the display location is in decimal.

Encrypted

Boolean

Indicates whether encrypted or not.

Extra Type Info

String

Extra type information.

Field Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INT

  • DOUBLE

  • DATE

  • DATETIME

  • TIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANYTYPE

  • DATACATEGORYGROUPREFERENCE

  • ENCRYPTEDSTRING

  • ADDRESS

  • COMPLEXVALUE

  • LOCATION

  • JSON

  • LONG

Field type.

Filterable

Boolean

Indicates whether filterable or not.

Filtered Lookup Info

Filtered lookup information.

Formula

String

Formula.

Groupable

Boolean

Indicates whether groupable or not.

High Scale Number

Boolean

Indicates whether high scale number or not.

Html Formatted

Boolean

Indicates whether HTML formatted or not.

Id Lookup

Boolean

Indicates ID lookup.

Inline Help Text

String

Inline help text.

Label

String

Label.

Length

Number

Length.

Mask

String

Mask.

Mask Type

String

Mask type.

Name

String

Name.

Name Field

Boolean

Indicates name field.

Name Pointing

Boolean

Indicates name pointing.

Nullable

Boolean

Indicates whether nullable or not.

Permissinable

Boolean

Indicates whether permissionable or not.

Picklist Values

Picklist values.

Polymorphic Foreign Key

Boolean

Indicates polymorphic foreign key.

Precision

Number

Precision.

Reference Target Field

String

Reference target field.

Reference To

Array of String

Reference to.

Relationship Name

String

Relationship name.

Relationship Order

Number

Relationship order.

Required

Boolean

Indicates whether required or not.

Restricted Picklist

Boolean

Indicates whether restricted picklist or not.

Scale

Number

Scale.

Search Filterable

Boolean

Indicates whether search filterable or not.

Sortable

Boolean

Indicates whether sortable or not.

Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INT

  • DOUBLE

  • DATE

  • DATETIME

  • TIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANYTYPE

  • DATACATEGORYGROUPREFERENCE

  • ENCRYPTEDSTRING

  • ADDRESS

  • COMPLEXVALUE

  • LOCATION

  • JSON

  • LONG

Type.

Unique

Boolean

Indicates whether unique or not.

Updateable

Boolean

Indicates whether updateable or not.

Write Requires Master Read

Boolean

Indicates whether write requires master read or not.

### Field Diff Field difference.
FieldTypeDescriptionDefault ValueRequired

Difference

Enumeration, one of:

  • DIFFERENT

  • NULL

  • SAME

  • SIMILAR

Field differences.

Name

String

Name of the field.

### Field Level Search Metadata Field level search metadata.
FieldTypeDescriptionDefault ValueRequired

Label

String

Label.

Name

String

Name.

Type

String

Type.

### File Properties File properties.
FieldTypeDescriptionDefault ValueRequired

Created By

String

Created by.

Created By Name

String

Created by name.

Created Date

DateTime

Date created.

File Name

String

File name.

Full Name

String

Full name.

Id

String

ID name.

Last Modified By Id

String

Last modified by ID.

Last Modified By Name

String

Last modified by name.

Last Modified Date

String

Last modified date.

Manageable State

Enumeration, one of:

  • released

  • deleted

  • deprecated

  • installed

  • beta

  • unmanaged

Manageable state.

Namespace Prefix

String

Namespace prefix.

Type

String

Type.

### Filtered Lookup Info Filtered lookup information.
FieldTypeDescriptionDefault ValueRequired

Controlling Fields

Array of String

Controlling fields.

Dependent

Boolean

Indicates dependent or not.

Optional Filter

Boolean

Indicates optional filter or not.

### Find Duplicates Result Find duplicates result.
FieldTypeDescriptionDefault ValueRequired

Duplicate Results

Duplicate results.

Errors

Array of Error

Errors.

Success

Boolean

Determines if successful or not.

### Fixed Frequency Fixed frequency.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

Frequency at which the scheduler initiates the flow, based on the time unit specified in the Time Unit field.

1000 (MILLISECONDS)

x

Start delay

Number

Amount of time that the scheduler waits before initiating the flow for the first time after the app starts. This value is based on the time unit specified in the Time Unit field.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Frequency and Start delay fields.

MILLISECONDS

### Generic Streaming Event Generic streaming event.
FieldTypeDescriptionDefault ValueRequired

Payload

String

Payload.

User Ids

Array of String

User IDs.

### Get Deleted Result Get deleted result.
FieldTypeDescriptionDefault ValueRequired

Deleted Records

Deleted records.

Earliest Date Available

DateTime

Earliest date available.

Latest Date Covered

DateTime

Latest date covered.

### Get Updated Result Get updated result.
FieldTypeDescriptionDefault ValueRequired

Ids

Array of String

IDs.

Latest Date Covered

DateTime

Latest date covered.

### Get User Info Result Get user information result.
FieldTypeDescriptionDefault ValueRequired

Accessibility Mode

Boolean

Indicates accessibility mode.

Currency Symbol

String

Currency symbol.

Org Attachment File Size Limit

Number

Organization attachment file size limit.

Org Default Currency Iso Code

String

Organization default currency ISO code.

Org Default Currency Locale

String

Organization default currency locale.

Org Disallow Html Attachments

Boolean

Indicates whether the organization disallows HTML attachments.

Org Has Person Accounts

Boolean

Indicates whether the organization contains person accounts.

Organization Id

String

Organization ID.

Organization Multi Currency

Boolean

Organization multicurrency.

Organization Name

String

Organization name.

Profile Id

String

Profile ID.

Role Id

String

Role ID.

Session Seconds Valid

Number

Session seconds valid.

User Default Currency Iso Code

String

User default currency ISO code.

User Email

String

User email.

User Full Name

String

User full name.

User Id

String

User ID.

User Language

String

User language.

User Locale

String

User locale.

User Name

String

User name.

User Time Zone

String

User time zone.

User Type

String

User type.

User Ui Skin

String

User UI skin.

### Job Failed Record Results Job failed record results.
FieldTypeDescriptionDefault ValueRequired

Error Message

String

Error message.

Id

String

ID name.

Original Fields

Object

Original fields.

### Job Info Job info.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Api Version

Number

API version.

Assignment Rule Id

String

ID of an assignment rule for a case or lead. The assignment rule can be active or inactive.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Concurrency mode.

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type.

Created By Id

String

Created by ID.

Created Date

DateTime

Date created.

External Id Field Name

String

External ID field name.

Fast Path Enabled

Boolean

Determines whether fast path is enabled.

Id

String

ID name.

Number Batches Completed

Number

Number of batches that are completed.

Number Batches Failed

Number

Number of batches that failed.

Number Batches In Progress

Number

Number of batches in progress.

Number Batches Queued

Number

Number of batches that are queued.

Number Batches Total

Number

Number of batches in total.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

Number Retries

Number

Number of retries.

Object

String

Object.

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

  • queryAll

Operation name.

State

Enumeration, one of:

  • Open

  • Closed

  • Aborted

  • Failed

State.

System Modstamp

DateTime

System modstamp.

Total Processing Time

Number

Total processing time.

### Job Successful Record Result Job successful record result.
FieldTypeDescriptionDefault ValueRequired

Created

Boolean

Indicates whether the job is created or not.

Id

String

ID name.

Original Fields

Object

Original fields.

### Job Unprocessed Record Result Job unprocessed record result.
FieldTypeDescriptionDefault ValueRequired

Original Fields

Object

Original fields.

### Keystore Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

### Labels Search Metadata Labels search metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Field Labels

Entity field labels.

Entity Name

String

Entity name.

### Lead Convert Result Lead convert result.
FieldTypeDescriptionDefault ValueRequired

Account Id

String

Account ID.

Contact Id

String

Contact ID.

Errors

Array of Error

Errors.

Lead Id

String

Lead ID.

Opportunity Id

String

Opportunity ID.

Success

Boolean

Determines if successful or not.

### Lead Convert Request Lead convert request.
FieldTypeDescriptionDefault ValueRequired

Contact Id

String

ID of the contact into which the lead is merged (this contact must be associated with the specified account ID, and an account ID must be specified). Required only when updating an existing contact.

If you are converting a lead into a person account, do not specify the contact ID or else an error results. Specify only the account ID of the person account. If no contact ID is specified, then the API creates a new contact that is implicitly associated with the account. To create a new contact, the client application must be logged in with sufficient access rights. To merge a lead into an existing contact, the client application must be logged in with read or write access to the specified contact. The contact name and other existing data are not overwritten (unless Over Write Lead Source is set to true, in which case only the lead source field is overwritten). For information on IDs, see ID Field Type.

Account Id

String

ID of the account into which the lead is merged. Required only when updating an existing account, including person accounts. If no account ID is specified, then the API creates a new account. To create a new account, the client application must be logged in with sufficient access rights. To merge a lead into an existing account, the client application must be logged in with read or write access to the specified account. The account name and other existing data are not overwritten. For information on IDs, see ID Field Type.

Send Email To Owner

Boolean

If true, specifies whether to send a notification email to the owner specified in the Owner ID.

false

Opportunity Name

String

Name of the opportunity to create. If unspecified, this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If Do Not Create Opportunity is true, then no opportunity is created and this field must be left blank; otherwise, an error is returned.

Do Not Create Opportunity

Boolean

Specifies whether to create an opportunity during lead conversion. Set this flag to true only if you do not want to create an opportunity from the lead. An opportunity is created by default.

false

Over Write Lead Source

Boolean

Specifies whether to overwrite the lead source field on the target contact object with the contents of the lead source field in the source lead object. To set this field to true, the client application must specify a Contact Id for the target contact.

false

Opportunity Id

String

ID of an existing opportunity to relate to a lead during lead conversion.

Owner Id

String

Name associated with the owner ID that owns this lead.

Related Person Account Id

String

When converting a lead to a business account and an existing person account, this value specifies the ID of the person account.

Related Person Account Record

Object

When converting a lead to a business account and a new person account, this value specifies the entity record of the new person account.

### Match Record Match record.
FieldTypeDescriptionDefault ValueRequired

Additional Information

Additional information.

Field Diffs

Array of Field Diff

Field differences.

Match Confidence

Number

Match confidence.

Record

Object

Record.

### Match Result Match result.
FieldTypeDescriptionDefault ValueRequired

Entity Type

String

Entity type.

Errors

Array of Simple Error

Errors.

Match Engine

String

Match engine name.

Match Records

Array of Match Record

Match records.

Rule

String

Rule name.

Size

Number

Size.

Success

Boolean

Determines if successful or not.

### Merge Record Merge record.
FieldTypeDescriptionDefault ValueRequired

Master Record

Object

Master record that contains at least the ID and the type of the object that other records merge into. Optionally, provide the fields and their values to update.

x

Record To Merge Ids

Array of String

Additional records to merge into the primary record. Minimum of one record and maximum of two records.

x

Additional Information Map

Object

Field-value map. When a portal user ID is merged, it must contain two entries: name: PortalUserId and value: ID of the portal user. In all other merge cases, set to null or leave empty.

### Merge Result Merge result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Errors.

Id

String

ID name.

Merged Record Ids

Array of String

Merged record IDs.

Success

Boolean

Determines if successful or not.

Updated Related Ids

Array of String

Updated related IDs.

### Metadata Result Metadata result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Errors.

Full Name

String

Full name.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

### Name Value Pair Name value pair.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name.

Value

String

Value.

### Named Layout Info Named layout information.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name.

### Non-Repeatable Stream Configures the non-repeatable streaming strategy, in which Mule disables repeatable streams. Use this strategy if your use case requires reading the content only once. In some cases, you might want to disable the repeatable stream functionality and use non-repeatable streams, which can have less performance overhead, memory use, and cost. ### Pick List Entry Pick list entry.
FieldTypeDescriptionDefault ValueRequired

Active

Boolean

Indicates active or not.

Default Value

Boolean

Indicates default value.

Label

String

Label.

Valid For

Binary

Indicates when valid for.

Value

String

Value.

### Proxy Configures a proxy for outbound connections.
FieldTypeDescriptionDefault ValueRequired

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

### Push Event Result Push event result.
FieldTypeDescriptionDefault ValueRequired

Fanout Count

Number

Fanout count.

User Online Status

Object

User online status.

### Query Job Info Query job information.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Number Records Processed

Number

Number of records that are processed.

Object

String

Object.

Operation

String

Operation name.

Pk Chunking Supported

Boolean

Whether or not PK chunking is supported.

Retries

Number

Number of retries.

State

String

State.

System Modstamp

String

System modstamp.

Total Processing Time

Number

Total processing time.

### Query Job State Query job state.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Query Jobs Info Result Query jobs information result.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Reconnect Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

### Reconnection Configures a reconnection strategy for an operation.
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

### Record Type Info Record type information.
FieldTypeDescriptionDefault ValueRequired

Available

Boolean

Indicates whether available or not.

Default Record Type Mapping

Boolean

Indicates default record type mapping.

Id

String

ID name.

Master

Boolean

Indicates master.

Name

String

Name.

### Redelivery Policy Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
FieldTypeDescriptionDefault ValueRequired

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

### Redelivery Policy Message Identifier Configures the redelivery policy message identifier type.
FieldTypeDescriptionDefault ValueRequired

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if the Use Secure Hash field is false.

### Repeatable File Store Iterable Repeatable file store iterable.
FieldTypeDescriptionDefault ValueRequired

In Memory Objects

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Repeatable In Memory Iterable Repeatable in memory iterable.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower means that the buffer must not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### Reset Password Result Reset password result.
FieldTypeDescriptionDefault ValueRequired

Password

String

Password to authenticate against the proxy server.

### Result Result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Array of the Error type.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

### Retrieve Request Retrieve request.
FieldTypeDescriptionDefault ValueRequired

Fields

Array of String

Fields.

Ids

Array of String

IDs.

### Search Record Search record.
FieldTypeDescriptionDefault ValueRequired

Record

Object

Record.

Search Record Metadata

Search record metadata.

Snippet

Snippet.

### Search Record Metadata Search record metadata.
FieldTypeDescriptionDefault ValueRequired

Spell Corrected

Boolean

Indicates whether the search is spelled correctly.

### Search Result Search result.
FieldTypeDescriptionDefault ValueRequired

Query Id

String

Query ID.

Search Records

Array of Search Record

Search records.

Search Results Metadata

Search results metadata.

### Search Results Metadata Search results metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Label Metadata

Entity label metadata.

Entity Metadata

Entity metadata.

### Search Snippet Search snippet.
FieldTypeDescriptionDefault ValueRequired

Text

String

Text.

Whole Fields

Whole fields.

### Simple Error Simple error.
FieldTypeDescriptionDefault ValueRequired

Fields

Array of String

Fields.

Message

String

Message.

Status Code

String

Status code.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

### TLS Configures TLS to provide secure communications for the Mule app.
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

### Truststore Configures the truststore for TLS.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

### Upsert Metadata Result Upsert metadata result.
FieldTypeDescriptionDefault ValueRequired

Created

Boolean

Indicates whether created or not.

Errors

Array of Error

Errors.

Full Name

String

Full name.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.3 --- # Salesforce Connector 11.3 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule app in XML either from the Anypoint Studio XML editor or a text editor, perform the following actions to get access to the connector: - Add the namespace for the connector to your XML flow. - Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/salesforce http://www.mulesoft.org/schema/mule/salesforce/current/mule-salesforce.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The Maven `pom.xml` file generated by Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector. ```xml com.mulesoft.connectors mule-salesforce-connector x.x.x mule-plugin ``` Replace `x.x.x` with version information from Exchange. Ensure the connector version corresponds to the one 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 `salesforce`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next After completing your namespace and `pom.xml` file, you can try the [Salesforce Examples](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.4 --- # Salesforce Connector 11.4 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce (Salesforce Connector) enables you to create apps that react to Salesforce events such as adding, changing, or deleting objects, topics, documents, and channels. Salesforce Connector enables you to connect to the Salesforce APIs. This connector exposes methods for accessing Salesforce, including working with the [Salesforce Apex classes](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_dev_process_chapter.htm). This connector works with the Salesforce SOAP API, REST API, Bulk API, and Streaming API, depending on the operation you configure. Each API call uses a request/response pattern over an HTTPS connection. All required request headers, error handling, and HTTPS connection configurations are built into the connector. For compatibility information and fixed issues, see the Salesforce Connector release notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce SOAP, REST, Bulk, and Streaming APIs - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Access to the Salesforce target resource, which requires a [Salesforce developer account](https://developer.salesforce.com) and [Salesforce security token](https://help.salesforce.com/s/articleView?language=en_US&id=user_security_token.htm). You can receive a new security token by email if you run **Reset Security Token** through **My Personal Information** from the Salesforce Setup pages. - A consumer key and secret (available in your Salesforce developer account) - The namespace and schema location, if you are using OAuth authentication. If you plan to create the XML for your Mule app, include the correct namespace and schema location in your XML file. Studio adds this information to the XML file automatically when you add Salesforce Connector to a flow in a Mule app. ## Limitations - Salesforce Connector does not expose all possible operations of the Salesforce APIs. - Salesforce Connector does not provide access to the Chatter API or Tooling API. ## Audience - New users Read this document and create your Mule app in [Anypoint Studio](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-studio). The [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-config-topics) topic helps you extend your understanding of the connector. - Advanced users Read [XML and Maven Support](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-xml-maven), the [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-config-topics) topic, and [Examples](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-examples). ## Common Use Cases for the Connector Common use cases for Salesforce Connector include: - **ERP Integration** Give your sales team access to all relevant customer data from one system via real-time synchronization of data between Salesforce and your ERP & finance applications. For example, use Anypoint Connector for SAP (SAP Connector) to sync data between Salesforce and SAP and Anypoint Connector for NetSuite (NetSuite Connector) to sync data between Salesforce and NetSuite. - **Data Aggregation** Collect data from multiple Salesforce orgs, other CRMs, ERP systems, and databases into one Salesforce instance or use that information to generate reports. - **Legacy Modernization** Easily manage data post-acquisition, move off of a legacy CRM system, or migrate ERP data into Salesforce by automatically moving your data into Salesforce. - **Customer Experience** Deliver a consistent, connected customer experience across channels, increase customer satisfaction, and drive revenue growth by integrating Salesforce to applications such as ServiceNow, Marketo, and others. For examples of these use cases, refer to [Salesforce Connector Examples](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-examples). ## Authentication Types Salesforce Connector connections use the following authentication types: - Basic authentication Uses a username and password for authentication - OAuth 2.0 Delegates user authentication to the service hosting the user account - OAuth JWT Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication - OAuth Client Credentials Uses a client ID and client secret for authentication - OAuth SAML Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token - OAuth Username password Uses OAuth 2.0 with a user and password for authentication For information about configuring these authentication types, see [Using Anypoint Studio to Configure Salesforce Connector](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-studio). ## Salesforce Connector Configurations and Examples The following table provides links to specific Salesforce Connector information:
SubjectDescription

Accept and Transform Data

Accept and transform data from Salesforce example

Apex SOAP and REST

Configure for APEX SOAP API and APEX REST API

APIs

List of Salesforce APIs that this connector can access

Application Development

Process order and integration patterns

Batched Data

Batch data using the Salesforce Bulk API

Lead Convert Request ID

Specify a lead ID using DataWeave

Parent Child Relationships

Create and update parent and child relationships example

Anypoint Exchange Templates and Examples

Simplify Salesforce Connector development with a template or example

Subscribe Topic

Subscribe to a Salesforce topic

Subscribe Streaming Channel

Subscribe to a Salesforce streaming channel

Replay Topic

Replay events from a Topic

Replay Streaming Channel

Replay Events from a Salesforce streaming channel

Custom Event Notifications

Get custom event notifications over a streaming channel

Push Event Notifications

Push Events to a Streaming Channel

Object Store Usage

Object Store usage and limitations

## Develop an Application To build an app, perform the following tasks: 1. Configure the connector. 2. Test the connection. 3. Build the rest of your flow. 4. Add and configure DataWeave. When developing an app, Salesforce Connector provides these integration patterns you can use with the Salesforce APIs: - Batch Data Synchronization An external system accesses, changes, deletes, or adds data in Salesforce in batches, and vice versa (Salesforce to external system). - Remote Call-In An external system accesses, changes, deletes, or adds data in Salesforce, and vice versa (Salesforce to external system). - Fire and Forget Remote Process Invocation Salesforce initiates a process in a third-party system and receives an acknowledgment that the process has started. The third-party system continues processing independent of Salesforce. - Request-Reply Remote Process Invocation Salesforce initiates a process in a remote system, waits for the remote system to finish processing, and accepts control returned from the remote system. - User Interface Update Based on Data Changes The Salesforce UI updates in response to a change in a third-party system. ## Salesforce APIs Salesforce Connector works with the Salesforce Apex SOAP API, Apex REST API, Bulk API, Metadata API, and Streaming API, but does not provide access to the Chatter API or the Tooling API. Each API call uses a request/response pattern over an HTTPS connection. All required request headers, error handling, and HTTPS connection configurations are built into the connector. - Apex SOAP API Salesforce [Apex SOAP API](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_api.htm?search_text=soap) exposes Apex class methods as custom SOAP web service calls. This allows an external app to invoke an Apex web service to perform an action in Salesforce. - Apex REST API Salesforce [Apex REST API](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest.htm) creates your own REST-based web services using Apex. This API has all of the advantages of the REST architecture, while adding the ability to define custom logic and including automatic argument or object mapping. - Bulk API Salesforce [Bulk API](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) quickly and securely loads batches of your organization’s data into Salesforce. See also [Load Data in Batches](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-config-topics#batchdata). - Metadata API Salesforce [Metadata API](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_intro.htm) manages customizations and build tools that work with the metadata model, not the data itself. - SOAP API Salesforce [SOAP API](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_quickstart_intro.htm) provides secure access to your organization’s information on Salesforce. Most of the operations that Salesforce Connector performs map to this API. All the Salesforce operations performed through the SOAP API have an optional parameter called `Headers` that can take any of the [Salesforce SOAP headers](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/soap_headers.htm). - Streaming API Salesforce [Streaming API](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/intro_stream.htm) securely receives notifications about changes to your organization’s information in Salesforce. See [Create a Streaming Channel to Receive Data from Salesforce](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-processing-events#createchannel) for more information about the use of the Streaming API. ## Anypoint Exchange Templates and Examples [Anypoint Exchange](https://www.mulesoft.com/exchange/) provides templates you can use as a starting point for your app, as well as examples that illustrate a complete solution. ### Salesforce Connector Templates in Exchange [Anypoint Exchange templates](https://www.mulesoft.com/exchange/?search=salesforce&type=template) provide starting points for Studio projects such as: - Account Broadcast template [Salesforce to Salesforce, Workday, SAP, and database account broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc.wday.sap.db-account-broadcast/) - Aggregation [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-contact-aggregation/), [opportunity](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-aggregation/), [user](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-user-aggregation/) - Bidirectional Sync template - Between Salesforce organizations [accounts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-account-bidirectional-sync/), [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-contact-bidirectional-sync/), [custom objects](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-casecustomobject-bidirectional-sync/), [opportunities](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-bidirectional-sync/), [users](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-user-bidirectional-sync/) - Other sources [database](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2db-account-bidirectional-sync/), [Microsoft Dynamics CRM](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2msdyn-account-bidirectional-sync/), [Siebel](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sieb-account-bidirectional-sync/) - Migration [accounts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-account-migration/), [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-contact-migration/), [opportunities](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-migration/) ### Salesforce Connector Examples in Exchange [Anypoint Exchange examples](https://www.mulesoft.com/exchange/?search=salesforce&type=example) enable you to create complete Studio projects such as: - Batch processing [database](https://www.mulesoft.com/exchange/org.mule.examples/salesforce-to-MySQL-DB-using-Batch-Processing/) and [import leads](https://www.mulesoft.com/exchange/org.mule.examples/import-leads-into-salesforce/) - [Contacts](https://www.mulesoft.com/exchange/org.mule.examples/cache-scope-with-salesforce-contacts/) - [Data retrieval](https://www.mulesoft.com/exchange/org.mule.examples/salesforce-data-retrieval/) - [DataWeave](https://www.mulesoft.com/exchange/org.mule.examples/dataweave-with-flowreflookup/) ## Next Steps After you complete the prerequisites and experiment with templates and examples, you are ready to create an app with [Anypoint Studio](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce APIs: What they are and when to use them](https://developer.salesforce.com/) - [Which Salesforce API should I use?](https://help.salesforce.com/s/articleView?id=integrate_what_is_api.htm&language=en_US&type=5) - [Salesforce Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-connector-release-notes-mule-4) - [Salesforce Connector in Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-salesforce-connector/) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.4 --- # Salesforce Connector 11.4 Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Configure Anypoint Connector for Salesforce (Salesforce Connector) to: - Load data in batches - Specify a Lead ID for a Lead Convert Request operation - Update field values to `null` - Generate an OAuth 2.0 keystore file - Invoke an APEX Rest method ## Load Data in Batches The Salesforce Bulk API loads batches of your organization’s data into Salesforce. Salesforce Connector provides the **Create** and **Create Bulk** operations for working with the Bulk API. For all bulk operations, Salesforce handles the creation process in the background. The connector replies with a `BatchInfo` object, which contains the ID of the batch and the ID of the job it creates to upload the batched objects. In Salesforce, you can track the status of bulk data load jobs and their associated batches by using the job ID for Bulk Data Load Jobs: 1. Click ** Setup > Monitoring > Bulk Data Load Jobs**. 2. Click the job ID to view the job detail page. The job detail page includes a list of all the batches related to the job. The list provides `View Request` and `View Response` links for each batch. If the batch is a CSV file, the links return the request or response in CSV format. If the batch is an XML file, the links return the request or response in XML format. ## Specify a Lead Convert Request ID To specify a lead ID for a `LeadConvertRequest` operation, use a DataWeave transform message. When you use a transform message before the operation, you must add the `leadId` field, because the metadata for the operation doesn’t specify it: ```example ``` ## Update Field Values to Null To set field values to `null`, use an **Update** or **Upsert** request operation and insert the names of the fields you want to nullify in the **Transform Message** component’s **fieldsToNull** field: ![Transform Message properties window for setting a field to null](/mulesoft/current/en-us/salesforce-connector/11.4/_images/salesforce-connector-10-set-fields-to-null.png) Figure 1. Specify the field names you want to nullify in the **Transform Message** component **fieldsToNull** field. ## Generate a Keystore File Salesforce Connector uses the Bouncy Castle cryptographic library to load the certificate from the keystore and sign the payload for the authentication requests. The library has a [vulnerability (CVE-2018-5382)](https://nvd.nist.gov/vuln/detail/CVE-2018-5382) that relates to the BKS-V1 keystore file type. By default, Salesforce Connector uses JKS or PKCS12 keystores. Avoid using BKS-V1 keystore files, as documented in the [Bouncy Castle proposed solution](https://www.kb.cert.org/vuls/id/306792). To generate a JKS keystore file: 1. Go to your Mule workspace and open the command prompt (for Windows) or Terminal (for Mac). 2. Enter this command: ```none keytool -genkeypair -alias salesforce-cert -keyalg RSA -keystore salesforce-cert.jks ``` 3. Enter the following information: - Password for the keystore - Your first name and last name - Your organization unit - Your city and state, and the two-letter code for your country The system generates a Java keystore file (JKS format) that contains a private or public key pair in your workspace. 4. Provide the file path for the keystore in your connector configuration. Enter this command: ```none keytool -exportcert -alias salesforce-cert -file salesforce-cert.crt -keystore salesforce-cert.jks ``` The system exports the public key from the keystore into the workspace. This is the public key to enter in your Salesforce instance. 5. Verify that you have both the keystore (`salesforce-cert.jks`) and the public key (`salesforce-cert.crt`) files in your workspace. ## Invoke APEX Rest Method The Invoke APEX Rest operation enables users to invoke a method from an Apex class that is exposed as a REST service. The following example shows a payload for this operation: ```example ``` In this example: - The `body` element contains `URLParameters`, which is a map containing the parameters that replace the wildcards in the path of the REST resource described in the Apex class. For example, if the REST resource is set to `@RestResource(urlMapping='/myResource/*/mySubResource/*')`, the value of `Parameter1` replaces the first `*`, and the value of `Parameter2` replaces the second `*`. - Key names must start with `Parameter`, followed by a number that shows the position of the `*` to be replaced. - After the `URLParameters` block, provide the content of the `body` value to send to the REST resource, as shown in the example `account` block. - The `headers` and `cookies` fields describe the headers and cookies to pass along with the HTTP request to the desired service. - The `queryParameters` field describes the query parameters to use, and the keys and values in this map that the specified Apex Class must accept. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.4 --- # Salesforce Connector 11.4 Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt These examples show several Mule flows for Salesforce Connector: - [Accept and Transform Data](#accandtrans) - [Create or Update an Object in a Parent-Child Relationship](#parentchild) - [Delete Accounts](#delete-accounts) - [Find Duplicate Accounts](#find-duplicate-accounts) ## Accept and Transform Data This example shows how to configure Salesforce Connector to create a new Salesforce account and query new accounts, and to use [File Connector](https://docs.mulesoft.com/file-connector/latest/) to write the new account data to a file. The example contains three flows: - The first flow configures a template for the HTML input form used to provide data for the new account. - The second flow creates a new Salesforce account based on information in the HTML input form. - The third flow queries new accounts by name and writes new account data to a CSV file. ![Accept and transform data flows](/mulesoft/current/en-us/salesforce-connector/11.4/_images/accept-and-transform-data-flows.png) ### Configure the First Flow Configure the first flow that configures an HTML template that provides the data used to create a new account. Creating the first flow involves configuring a **Listener** component and a **Parse Template** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/account` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/account`. #### Add the Parse Template Component Add the **Parse Template** component to create a template for an HTML form (`form.html`), which is located in the main resources folder and is used to convey information for creating a new account: 1. From the **Mule Palette** view, select **Core** and drag a **Parse Template** component to the right of **Listener**. 2. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the component, such as Parse Template.

Location

form.html

The following image shows an example of the **Parse Template** configuration in the properties window: ![Parse Template properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.4/_images/parse-template-properties-window.png) ### Configure the Second Flow Configure the second flow that creates a new Salesforce account based on the data in the HTTP input form. Creating the second flow involves configuring a **Listener** component, a **Transform Message** component, a **Create** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/createAccount` path: 1. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Accept the defaults. 4. In the properties window, set the **Path** field value to `/createAccount`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Create** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [{ Name: payload.Name, AccountNumber: payload.AccountNumber, BillingCity: payload.BillingCity }] ``` #### Add the Create Operation Add the **Create** operation to create a new Salesforce account using the field values passed by the **Transform Message** component: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Create** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Create** configuration of the global element: ![Create global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.4/_images/create-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

You can successfully pass a variable into Type, but there could be an issue when displaying the input metadata if the runtime fails to properly resolve the value of that variable.

Records

payload

The following image shows an example of the **Create** configuration in the properties window: ![Create properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.4/_images/create-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the field values to JSON format so the values can be used with [File Connector](https://docs.mulesoft.com/file-connector/latest/): 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Create**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { id:$.id, errors:$.errors, success:$.success } ``` ### Configure the Third Flow Configure the third flow that queries new Salesforce accounts by name and writes the matching accounts data to a Java file. Creating the third flow involves configuring an **On New Object** source, a **Query result list** operation, a **Query result stream by id** operation, a **Transform Message** component, and a **Write** operation. #### Configure the On New Object Source Configure the **On New Object** source to initiate a Mule flow when a new account is created on the `/account` path: 1. From the **Mule Palette** view, select **Salesforce** and drag the **On New Object** source to the canvas. 2. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

The following image shows an example of the **On New Object** configuration in the properties window: ![On New Object properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.4/_images/on-new-object-properties-window.png) #### Add the Query Result List Operation Add the **Query result list** operation to return a list of result IDs: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Query result list** operation to the right of **On New Object**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Query result list** configuration of the global element: ![Query result list global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.4/_images/query-result-list-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Batch info

payload

The following image shows an example of the **Query result list** configuration in the properties window: ![Query result list properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.4/_images/query-result-list-properties-window.png) #### Add the Query Result Stream by Id Operation Add the **Query result stream by id** operation to obtain the final query results: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Query result stream by id** operation to the right of **Query result list**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Query result stream by id** configuration of the global element: ![Query result stream by id global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.4/_images/query-result-stream-by-id-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Batch info

payload

The following image shows an example of the **Query result stream by id** configuration in the properties window: ![Query result stream by id properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.4/_images/query-result-stream-by-id-properties-window.png) #### Add the Transform Message Component Add the **Transform Message** component to convert the field values to JSON format so the values can be used with [File Connector](https://docs.mulesoft.com/file-connector/latest/): 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Query result stream by id**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { AccountNumber:$.AccountNumber, BillingAddress:$.BillingAddress, Id:$.Id, Name:$.Name } ``` #### Add the Write Operation Add the **Write** operation to write the new account data to a CSV file: 1. From the **Mule Palette** view, select **File** and drag the **Write** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Working Directory

If Connection is selected, the directory to consider the root of every relative path used with this connector. If not provided, it defaults to the value of the user.home system property. If that system property is not set, then the connector fails to initialize.

The following image shows an example of the **Write** configuration of the global element: ![Write global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.4/_images/write-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Path

/account

Content

payload

The following image shows an example of the **Write** configuration in the properties window: ![Write properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.4/_images/write-properties-window.png) ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Create or Update an Object in a Parent-Child Relationship This example shows how to create the object relationship structure in Salesforce needed to perform an upsert using Salesforce Connector. ![Create or Update an Object in a Parent-Child Relationship flow](/mulesoft/current/en-us/salesforce-connector/11.4/_images/create-update-flow.png) ### Configure the Flow A Salesforce object can have standard or custom relationships between objects. The relationships between objects are usually one-to-many (parent-child) relationships, but can be any link between two objects residing in Salesforce. The example uses two custom Salesforce object types that have a parent-child relationship: - `Plane__c`, the parent object that must exist in Salesforce - `Component__c`, the object to upsert using Salesforce Connector The relationship between the two custom objects is represented by a `Plane__r` field whose value is an object with two fields: - The `type` field, which has the referenced object type name as its value. In this example, the value of `type` is `Plane_c`. - A field that identifies the instance of the parent object to reference. In this example, the `Name` field references the `Cobra` instance of `Plane__c`. When you upsert `Component__c`, the POJO sent as input to Salesforce Connector looks like this: ```linenums ---- [{ // Component__c's fields ... Plane__r: { "type": "Plane__c", "Name": "Cobra" } }] ---- ``` Creating the flow involves configuring a **Listener** component, a **Transform Message** component, an **Upsert** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Upsert** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [{ Name: "NewPlaneComponent", Plane__r: { "type": "Plane__c", "Name": "Cobra" } }] ``` #### Add the Upsert Operation Add the **Upsert** operation to create or update a Salesforce object that is in a parent-child relationship: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Upsert** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Upsert** configuration of the global element: ![Upsert global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.4/_images/upsert-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Object type

Component_c

External id field name

Id

Records

payload

The following image shows an example of the **Upsert** configuration in the properties window: ![Upsert properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.4/_images/upsert-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Upsert**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Delete Accounts This example shows how to use Salesforce Connector to delete Salesforce accounts. ![Delete Accounts flow](/mulesoft/current/en-us/salesforce-connector/11.4/_images/delete-accounts-flow.png) ### Configure the Flow Creating the flow involves configuring a **Listener** component, a **Transform Message** component, a **Delete** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Delete** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [payload.Id] ``` #### Add the Delete Operation Add the **Delete** operation to delete Salesforce accounts: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Delete** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Delete** configuration of the global element: ![Delete global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.4/_images/delete-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Records to Delete Ids

payload

The following image shows an example of the **Delete** configuration in the properties window: ![Delete properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.4/_images/delete-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Delete**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { id:$.id, errors:$.errors, success:$.success } ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Find Duplicate Accounts This example shows how to use Salesforce Connector to find duplicate Salesforce accounts. ![Find Duplicate Accounts flow](/mulesoft/current/en-us/salesforce-connector/11.4/_images/find-duplicates-accounts-flow.png) ### Configure the Flow Creating the flow involves configuring a **Listener** component, a **Transform Message** component, a **Find duplicates** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/findDuplicates` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/findDuplicates`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Delete** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [ payload ] ``` #### Add the Find Duplicates Operation Add the **Find duplicates** operation to find duplicate Salesforce accounts: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Find duplicates** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Find duplicates** configuration of the global element: ![Find Duplicates global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.4/_images/find-duplicates-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

Criteria

payload

The following image shows an example of the **Find duplicates** configuration in the properties window: ![Find Duplicates properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.4/_images/find-duplicates-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Find duplicates**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- { success: payload.success, duplicateResults: { (payload.duplicateResults map { matchRecords: $.matchResults } ) }, duplicateRuleEntityType: payload.duplicateRuleEntityType, duplicateRule: payload.duplicateRule, allowSave: payload.allowSave, errorMessage: payload.errorMessage } ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.4 --- # Salesforce Connector 11.4 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt > [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality. > We maintained certain terms to avoid any effect on customer implementations. Anypoint Connector for Salesforce (Salesforce Connector) simplifies and accelerates integration across Sales Cloud, Service Cloud, Salesforce Platform, and Force.com. With comprehensive access to Salesforce entities, this connector streamlines automation of business processes—helping you unlock more value from your Salesforce investments, empower your sales teams, increase revenue, and provide better customer service. ## Configuration Default Configuration for Salesforce Connector.
NameTypeDescriptionDefault ValueRequired

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Read Timeout

Number

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

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

SECONDS

Name

String

Identifier of this element used to reference it in other components.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Fetch All Apex SOAP Metadata

Boolean

If true, DataSense is performed for all Apex classes in the organization. If false, DataSense is performed only for classes in Apex Class Names. If the organization contains many Apex classes, this might cause a ConnectionTimeout during DataSense.

false

Fetch All Apex REST Metadata

Boolean

If true, DataSense is performed for all Apex classes in the organization. If false, DataSense is performed only for classes in Apex Class Names. If the organization contains many Apex classes, this might cause a ConnectionTimeout during DataSense.

false

Apex Class Names

Array of String

List of Apex class names involved in metadata retrieval via DataSense.

Include null values

Boolean

Includes null values in the Apex Rest API request. This parameter applies to the Invoke Apex Rest Method operation only.

false

### Basic Authentication Connection Type (Supported by Salesforce API v64.0 and below) Uses a username and a password for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP is allowlisted on Salesforce.

Authorization URL

String

Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, https://login.salesforce.com/services/Soap/u/66.0. Always use lowercase when specifying the protocol (e.g., http, https).

Session Id

String

Value that identifies an active Salesforce session.

Service Endpoint

String

Specifies the service endpoint. This value is used only if the Session Id configuration property is used.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth v2.0 Connection Type Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint. Always use lowercase when specifying the protocol (e.g., http, https).

https://login.salesforce.com/services/oauth2/authorize

Access Token Url

String

URL of the service provider’s access token endpoint. Always use lowercase when specifying the protocol (e.g., http, https).

https://login.salesforce.com/services/oauth2/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after receiving an access token.

Listener Config

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

### OAuth JWT Connection Type Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication. > [!NOTE] Salesforce Connector supports providing a signed certificate only if you use the > `SHA256withRSA` algorithm for the OAuth JWT connection type. You can only enable **JSON Web Token-based access tokens** option on Salesforce server for REST API calls. This option isn’t compatible with Salesforce Connector.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Certificate Alias

String

Alias of the certificate.

Principal

String

Username of the desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

Audience Url

String

URL that identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.

Use the authorization server’s URL for the audience value if implementing for a community: https://login.salesforce.com, https://test.salesforce.com, or https://community.force.com/customers.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth Client Credentials Uses a client ID and client secret for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Client ID

String

The OAuth client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret that corresponds to the client ID.

x

Token URL

String

Service provider’s token endpoint URL. Always use lowercase when specifying the protocol (e.g., http, https).

https://{domain}.my.salesforce.com/services/oauth2/token

Scopes

String

The OAuth scopes to request during the OAuth dance.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

### OAuth Username Password Connection Type Uses OAuth 2.0 with a user and password for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Consumer Secret

String

Your application’s client secret (consumer secret in Remote Access Detail).

x

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP is allowlisted on Salesforce.

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth SAML Connection Type > [!NOTE] OAuth SAML currently uses only Salesforce as an identity provider. Refer to > [Salesforce as a SAML Identity Provider](https://help.salesforce.com/s/articleView?id=xcloud.sso_sfdc_idp_saml_parent.htm&type=5) > to enable Salesforce as an identity provider. Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Certificate Alias

String

Alias of the certificate.

Principal

String

Username of the desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

## Sources - [On Deleted Object](#deleted-object-listener) - [On Modified Object](#modified-object-listener) - [On New Object](#new-object-listener) - [Replay Channel Listener](#replay-channel-listener) - [Replay Topic Listener](#replay-topic-listener) > [!NOTE] The **On Deleted Object**, **On Modified Object**, and **On New Object** sources in > Salesforce Connector use Object Store to save watermarks. You might experience limitations that > are specific to the Object Store implementation you are using (Object Store for CloudHub > deployments or Object Store for on-premises deployments), so configure Object Store to suit your > needs. > For more information, see > [The Different Types of Object Stores Explained](https://help.salesforce.com/s/articleView?id=001123185&type=1). ### On Deleted Object `` Source that adds one or more `whereConditions` in the query calling the method.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### On Modified Object `` Source for modified objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### On New Object `` Source for new objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### Replay Channel Listener `` Source that subscribes to a streaming channel. First, the streaming channel must be published, and after that, a subscription to that streaming channel must be created. Salesforce allows you to subscribe to a nonexistent streaming channel but won’t send you notifications after the topic is created.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Streaming Channel

String

Name of the streaming channel to subscribe to.

x

Cache Events In Memory

Boolean

When the processing flow is slow, cache events in memory to reduce quota consumption.

false

Replay Option

Enumeration, one of:

  • ONLY_NEW

  • ALL

  • FROM_REPLAY_ID

  • FROM_LAST_REPLAY_ID

  • ONLY_NEW: -1

    Subscriber receives new events that are broadcast after the client subscribes.

  • ALL: -2

    Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription.

  • FROM_REPLAY_ID

    Subscriber receives only events that have a replay ID value greater than the specified replay ID.

  • FROM_LAST_REPLAY_ID

    Subscriber uses the highest replay ID stored in the object store regardless of whether it is processed successfully or not.

x

Replay Id

String

Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to ALL or ONLY_NEW.

Replay Failed Events If Any or Resume from Last Replay Id

Boolean

If true, the source starts consuming data with any failed events (if any) or starts consuming data from the last replay ID that is processed successfully.

false

The size (in bytes) of the event queue (DEPRECATED)

Number

In previous versions, this field was used to specify the size of the event queue which can lead to memory issues. Now, the messages are streamed and no buffering is needed.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

true

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Throw Exception When Organization Daily Limit Exceeded

Boolean

Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded.

false

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Attributes

Object

Attributes.

#[message.attributes]

#### Output

Type

Any

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### Replay Topic Listener `` Salesforce stores events for 24 hours and enables you to retrieve stored and new events. Source in which subscribers choose which events to receive by using replay options.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Topic

String

Name of the topic to subscribe to.

x

Cache Events In Memory

Boolean

When the processing flow is slow, cache events in memory to reduce quota consumption.

false

Replay Option

Enumeration, one of:

  • ONLY_NEW

  • ALL

  • FROM_REPLAY_ID

  • FROM_LAST_REPLAY_ID

  • ONLY_NEW: -1

    Subscriber receives new events that are broadcast after the client subscribes.

  • ALL: -2

    Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription.

  • FROM_REPLAY_ID

    Subscriber receives only events that have a replay ID value greater than the specified replay ID.

  • FROM_LAST_REPLAY_ID

    Subscriber uses the highest replay ID stored in the object store regardless of whether it is processed successfully or not.

x

Replay Id

String

Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to ALL or ONLY_NEW.

Replay Failed Events If Any or Resume from Last Replay Id

Boolean

If true, the source starts consuming data with any failed events (if any) or starts consuming data from the last replay ID that is processed successfully.

false

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

true

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Throw Exception When Organization Daily Limit Exceeded

Boolean

Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded.

false

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Attributes

Object

Attributes.

#[message.attributes]

#### Output

Type

Any

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ## Operations > [!NOTE] If you set `LocalDate` for a field in the payload, the input time is automatically > converted to `GMT` or the server’s time zone based on the Gregorian calendar. This conversion > impacts date calculations or comparisons in Salesforce Connector operations, as `LocalDate` is > adjusted to align with the server’s time zone or defaults to GMT. - [Abort Job](#abortJob) - [Abort Job Bulk Api V2](#abortJobBulkApiV2) - [Abort Query Job Bulk Api V2](#abortQueryJobBulkApiV2) - [Batch Info](#batchInfo) - [Batch Info List](#batchInfoList) - [Batch Result](#batchResult) - [Batch Result Stream](#batchResultStream) - [Change Own Password](#changeOwnPassword) - [Close Job](#closeJob) - [Convert Lead](#convertLead) - [Create](#create) - [Create Batch](#createBatch) - [Create Batch For Query](#createBatchForQuery) - [Create Batch Stream](#createBatchStream) - [Create Job](#createJob) - [Create Job Bulk Api V2](#createJobBulkApiV2) - [Create Metadata](#createMetadata) - [Create Query Job Bulk Api V2](#createQueryJobBulkApiV2) - [Delete](#delete) - [Delete Job Bulk Api V2](#deleteJobBulkApiV2) - [Delete Metadata](#deleteMetadata) - [Delete Query Job Bulk Api V2](#deleteQueryJobBulkApiV2) - [Deploy Metadata](#deployMetadata) - [Describe Global](#describeGlobal) - [Describe Metadata](#describeMetadata) - [Describe Sobject](#describeSobject) - [Find Duplicates](#findDuplicates) - [Find Duplicates By Ids](#findDuplicatesByIds) - [Get All Jobs Bulk Api V2](#getAllJobsBulkApiV2) - [Get All Query Jobs Bulk Api V2](#getAllQueryJobsBulkApiV2) - [Get Deleted](#getDeleted) - [Get Job State Bulk Api V2](#getJobStateBulkApiV2) - [Get Query Job Info Bulk Api V2](#getQueryJobInfoBulkApiV2) - [Get Query Job Results Bulk Api V2](#getQueryJobResultsBulkApiV2) - [Get Server Timestamp](#getServerTimestamp) - [Get updated objects](#getUpdated) - [Get User Info](#getUserInfo) - [Invoke Apex Rest Method](#invokeApexRestMethod) - [Invoke Apex Soap Method](#invokeApexSoapMethod) - [Job Info](#jobInfo) - [List Metadata](#listMetadata) - [Merge](#merge) - [Merge Multiple](#mergemultiple) - [Publish Platform Event Message](#publishPlatformEventMessage) - [Publish Streaming Channel](#publishStreamingChannel) - [Publish Topic](#publishTopic) - [Push Generic Event](#pushGenericEvent) - [Query (Deprecated)](#query) - [Query All](#queryAll) - [Query Result List](#queryResultList) - [Query Result Stream By Id](#queryResultStreamById) - [Query Xml Stream](#queryXmlStream) - [Read Metadata](#readMetadata) - [Rename Metadata](#renameMetadata) - [Reset Password](#resetPassword) - [Retrieve](#retrieve) - [Retrieve Job Failed Results Bulk V2](#retrieveJobFailedResultsBulkV2) - [Retrieve Job Successful Results Bulk V2](#retrieveJobSuccessfulResultsBulkV2) - [Retrieve Job Unprocessed Results Bulk V2](#retrieveJobUnprocessedResultsBulkV2) - [Retrieve Metadata](#retrieveMetadata) - [Search](#search) - [Set Password](#setPassword) - [Unauthorize](#unauthorize) - [Update](#update) - [Update Metadata](#updateMetadata) - [Upsert](#upsert) - [Upsert Metadata](#upsertMetadata) ### Abort Job `` Aborts an open job given its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID that identifies the job to abort.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Abort Job Bulk Api V2 `` Aborts an ongoing Bulk API v2 Job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Abort Query Job Bulk Api V2 `` Abort the indicated query job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job to abort.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job Info

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Info `` Accesses the latest BatchInfo of a submitted BatchInfo. Enables you to track the execution status.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo that is monitored.

#[payload]

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Info List `` Gets information about all batches in a job.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job Id

String

ID of the job to retrieve batch information for.

x

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Result `` Accesses `com.sforce.async.BatchResult` of a submitted BatchInfo.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch To Retrieve

com.sforce.async.BatchInfo that is monitored.

#[payload]

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Result Stream `` Accesses `com.sforce.async.BatchResult` of a submitted BatchInfo.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch To Retrieve

com.sforce.async.BatchInfo that is monitored.

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Change Own Password `` Changes the password of the user linked to the connector’s configuration.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Old Password

String

Old password to change.

x

New Password

String

New password to change.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Close Job `` Closes an open job given its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID identifying the job to close.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Convert Lead `` Converts a lead into an account, contact, or (optionally) an opportunity.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Lead Convert Request

Information for lead conversion.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Lead Convert Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Create `` Adds one or more new records to your organization’s data. > [!IMPORTANT] When you map your objects to the input of this message processor, the objects must > match the expected type of the object at Salesforce. For example, if you set the **CloseDate** > field of an opportunity to a string of value `2011-12-13`, it is sent to Salesforce as a string. > The operation is rejected because the CloseDate is not of the expected type. The correct way to > map it is to generate a Java Date object. You can do so using the Groovy expression evaluator as > `#[groovy:Date.parse("yyyy-MM-dd", "2011-12-13")]`.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to add.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Create Batch `` Creates a batch using the given objects within the specified Job. The job can be of XML or CSV type. This call uses the Bulk API. This operation is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

com.sforce.async.JobInfo in which the batch is created. The job can be of XML, JSON, or CSV type.

x

SObjects

Array of Object

List of one or more SObject objects.

#[payload]

SObject Max Depth

Number

Asynchronous SObject recursive MAX_DEPTH check.

5

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Batch For Query `` Creates a batch using the given query. This call uses the Bulk API. This operation is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

JobInfo in which the batch is created.

x

Query

String

Query to execute.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Batch Stream `` Creates a batch using the given stream within the specified job. The stream can have a CSV, XML, ZIP\_CSV, or ZIP\_XML format. This call uses the Bulk API and is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

JobInfo in which the batch is created.

#[payload]

x

Stream

Any

Stream containing the data. The stream can have a CSV, XML, ZIP_CSV, or ZIP_XML format.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Job `` Creates a job to perform one or more batches through Bulk API operations.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

  • queryAll

OperationEnum that is executed by the job.

x

Type

String

Type of Salesforce object that the job processes.

x

Create Job Request

Creates the job request.

If you input the value in literal mode, an example value is:

{
    “externalIdFieldName”: “employeeId”,
    “contentType”: “XML”,
    “concurrencyMode”: “Serial”
}

If you input the value in expression mode, then the input can be dynamic using output application/json or output application/java, and can be transformed into the required input.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Job Bulk Api V2 `` Creates a Bulk API v2 job containing the data to insert, update, delete, or upsert. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Type of object to work with.

x

sObjects

Binary

Array of one or more SObject objects.

#[payload]

Operation

Enumeration, one of:

  • insert

  • update

  • delete

  • hardDelete

  • upsert

Operation to execute.

x

Line Ending

String

Line ending of CSV data.

LF

Column Delimiter

String

Column delimiter of CSV data.

COMMA

Assignment Rule Id

String

ID of an assignment rule to run for a case or a lead. The assignment rule can be active or inactive.

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the ID lookup field property for standard objects.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Salesforce headers. For information, see Create a Job in the Salesforce documentation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Metadata `` Adds one or more new metadata components to your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type to create.

x

Metadata Objects

Array of Object

List of Map<String,Object> representing the metadata to create.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Create Query Job Bulk Api V2 `` Creates a query job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Query

String

Query used to create the job.

x

Operation

Enumeration, one of:

  • QUERY

  • QUERY_ALL

Operation used.

QUERY

Column Delimiter

String

Type of delimiter used.

COMMA

Line Ending

String

Line ending used.

CRLF

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Salesforce headers. For information, see Create a Query Job in the Salesforce documentation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job State

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Delete `` Deletes one or more records from your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Records To Delete Ids

Array of String

Array of one or more IDs associated with the objects to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Delete Job Bulk Api V2 `` Deletes a Bulk API v2 Job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Delete Metadata `` Deletes one or more metadata components from your organization, given the API name of the objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to delete.

x

Full Names

Array of String

Full names of the components to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Delete Query Job Bulk Api V2 `` Deletes a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Deploy Metadata `` A file-based call to deploy XML components. Use this operation to take file representations of components and deploy them into an organization by creating, updating, or deleting the components they represent.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Deploy Metadata Request

Data needed by this operation.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Global `` Retrieves a list of available objects for your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe Global Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Metadata `` Retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other components.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Sobject `` Describes metadata (field list and object properties) for the specified object.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Object. The specified value must be a valid object for your organization. For a complete list of objects, see Standard Objects.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe S Object Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Find Duplicates `` Performs rule-based searches for duplicate records. The input is an array of Salesforce objects, each of which specifies the values to search for and the type of object that supplies the duplicate rules. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the values to do the search. The output identifies the detected duplicates for each SObject.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of SObjects to find duplicates for.

x

Criteria

Array of Object

List of SObjects used as a criterion when searching for duplicates.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Find Duplicates Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Find Duplicates By Ids `` Performs rule-based searches for duplicate records. The input is an array of IDs, each of which specifies the records for which to search for duplicates. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the record IDs to do the search. The output identifies the detected duplicates for each ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Ids List

Array of String

List of IDs to find duplicates.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Find Duplicates Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get All Jobs Bulk Api V2 `` Retrieves all Bulk jobs. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Desired concurrency mode.

Parallel

Pk Chunking

Boolean

Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Bulk Job V2 Result

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get All Query Jobs Bulk Api V2 `` Retrieves all Bulk query jobs.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Pk Chunking

Boolean

Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Job Type

Enumeration, one of:

  • BigObjectIngest

  • Classic

  • V2Query

Job type.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Desired concurrency mode.

Parallel

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Query Jobs Info Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Deleted `` Retrieves the list of records deleted from a particular time in the past (specified in minutes).
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type. The specified value must be a valid object for your organization.

x

Start Date

DateTime

Starting date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

x

End Date

DateTime

Ending date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC).

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get Deleted Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get Job State Bulk Api V2 `` Gets the state of a v2 Bulk job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Query Job Info Bulk Api V2 `` Returns the details of a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Query Job Results Bulk Api V2 `` Returns the results of a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Max Records Per Page

Number

Number of records that are on each page retrieved from the API. This number influences the number of API requests and the memory used by the connector to handle the results.

Salesforce Connector automatically handles pagination and retrieves all pages before the next processing job starts.

2000

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Server Timestamp `` Retrieves the current system timestamp, in Coordinated Universal Time (UTC), from the API.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

DateTime

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get updated objects `` Retrieves the list of individual records that are created or updated between the specified start and end date.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type. The specified value must be a valid object for your organization.

x

Start Date

DateTime

Starting date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

x

End Date

DateTime

Ending date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If a value is not provided, the current server time is used.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get Updated Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get User Info `` Retrieves personal information for the user associated with the current session.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get User Info Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Invoke Apex Rest Method `` Invokes any operation from an Apex class that is exposed as a REST web service.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Request

Object

Object containing request information, some of which can include object queryParams with key-value pairs. These parameters are passed as URL parameters to the Apex Rest endpoint, for example:

queryParams: {AccountId : "a0w0E0000069MDxQAM" , ContactId: "0030E00000rRSJ6QAO" }

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Apex Class Name

String

Apex class name.

x

Apex Class Method Name

String

Apex class method name. The method name format is:

ApexMethodName^RestResourceURL^HttpMethod^OutputType^InputParameterName1=ParameterType1,InputParameterName2=ParameterType2

For example:

getAccountInfo^/accountInfo/*^HttpGet^void

Special characters aren’t allowed in ApexMethodName.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Invoke Apex Soap Method `` Invokes any operation from an Apex class that is exposed as a SOAP web service.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Input

Binary

InputStream with XML that contains information about the method to invoke and its parameters. The XML must adhere to the WSDL standards.

#[payload]

Apex Headers

Object

Parameters specifying the SOAP Headers to send to the API. For more information about the supported headers, see SOAP API and SOAP Headers for Apex.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Apex Class Name

String

Apex class name.

x

Apex Class Method Name

String

Apex class method name.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Job Info `` Accesses the latest JobInfo of a submitted JobInfo ID. This operation enables you to track the execution status.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID of the job that is monitored.

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### List Metadata `` Retrieves property information about metadata components in your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type used as a criterion when querying for information.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of File Properties

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Merge `` Merges up to three records into one record.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Records To Merge Ids

Array of String

List of IDs of the objects to merge.

#[payload]

Type

String

Type of record to merge.

x

Master Record

Object

Must provide the ID of the object that other records are merged into. Optionally, provide the fields to update and their values.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Merge Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Merge Multiple `` Combines up to three records of the same type into one record. The input is an array of MergeRequest elements, each of which specifies the records to combine. #### Limitations - The only supported object types are: - Lead - Contact - Account - Person Account - Individual Only objects of the same type can be merged. For example, merge leads only with leads. - The **Merge Multiple** operation enables you to specify a list of a maximum of 200 merge requests. - A merge request can contain a maximum of three IDs: - The master record ID - Up to two IDs for the records to merge into the primary record
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

List of Merge Records

Array of Merge Record

List of merge records. Each merge record contains the primary record, the record to merge IDs into, and an optional additional information map.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Map<String, Object>

Declares the request headers to use with this operation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Merge Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Platform Event Message `` Adds one new platform event to your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Platform Event name

String

Name of the platform event to create.

x

Platform Event Message

Array of Object

List<PlatformEventMessage> to create.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Streaming Channel `` Creates a streaming channel in which generic, custom messages are pushed.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Channel name

String

Descriptive name of the streaming channel. Limit of 80 characters, and must start with /u/. This value identifies the channel and must be unique.

x

Owner Id

String

Identifier for the channel owner.

Description

String

Description of what kinds of records are returned by the query. Limit of 255 characters.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Topic `` Creates a topic representing a query that is used to notify listeners when changes are made to records in an organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Topic Name

String

Topic name.

x

Query

String

Query name.

x

Description

String

Description.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Push Generic Event `` Pushes generic streaming custom events to the specified streaming channel.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Events

Event list.

#[payload]

Channel Id

String

Streaming channel name.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Push Event Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query (Deprecated) `` Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are strings and, if necessary, you can convert them to the appropriate type, for example, by using DataWeave and **Transform Message**. The **Query** operation is now deprecated. Use the [**Query Xml Stream**](#queryXmlStream) operation instead.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query All `` Retrieves data from specified objects, whether or not they have been deleted.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query Result List `` Returns a list of result IDs for a specific batch. If the batch requires retries, there is more than one element in the output. Use this operation with [Query Result Stream By Id](#queryResultStreamById) to obtain the results of the query.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo to retrieve the results for.

#[payload]

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation.

XML

Output Mime Type

String

MIME type of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of a variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of String

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Query Result Stream By Id `` Returns an InputStream with the query results for a specific result ID of a submitted BatchInfo. Obtain the result IDs first by using the [Query Result List](#queryResultList) operation.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo that returns the result ID.

#[payload]

x

Result ID

String

Result ID obtained with Query Result List.

x

Output Mime Type

String

MIME type of the payload output of this operation.

Output Encoding

String

Encoding of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configure how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of a variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Binary

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Query Xml Stream `` Executes a query against the specified object and returns data that matches the specified criteria. This operation returns paginated results. Each result is an InputStream of XML records.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Output Mime Type

String

MIME type of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Headers

Object

Headers to include in the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of String payload and Void attributes

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED - SALESFORCE:RETRY\_EXHAUSTED ### Read Metadata `` Returns one or more metadata components from your organization, given the objects' API names.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to read.

x

Full Names

Array of String

List of full names of the components to read.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Rename Metadata `` Renames a metadata component in your organization, given its old API name and the new name.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the component to rename.

x

Old Full Name

String

Current component full name.

x

New Full Name

String

New component full name.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Reset Password `` Resets the password of the user corresponding to the provided user ID, or the user linked to the connector’s configuration, if the user ID field is null.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User to reset the password for. If unspecified, the current user is used.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Reset Password Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Retrieve `` Retrieves one or more records based on the specified IDs.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to retrieve.

x

Retrieve Request

Must provide the IDs and specify the fields for the records to retrieve.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Retrieve Job Failed Results Bulk V2 `` Gets the status of the failed processed SObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Job Failed Record Results

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Job Successful Results Bulk V2 `` Gets the status of the successfully processed SObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Job Successful Record Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Job Unprocessed Results Bulk V2 `` Gets the status of the unprocessed sObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Metadata `` Retrieves XML file representations of components in an organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Package Names

Array of String

List of package names to retrieve. If you are retrieving only unpackaged components, do not specify a name. You can retrieve packaged and unpackaged components in the same retrieval operation.

Specific Files

Array of String

List of file names to retrieve. If a value is specified for this property, Package Names must be set to null.

Unpackaged

Binary

Stream containing a list of components to retrieve that are not in a package.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Binary

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Search `` Searches for objects using Salesforce Object Search Language (SOSL). Mimics using the search box inside the Salesforce UI.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Search String

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Search Language (SOSL).

x

Parameters

Object

Map with values for placeholders in Search String.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Search Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Set Password `` Changes the password of a user or a self service user to a value that you specify.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User to set the password for.

x

New Password

String

New password for the user.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Unauthorize `` Deletes all of the access token information of a given resource owner ID so that it is impossible to execute an operation for that user without performing the OAuth dance.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner for whom to invalidate access.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

#### Associated Configurations - [Configuration](#sfdc-config) ### Update `` Updates one or more existing records in your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to update.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Update Metadata `` Updates one or more metadata components in your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to update.

x

Metadata Objects

Array of Object

List of Map<String, Object> representing the metadata to update.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Upsert `` Upserts a homogeneous list of objects. Creates new records and updates existing records using a custom field to determine the presence of existing records. In most cases, use `#upsert(String, String, List, Map)` over `#create(String, List, Map)` to avoid creating unwanted, duplicate records. > [!NOTE] Although you cannot change the **Content Type** value for a bulk upsert, you can use the > [**Create Job**](#createJob) operation to set the content type to CSV (or zipped CSV if you reach > the character limit) and then follow up with the [**Create Batch**](#createBatch) operation.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Type of record to upsert.

x

External Id Field Name

String

Either of the following:

  • For a custom object, the name of the field that contains the external ID field name

  • For a standard object, the name of the field that contains the ID lookup field name

Unless you configure the External Id Field Name field for the SObject to upsert, the Upsert operation fails.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Upsert Metadata `` Creates or updates one or more metadata components in your organization. For a picklist field in an object, the **Upsert Metadata** operation updates only the picklist mapping for that specific object. To update the actual picklist values, such as adding or removing values in the picklist, use the [**Deploy Metadata**](#deployMetadata) operation. You must perform a metadata deploy for **Custom Field** or **Global Picklist** based on whether the picklist is tied to a custom field or is a global picklist.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to create or update.

x

Metadata Objects

Array of Object

List of Map<String, Object> representing the metadata to upsert.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Upsert Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ## Object Types - [Action Override](#ActionOverride) - [Additional Information Map](#AdditionalInformationMap) - [Batch Info](#BatchInfo) - [Bulk Item](#BulkItem) - [Bulk Job State](#BulkJobState) - [Bulk Job V2 Result](#BulkJobV2Result) - [Bulk Operation Result](#BulkOperationResult) - [Child Relationship](#ChildRelationship) - [Create Job Request](#CreateJobRequest) - [CRL File](#crl-file) - [Cron](#cron) - [Custom OCSP Responder](#custom-ocsp-responder) - [Deleted Record](#DeletedRecord) - [Deploy Metadata Request](#DeployMetadataRequest) - [Describe Global Result](#DescribeGlobalResult) - [Describe Global S Object Result](#DescribeGlobalSObjectResult) - [Describe Metadata Object](#DescribeMetadataObject) - [Describe Metadata Result](#DescribeMetadataResult) - [Describe S Object Result](#DescribeSObjectResult) - [Duplicate Result](#DuplicateResult) - [Entity Search Metadata](#EntitySearchMetadata) - [Error](#Error) - [Error Mapping](#ErrorMapping) - [Expiration Policy](#ExpirationPolicy) - [Field](#Field) - [Field Diff](#FieldDiff) - [Field Level Search Metadata](#FieldLevelSearchMetadata) - [File Properties](#FileProperties) - [Filtered Lookup Info](#FilteredLookupInfo) - [Find Duplicates Result](#FindDuplicatesResult) - [Fixed Frequency](#fixed-frequency) - [Generic Streaming Event](#GenericStreamingEvent) - [Get Deleted Result](#GetDeletedResult) - [Get Updated Result](#GetUpdatedResult) - [Get User Info Result](#GetUserInfoResult) - [Job Failed Record Results](#JobFailedRecordResults) - [Job Info](#JobInfo) - [Job Successful Record Result](#JobSuccessfulRecordResult) - [Job Unprocessed Record Result](#JobUnprocessedRecordResult) - [Keystore](#KeyStore) - [Labels Search Metadata](#LabelsSearchMetadata) - [Lead Convert Result](#LeadConvertResult) - [Lead Convert Request](#LeadConvertRequest) - [Match Record](#MatchRecord) - [Match Result](#MatchResult) - [Merge Record](#MergeRecord) - [Merge Result](#MergeResult) - [Metadata Result](#MetadataResult) - [Name Value Pair](#NameValuePair) - [Named Layout Info](#NamedLayoutInfo) - [Non-Repeatable Stream](#non-repeatable-stream) - [Pick List Entry](#PickListEntry) - [Proxy](#ProxyConfiguration) - [Push Event Result](#PushEventResult) - [Query Job Info](#QueryJobInfo) - [Query Job State](#QueryJobState) - [Query Jobs Info Result](#QueryJobsInfoResult) - [Reconnect](#reconnect) - [Reconnect Forever](#reconnect-forever) - [Reconnection](#reconnection) - [Record Type Info](#RecordTypeInfo) - [Redelivery Policy](#RedeliveryPolicy) - [Redelivery Policy Message Identifier](#RedeliveryPolicyMessageIdentifier) - [Repeatable File Store Iterable](#repeatable-file-store-iterable) - [Repeatable File Store Stream](#repeatable-file-store-stream) - [Repeatable In Memory Iterable](#repeatable-in-memory-iterable) - [Repeatable In Memory Stream](#repeatable-in-memory-stream) - [Reset Password Result](#ResetPasswordResult) - [Result](#Result) - [Retrieve Request](#RetrieveRequest) - [Search Record](#SearchRecord) - [Search Record Metadata](#SearchRecordMetadata) - [Search Result](#SearchResult) - [Search Results Metadata](#SearchResultsMetadata) - [Search Snippet](#SearchSnippet) - [Simple Error](#SimpleError) - [Standard Revocation Check](#standard-revocation-check) - [TLS](#Tls) - [Truststore](#TrustStore) - [Upsert Metadata Result](#UpsertMetadataResult) ### Action Override Action override.
FieldTypeDescriptionDefault ValueRequired

Available In Touch

Boolean

Indicates whether available in touch or not.

From Factor

String

From factor.

Name

String

Name.

Page Id

String

Page ID.

Url

String

URL.

### Additional Information Map Additional information map.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name of the map.

Value

String

Value of the map.

### Batch Info Batch information.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Created Date

DateTime

Date created.

Id

String

ID name.

Job Id

String

Job ID.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

State

Enumeration, one of:

  • Queued

  • InProgress

  • Completed

  • Failed

  • NotProcessed

State.

State Message

String

State message.

System Modstamp

DateTime

System modstamp.

Total Processing Time

Number

Total processing time.

### Bulk Item Bulk item.
FieldTypeDescriptionDefault ValueRequired

Exception

Any

Exception.

Id

Any

ID.

Message

String

Message.

Payload

Payload.

Status Code

String

Status code.

Successful

Boolean

Determines if successful or not.

### Bulk Job State Bulk job state.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Api Version

Number

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Error Message

String

Error message.

External Id Field Name

String

External ID field name.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

Object

String

Object.

Operation

String

Operation name.

Retries

Number

Number of retries.

State

String

State.

System Modstamp

String

System modstamp.

Total Processing Time

Number

Total processing time.

### Bulk Job V2 Result Bulk job v2 result.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Content Url

String

Content URL.

Created By Id

String

Created by ID.

Created Date

String

Date created.

External Id Field Name

String

External ID field name.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Bulk Operation Result Bulk operation result.
FieldTypeDescriptionDefault ValueRequired

Id

Any

ID.

Items

Array of Bulk Item

Array of the Bulk Item type.

Successful

Boolean

Determines if successful or not.

### Child Relationship Child relationship.
FieldTypeDescriptionDefault ValueRequired

Cascade Delete

Boolean

Cascade delete.

Child S Object

String

Child SObject.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Field

String

Field.

Junction Id List Names

Array of String

Junction ID list names.

Junction Reference To

Array of String

Junction reference to.

Relationship Name

String

Relationship name.

### Create Job Request Create job request.
FieldTypeDescriptionDefault ValueRequired

External Id Field Name

String

Name of the field on this object. Use this attribute for custom objects or the ID lookup field property for standard objects (only required for upsert operations).

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type for the job results.

When specifying a content type different from XML for a query type, use the queryResultStream(BatchInfo) method to retrieve results.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Concurrency mode of the job.

### CRL File Specifies the location of the certification revocation list (CRL) file.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the CRL file.

### Cron CRON.
FieldTypeDescriptionDefault ValueRequired

Expression

String

Cron expression.

x

Time zone

String

ID of the time zone on which to base the expression. Refer to the java.util.TimeZone Javadoc for the format and valid values for this ID.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.
FieldTypeDescriptionDefault ValueRequired

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

### Deleted Record Deleted record.
FieldTypeDescriptionDefault ValueRequired

Deleted Date

DateTime

Deleted date.

Id

String

ID name.

### Deploy Metadata Request Deploy metadata request.
FieldTypeDescriptionDefault ValueRequired

Stream

Binary

Stream containing the data. This parameter defaults to the payload content.

x

Ignore Warnings

Boolean

If true, a warning allows a deployment to complete successfully.

false

Purge On Delete

Boolean

If true, the deleted components in the destructiveChanges.xml manifest file are not stored in the Recycle Bin. This option only works in the Developer Edition or in sandbox organizations; it does not work in production organizations.

false

Rollback On Error

Boolean

If true, failures cause a complete rollback.

true

### Describe Global Result Describe global result.
FieldTypeDescriptionDefault ValueRequired

Encoding

String

Encoding.

Max Batch Size

Number

Maximum batch size.

Sobjects

SObject results.

### Describe Global S Object Result Describe global SObject results.
FieldTypeDescriptionDefault ValueRequired

Activateable

Boolean

Indicates whether activateable or not.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Custom Setting

Boolean

Indicates whether there is a custom setting or not.

Deletable

Boolean

Indicates whether deletable or not.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Feed Enabled

Boolean

Indicates whether the feed is enabled.

Key Prefix

String

Key prefix.

Label

String

Label.

Label Plural

String

Label plural.

Layoutable

Boolean

Indicates whether layoutable or not.

Mergeable

Boolean

Indicates whether mergeable or not.

Mru Enabled

Boolean

Indicates whether MRU is enabled or not.

Name

String

Name.

Queryable

Boolean

Indicates whether queryable or not.

Replicateable

Boolean

Indicates whether replicateable or not.

Retrieveable

Boolean

Indicates whether retrieveable or not.

Searchable

Boolean

Indicates whether searchable or not.

Triggerable

Boolean

Indicates whether triggerable or not.

Undeleteable

Boolean

Indicates whether undeleteable or not.

Updateable

Boolean

Indicates whether updateable or not.

### Describe Metadata Object Describe metadata object.
FieldTypeDescriptionDefault ValueRequired

Child Xml Names

Array of String

Child XML names.

Directory Name

String

Directory name.

In Folder

Boolean

Indicates whether the metadata object is in the folder.

Meta File

Boolean

Indicates whether the metadata object is a meta file.

Suffix

String

Suffix.

Xml Name

String

XML name.

### Describe Metadata Result Describe metadata result.
FieldTypeDescriptionDefault ValueRequired

Metadata Objects

Metadata objects.

Organization Namespace

String

Organization namespace.

Partial Save Allowed

Boolean

Indicates whether partial save is allowed.

Test Required

Boolean

Indicates whether a test is required.

### Describe S Object Result Describe SObject result.
FieldTypeDescriptionDefault ValueRequired

Action Overrides

Action overrides.

Activateble

Boolean

Indicates whether activateable or not.

Child Relationships

Child relationships.

Compact Layoutable

Boolean

Compact layoutable.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Custom Setting

Boolean

Indicates whether there is a custom setting or not.

Deletable

Boolean

Indicates whether deletable or not.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Feed Enabled

Boolean

Indicates whether the feed is enabled.

Fields

Array of Field

Fields.

Key Prefix

String

Key prefix.

Label

String

Label.

Label Plural

String

Label plural.

Layoutable

Boolean

Indicates whether layoutable or not.

Mergeable

Boolean

Indicates whether mergeable or not.

Mru Enabled

Boolean

Indicates whether MRU is enabled or not.

Name

String

Name.

Named Layout Infos

Named layout information.

Network Scope Field Name

String

Network scope field name.

Queryable

Boolean

Indicates whether queryable or not.

Record Type Infos

Record type information.

Replicateable

Boolean

Indicates whether replicateable or not.

Retrieveable

Boolean

Indicates whether retrieveable or not.

Search Layoutable

Boolean

Indicates whether the search is layoutable or not.

Searchable

Boolean

Indicates whether searchable or not.

Triggerable

Boolean

Indicates whether triggerable or not.

Undeleteable

Boolean

Indicates whether undeleteable or not.

Updateable

Boolean

Indicates whether updateable or not.

Url Detail

String

URL detail.

Url Edit

String

URL edit.

Url New

String

URL new.

### Duplicate Result Duplicate result.
FieldTypeDescriptionDefault ValueRequired

Allow Save

Boolean

Determines whether to allow saving or not.

Duplicate Rule

String

Duplicate rule.

Duplicate Rule Entity Type

String

Duplicate rule entity type.

Error Message

String

Error message.

Match Results

Array of Match Result

Match results.

### Entity Search Metadata Entity search metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Name

String

Entity name.

Field Metadata

Field metadata.

### Error Error.
FieldTypeDescriptionDefault ValueRequired

Duplicate Result

Duplicate result.

Fields

Array of String

Fields.

Message

String

Message.

Status Code

String

Status code.

### Error Mapping Error mapping.
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Source.

Target

String

Target.

x

### Expiration Policy Configures an expiration policy strategy.
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

### Field Field.
FieldTypeDescriptionDefault ValueRequired

Autonumber

Boolean

Indicates autonumber.

Byte Length

Number

Byte length.

Calculated

Boolean

Indicates whether calculated or not.

Case Sensitive

Boolean

Indicates whether case sensitive or not.

Controller Name

String

Controller name.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Default Value

Any

Default value.

Default Value Formula

String

Default value formula.

Defaulted On Create

Boolean

Indicates whether defaulted on create.

Dependent Pick List

Boolean

Indicates whether dependent pick list or not.

Deprecate And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Digits

Number

Digits.

Display Location In Decimal

Boolean

Indicates whether the display location is in decimal.

Encrypted

Boolean

Indicates whether encrypted or not.

Extra Type Info

String

Extra type information.

Field Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INT

  • DOUBLE

  • DATE

  • DATETIME

  • TIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANYTYPE

  • DATACATEGORYGROUPREFERENCE

  • ENCRYPTEDSTRING

  • ADDRESS

  • COMPLEXVALUE

  • LOCATION

  • JSON

  • LONG

Field type.

Filterable

Boolean

Indicates whether filterable or not.

Filtered Lookup Info

Filtered lookup information.

Formula

String

Formula.

Groupable

Boolean

Indicates whether groupable or not.

High Scale Number

Boolean

Indicates whether high scale number or not.

Html Formatted

Boolean

Indicates whether HTML formatted or not.

Id Lookup

Boolean

Indicates ID lookup.

Inline Help Text

String

Inline help text.

Label

String

Label.

Length

Number

Length.

Mask

String

Mask.

Mask Type

String

Mask type.

Name

String

Name.

Name Field

Boolean

Indicates name field.

Name Pointing

Boolean

Indicates name pointing.

Nullable

Boolean

Indicates whether nullable or not.

Permissinable

Boolean

Indicates whether permissionable or not.

Picklist Values

Picklist values.

Polymorphic Foreign Key

Boolean

Indicates polymorphic foreign key.

Precision

Number

Precision.

Reference Target Field

String

Reference target field.

Reference To

Array of String

Reference to.

Relationship Name

String

Relationship name.

Relationship Order

Number

Relationship order.

Required

Boolean

Indicates whether required or not.

Restricted Picklist

Boolean

Indicates whether restricted picklist or not.

Scale

Number

Scale.

Search Filterable

Boolean

Indicates whether search filterable or not.

Sortable

Boolean

Indicates whether sortable or not.

Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INT

  • DOUBLE

  • DATE

  • DATETIME

  • TIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANYTYPE

  • DATACATEGORYGROUPREFERENCE

  • ENCRYPTEDSTRING

  • ADDRESS

  • COMPLEXVALUE

  • LOCATION

  • JSON

  • LONG

Type.

Unique

Boolean

Indicates whether unique or not.

Updateable

Boolean

Indicates whether updateable or not.

Write Requires Master Read

Boolean

Indicates whether write requires master read or not.

### Field Diff Field difference.
FieldTypeDescriptionDefault ValueRequired

Difference

Enumeration, one of:

  • DIFFERENT

  • NULL

  • SAME

  • SIMILAR

Field differences.

Name

String

Name of the field.

### Field Level Search Metadata Field level search metadata.
FieldTypeDescriptionDefault ValueRequired

Label

String

Label.

Name

String

Name.

Type

String

Type.

### File Properties File properties.
FieldTypeDescriptionDefault ValueRequired

Created By

String

Created by.

Created By Name

String

Created by name.

Created Date

DateTime

Date created.

File Name

String

File name.

Full Name

String

Full name.

Id

String

ID name.

Last Modified By Id

String

Last modified by ID.

Last Modified By Name

String

Last modified by name.

Last Modified Date

String

Last modified date.

Manageable State

Enumeration, one of:

  • released

  • deleted

  • deprecated

  • installed

  • beta

  • unmanaged

Manageable state.

Namespace Prefix

String

Namespace prefix.

Type

String

Type.

### Filtered Lookup Info Filtered lookup information.
FieldTypeDescriptionDefault ValueRequired

Controlling Fields

Array of String

Controlling fields.

Dependent

Boolean

Indicates dependent or not.

Optional Filter

Boolean

Indicates optional filter or not.

### Find Duplicates Result Find duplicates result.
FieldTypeDescriptionDefault ValueRequired

Duplicate Results

Duplicate results.

Errors

Array of Error

Errors.

Success

Boolean

Determines if successful or not.

### Fixed Frequency Fixed frequency.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

Frequency at which the scheduler initiates the flow, based on the time unit specified in the Time Unit field.

1000 (MILLISECONDS)

x

Start delay

Number

Amount of time that the scheduler waits before initiating the flow for the first time after the app starts. This value is based on the time unit specified in the Time Unit field.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Frequency and Start delay fields.

MILLISECONDS

### Generic Streaming Event Generic streaming event.
FieldTypeDescriptionDefault ValueRequired

Payload

String

Payload.

User Ids

Array of String

User IDs.

### Get Deleted Result Get deleted result.
FieldTypeDescriptionDefault ValueRequired

Deleted Records

Deleted records.

Earliest Date Available

DateTime

Earliest date available.

Latest Date Covered

DateTime

Latest date covered.

### Get Updated Result Get updated result.
FieldTypeDescriptionDefault ValueRequired

Ids

Array of String

IDs.

Latest Date Covered

DateTime

Latest date covered.

### Get User Info Result Get user information result.
FieldTypeDescriptionDefault ValueRequired

Accessibility Mode

Boolean

Indicates accessibility mode.

Currency Symbol

String

Currency symbol.

Org Attachment File Size Limit

Number

Organization attachment file size limit.

Org Default Currency Iso Code

String

Organization default currency ISO code.

Org Default Currency Locale

String

Organization default currency locale.

Org Disallow Html Attachments

Boolean

Indicates whether the organization disallows HTML attachments.

Org Has Person Accounts

Boolean

Indicates whether the organization contains person accounts.

Organization Id

String

Organization ID.

Organization Multi Currency

Boolean

Organization multicurrency.

Organization Name

String

Organization name.

Profile Id

String

Profile ID.

Role Id

String

Role ID.

Session Seconds Valid

Number

Session seconds valid.

User Default Currency Iso Code

String

User default currency ISO code.

User Email

String

User email.

User Full Name

String

User full name.

User Id

String

User ID.

User Language

String

User language.

User Locale

String

User locale.

User Name

String

User name.

User Time Zone

String

User time zone.

User Type

String

User type.

User Ui Skin

String

User UI skin.

### Job Failed Record Results Job failed record results.
FieldTypeDescriptionDefault ValueRequired

Error Message

String

Error message.

Id

String

ID name.

Original Fields

Object

Original fields.

### Job Info Job info.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Api Version

Number

API version.

Assignment Rule Id

String

ID of an assignment rule for a case or lead. The assignment rule can be active or inactive.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Concurrency mode.

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type.

Created By Id

String

Created by ID.

Created Date

DateTime

Date created.

External Id Field Name

String

External ID field name.

Fast Path Enabled

Boolean

Determines whether fast path is enabled.

Id

String

ID name.

Number Batches Completed

Number

Number of batches that are completed.

Number Batches Failed

Number

Number of batches that failed.

Number Batches In Progress

Number

Number of batches in progress.

Number Batches Queued

Number

Number of batches that are queued.

Number Batches Total

Number

Number of batches in total.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

Number Retries

Number

Number of retries.

Object

String

Object.

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

  • queryAll

Operation name.

State

Enumeration, one of:

  • Open

  • Closed

  • Aborted

  • Failed

State.

System Modstamp

DateTime

System modstamp.

Total Processing Time

Number

Total processing time.

### Job Successful Record Result Job successful record result.
FieldTypeDescriptionDefault ValueRequired

Created

Boolean

Indicates whether the job is created or not.

Id

String

ID name.

Original Fields

Object

Original fields.

### Job Unprocessed Record Result Job unprocessed record result.
FieldTypeDescriptionDefault ValueRequired

Original Fields

Object

Original fields.

### Keystore Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

### Labels Search Metadata Labels search metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Field Labels

Entity field labels.

Entity Name

String

Entity name.

### Lead Convert Result Lead convert result.
FieldTypeDescriptionDefault ValueRequired

Account Id

String

Account ID.

Contact Id

String

Contact ID.

Errors

Array of Error

Errors.

Lead Id

String

Lead ID.

Opportunity Id

String

Opportunity ID.

Success

Boolean

Determines if successful or not.

### Lead Convert Request Lead convert request.
FieldTypeDescriptionDefault ValueRequired

Contact Id

String

ID of the contact into which the lead is merged (this contact must be associated with the specified account ID, and an account ID must be specified). Required only when updating an existing contact.

If you are converting a lead into a person account, do not specify the contact ID or else an error results. Specify only the account ID of the person account. If no contact ID is specified, then the API creates a new contact that is implicitly associated with the account. To create a new contact, the client application must be logged in with sufficient access rights. To merge a lead into an existing contact, the client application must be logged in with read or write access to the specified contact. The contact name and other existing data are not overwritten (unless Over Write Lead Source is set to true, in which case only the lead source field is overwritten). For information on IDs, see ID Field Type.

Account Id

String

ID of the account into which the lead is merged. Required only when updating an existing account, including person accounts. If no account ID is specified, then the API creates a new account. To create a new account, the client application must be logged in with sufficient access rights. To merge a lead into an existing account, the client application must be logged in with read or write access to the specified account. The account name and other existing data are not overwritten. For information on IDs, see ID Field Type.

Send Email To Owner

Boolean

If true, specifies whether to send a notification email to the owner specified in the Owner ID.

false

Opportunity Name

String

Name of the opportunity to create. If unspecified, this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If Do Not Create Opportunity is true, then no opportunity is created and this field must be left blank; otherwise, an error is returned.

Do Not Create Opportunity

Boolean

Specifies whether to create an opportunity during lead conversion. Set this flag to true only if you do not want to create an opportunity from the lead. An opportunity is created by default.

false

Over Write Lead Source

Boolean

Specifies whether to overwrite the lead source field on the target contact object with the contents of the lead source field in the source lead object. To set this field to true, the client application must specify a Contact Id for the target contact.

false

Opportunity Id

String

ID of an existing opportunity to relate to a lead during lead conversion.

Owner Id

String

Name associated with the owner ID that owns this lead.

Related Person Account Id

String

When converting a lead to a business account and an existing person account, this value specifies the ID of the person account.

Related Person Account Record

Object

When converting a lead to a business account and a new person account, this value specifies the entity record of the new person account.

### Match Record Match record.
FieldTypeDescriptionDefault ValueRequired

Additional Information

Additional information.

Field Diffs

Array of Field Diff

Field differences.

Match Confidence

Number

Match confidence.

Record

Object

Record.

### Match Result Match result.
FieldTypeDescriptionDefault ValueRequired

Entity Type

String

Entity type.

Errors

Array of Simple Error

Errors.

Match Engine

String

Match engine name.

Match Records

Array of Match Record

Match records.

Rule

String

Rule name.

Size

Number

Size.

Success

Boolean

Determines if successful or not.

### Merge Record Merge record.
FieldTypeDescriptionDefault ValueRequired

Master Record

Object

Master record that contains at least the ID and the type of the object that other records merge into. Optionally, provide the fields and their values to update.

x

Record To Merge Ids

Array of String

Additional records to merge into the primary record. Minimum of one record and maximum of two records.

x

Additional Information Map

Object

Field-value map. When a portal user ID is merged, it must contain two entries: name: PortalUserId and value: ID of the portal user. In all other merge cases, set to null or leave empty.

### Merge Result Merge result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Errors.

Id

String

ID name.

Merged Record Ids

Array of String

Merged record IDs.

Success

Boolean

Determines if successful or not.

Updated Related Ids

Array of String

Updated related IDs.

### Metadata Result Metadata result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Errors.

Full Name

String

Full name.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

### Name Value Pair Name value pair.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name.

Value

String

Value.

### Named Layout Info Named layout information.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name.

### Non-Repeatable Stream Configures the non-repeatable streaming strategy, in which Mule disables repeatable streams. Use this strategy if your use case requires reading the content only once. In some cases, you might want to disable the repeatable stream functionality and use non-repeatable streams, which can have less performance overhead, memory use, and cost. ### Pick List Entry Pick list entry.
FieldTypeDescriptionDefault ValueRequired

Active

Boolean

Indicates active or not.

Default Value

Boolean

Indicates default value.

Label

String

Label.

Valid For

Binary

Indicates when valid for.

Value

String

Value.

### Proxy Configures a proxy for outbound connections.
FieldTypeDescriptionDefault ValueRequired

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

### Push Event Result Push event result.
FieldTypeDescriptionDefault ValueRequired

Fanout Count

Number

Fanout count.

User Online Status

Object

User online status.

### Query Job Info Query job information.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Number Records Processed

Number

Number of records that are processed.

Object

String

Object.

Operation

String

Operation name.

Pk Chunking Supported

Boolean

Whether or not PK chunking is supported.

Retries

Number

Number of retries.

State

String

State.

System Modstamp

String

System modstamp.

Total Processing Time

Number

Total processing time.

### Query Job State Query job state.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Query Jobs Info Result Query jobs information result.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Reconnect Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

### Reconnection Configures a reconnection strategy for an operation.
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

### Record Type Info Record type information.
FieldTypeDescriptionDefault ValueRequired

Available

Boolean

Indicates whether available or not.

Default Record Type Mapping

Boolean

Indicates default record type mapping.

Id

String

ID name.

Master

Boolean

Indicates master.

Name

String

Name.

### Redelivery Policy Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
FieldTypeDescriptionDefault ValueRequired

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

### Redelivery Policy Message Identifier Configures the redelivery policy message identifier type.
FieldTypeDescriptionDefault ValueRequired

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if the Use Secure Hash field is false.

### Repeatable File Store Iterable Repeatable file store iterable.
FieldTypeDescriptionDefault ValueRequired

In Memory Objects

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Repeatable In Memory Iterable Repeatable in memory iterable.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower means that the buffer must not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### Reset Password Result Reset password result.
FieldTypeDescriptionDefault ValueRequired

Password

String

Password to authenticate against the proxy server.

### Result Result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Array of the Error type.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

### Retrieve Request Retrieve request.
FieldTypeDescriptionDefault ValueRequired

Fields

Array of String

Fields.

Ids

Array of String

IDs.

### Search Record Search record.
FieldTypeDescriptionDefault ValueRequired

Record

Object

Record.

Search Record Metadata

Search record metadata.

Snippet

Snippet.

### Search Record Metadata Search record metadata.
FieldTypeDescriptionDefault ValueRequired

Spell Corrected

Boolean

Indicates whether the search is spelled correctly.

### Search Result Search result.
FieldTypeDescriptionDefault ValueRequired

Query Id

String

Query ID.

Search Records

Array of Search Record

Search records.

Search Results Metadata

Search results metadata.

### Search Results Metadata Search results metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Label Metadata

Entity label metadata.

Entity Metadata

Entity metadata.

### Search Snippet Search snippet.
FieldTypeDescriptionDefault ValueRequired

Text

String

Text.

Whole Fields

Whole fields.

### Simple Error Simple error.
FieldTypeDescriptionDefault ValueRequired

Fields

Array of String

Fields.

Message

String

Message.

Status Code

String

Status code.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

### TLS Configures TLS to provide secure communications for the Mule app.
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

### Truststore Configures the truststore for TLS.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

### Upsert Metadata Result Upsert metadata result.
FieldTypeDescriptionDefault ValueRequired

Created

Boolean

Indicates whether created or not.

Errors

Array of Error

Errors.

Full Name

String

Full name.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.4 --- # Salesforce Connector 11.4 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule app in XML either from the Anypoint Studio XML editor or a text editor, perform the following actions to get access to the connector: - Add the namespace for the connector to your XML flow. - Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/salesforce http://www.mulesoft.org/schema/mule/salesforce/current/mule-salesforce.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The Maven `pom.xml` file generated by Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector. ```xml com.mulesoft.connectors mule-salesforce-connector x.x.x mule-plugin ``` Replace `x.x.x` with version information from Exchange. Ensure the connector version corresponds to the one 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 `salesforce`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next After completing your namespace and `pom.xml` file, you can try the [Salesforce Examples](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.5 --- # Salesforce Connector 11.5 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce (Salesforce Connector) enables you to create apps that react to Salesforce events such as adding, changing, or deleting objects, topics, documents, and channels. Salesforce Connector enables you to connect to the Salesforce APIs. This connector exposes methods for accessing Salesforce, including working with the [Salesforce Apex classes](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_dev_process_chapter.htm). This connector works with the Salesforce SOAP API, REST API, Bulk API, and Streaming API, depending on the operation you configure. Each API call uses a request/response pattern over an HTTPS connection. All required request headers, error handling, and HTTPS connection configurations are built into the connector. For compatibility information and fixed issues, see the Salesforce Connector release notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce SOAP, REST, Bulk, and Streaming APIs - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Access to the Salesforce target resource, which requires a [Salesforce developer account](https://developer.salesforce.com) and [Salesforce security token](https://help.salesforce.com/s/articleView?language=en_US&id=user_security_token.htm). You can receive a new security token by email if you run **Reset Security Token** through **My Personal Information** from the Salesforce Setup pages. - A consumer key and secret (available in your Salesforce developer account) - The namespace and schema location, if you are using OAuth authentication. If you plan to create the XML for your Mule app, include the correct namespace and schema location in your XML file. Studio adds this information to the XML file automatically when you add Salesforce Connector to a flow in a Mule app. ## Limitations - Salesforce Connector does not expose all possible operations of the Salesforce APIs. - Salesforce Connector does not provide access to the Chatter API or Tooling API. ## Audience - New users Read this document and create your Mule app in [Anypoint Studio](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-studio). The [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-config-topics) topic helps you extend your understanding of the connector. - Advanced users Read [XML and Maven Support](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-xml-maven), the [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-config-topics) topic, and [Examples](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-examples). ## Common Use Cases for the Connector Common use cases for Salesforce Connector include: - **ERP Integration** Give your sales team access to all relevant customer data from one system via real-time synchronization of data between Salesforce and your ERP & finance applications. For example, use Anypoint Connector for SAP (SAP Connector) to sync data between Salesforce and SAP and Anypoint Connector for NetSuite (NetSuite Connector) to sync data between Salesforce and NetSuite. - **Data Aggregation** Collect data from multiple Salesforce orgs, other CRMs, ERP systems, and databases into one Salesforce instance or use that information to generate reports. - **Legacy Modernization** Easily manage data post-acquisition, move off of a legacy CRM system, or migrate ERP data into Salesforce by automatically moving your data into Salesforce. - **Customer Experience** Deliver a consistent, connected customer experience across channels, increase customer satisfaction, and drive revenue growth by integrating Salesforce to applications such as ServiceNow, Marketo, and others. For examples of these use cases, refer to [Salesforce Connector Examples](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-examples). ## Authentication Types Salesforce Connector connections use the following authentication types: - Basic authentication Uses a username and password for authentication - OAuth 2.0 Delegates user authentication to the service hosting the user account - OAuth JWT Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication - OAuth Client Credentials Uses a client ID and client secret for authentication - OAuth SAML Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token - OAuth Username password Uses OAuth 2.0 with a user and password for authentication For information about configuring these authentication types, see [Using Anypoint Studio to Configure Salesforce Connector](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-studio). ## Salesforce Connector Configurations and Examples The following table provides links to specific Salesforce Connector information:
SubjectDescription

Accept and Transform Data

Accept and transform data from Salesforce example

Apex SOAP and REST

Configure for APEX SOAP API and APEX REST API

APIs

List of Salesforce APIs that this connector can access

Application Development

Process order and integration patterns

Batched Data

Batch data using the Salesforce Bulk API

Lead Convert Request ID

Specify a lead ID using DataWeave

Parent Child Relationships

Create and update parent and child relationships example

Anypoint Exchange Templates and Examples

Simplify Salesforce Connector development with a template or example

Subscribe Topic

Subscribe to a Salesforce topic

Subscribe Streaming Channel

Subscribe to a Salesforce streaming channel

Replay Topic

Replay events from a Topic

Replay Streaming Channel

Replay Events from a Salesforce streaming channel

Custom Event Notifications

Get custom event notifications over a streaming channel

Push Event Notifications

Push Events to a Streaming Channel

Object Store Usage

Object Store usage and limitations

## Develop an Application To build an app, perform the following tasks: 1. Configure the connector. 2. Test the connection. 3. Build the rest of your flow. 4. Add and configure DataWeave. When developing an app, Salesforce Connector provides these integration patterns you can use with the Salesforce APIs: - Batch Data Synchronization An external system accesses, changes, deletes, or adds data in Salesforce in batches, and vice versa (Salesforce to external system). - Remote Call-In An external system accesses, changes, deletes, or adds data in Salesforce, and vice versa (Salesforce to external system). - Fire and Forget Remote Process Invocation Salesforce initiates a process in a third-party system and receives an acknowledgment that the process has started. The third-party system continues processing independent of Salesforce. - Request-Reply Remote Process Invocation Salesforce initiates a process in a remote system, waits for the remote system to finish processing, and accepts control returned from the remote system. - User Interface Update Based on Data Changes The Salesforce UI updates in response to a change in a third-party system. ## Salesforce APIs Salesforce Connector works with the Salesforce Apex SOAP API, Apex REST API, Bulk API, Metadata API, and Streaming API, but does not provide access to the Chatter API or the Tooling API. Each API call uses a request/response pattern over an HTTPS connection. All required request headers, error handling, and HTTPS connection configurations are built into the connector. - Apex SOAP API Salesforce [Apex SOAP API](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_api.htm?search_text=soap) exposes Apex class methods as custom SOAP web service calls. This allows an external app to invoke an Apex web service to perform an action in Salesforce. - Apex REST API Salesforce [Apex REST API](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest.htm) creates your own REST-based web services using Apex. This API has all of the advantages of the REST architecture, while adding the ability to define custom logic and including automatic argument or object mapping. - Bulk API Salesforce [Bulk API](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) quickly and securely loads batches of your organization’s data into Salesforce. See also [Load Data in Batches](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-config-topics#batchdata). - Metadata API Salesforce [Metadata API](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_intro.htm) manages customizations and build tools that work with the metadata model, not the data itself. - SOAP API Salesforce [SOAP API](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_quickstart_intro.htm) provides secure access to your organization’s information on Salesforce. Most of the operations that Salesforce Connector performs map to this API. All the Salesforce operations performed through the SOAP API have an optional parameter called `Headers` that can take any of the [Salesforce SOAP headers](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/soap_headers.htm). - Streaming API Salesforce [Streaming API](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/intro_stream.htm) securely receives notifications about changes to your organization’s information in Salesforce. See [Create a Streaming Channel to Receive Data from Salesforce](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-processing-events#createchannel) for more information about the use of the Streaming API. ## Anypoint Exchange Templates and Examples [Anypoint Exchange](https://www.mulesoft.com/exchange/) provides templates you can use as a starting point for your app, as well as examples that illustrate a complete solution. ### Salesforce Connector Templates in Exchange [Anypoint Exchange templates](https://www.mulesoft.com/exchange/?search=salesforce&type=template) provide starting points for Studio projects such as: - Account Broadcast template [Salesforce to Salesforce, Workday, SAP, and database account broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc.wday.sap.db-account-broadcast/) - Aggregation [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-contact-aggregation/), [opportunity](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-aggregation/), [user](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-user-aggregation/) - Bidirectional Sync template - Between Salesforce organizations [accounts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-account-bidirectional-sync/), [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-contact-bidirectional-sync/), [custom objects](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-casecustomobject-bidirectional-sync/), [opportunities](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-bidirectional-sync/), [users](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-user-bidirectional-sync/) - Other sources [database](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2db-account-bidirectional-sync/), [Microsoft Dynamics CRM](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2msdyn-account-bidirectional-sync/), [Siebel](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sieb-account-bidirectional-sync/) - Migration [accounts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-account-migration/), [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-contact-migration/), [opportunities](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-migration/) ### Salesforce Connector Examples in Exchange [Anypoint Exchange examples](https://www.mulesoft.com/exchange/?search=salesforce&type=example) enable you to create complete Studio projects such as: - Batch processing [database](https://www.mulesoft.com/exchange/org.mule.examples/salesforce-to-MySQL-DB-using-Batch-Processing/) and [import leads](https://www.mulesoft.com/exchange/org.mule.examples/import-leads-into-salesforce/) - [Contacts](https://www.mulesoft.com/exchange/org.mule.examples/cache-scope-with-salesforce-contacts/) - [Data retrieval](https://www.mulesoft.com/exchange/org.mule.examples/salesforce-data-retrieval/) - [DataWeave](https://www.mulesoft.com/exchange/org.mule.examples/dataweave-with-flowreflookup/) ## Next Steps After you complete the prerequisites and experiment with templates and examples, you are ready to create an app with [Anypoint Studio](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce APIs: What they are and when to use them](https://developer.salesforce.com/) - [Which Salesforce API should I use?](https://help.salesforce.com/s/articleView?id=integrate_what_is_api.htm&language=en_US&type=5) - [Salesforce Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-connector-release-notes-mule-4) - [Salesforce Connector in Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-salesforce-connector/) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.5 --- # Salesforce Connector 11.5 Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Configure Anypoint Connector for Salesforce (Salesforce Connector) to: - Load data in batches - Specify a Lead ID for a Lead Convert Request operation - Update field values to `null` - Generate an OAuth 2.0 keystore file - Invoke an APEX Rest method ## Load Data in Batches The Salesforce Bulk API loads batches of your organization’s data into Salesforce. Salesforce Connector provides the **Create** and **Create Bulk** operations for working with the Bulk API. For all bulk operations, Salesforce handles the creation process in the background. The connector replies with a `BatchInfo` object, which contains the ID of the batch and the ID of the job it creates to upload the batched objects. In Salesforce, you can track the status of bulk data load jobs and their associated batches by using the job ID for Bulk Data Load Jobs: 1. Click ** Setup > Monitoring > Bulk Data Load Jobs**. 2. Click the job ID to view the job detail page. The job detail page includes a list of all the batches related to the job. The list provides `View Request` and `View Response` links for each batch. If the batch is a CSV file, the links return the request or response in CSV format. If the batch is an XML file, the links return the request or response in XML format. ## Specify a Lead Convert Request ID To specify a lead ID for a `LeadConvertRequest` operation, use a DataWeave transform message. When you use a transform message before the operation, you must add the `leadId` field, because the metadata for the operation doesn’t specify it: ```example ``` ## Update Field Values to Null To set field values to `null`, use an **Update** or **Upsert** request operation and insert the names of the fields you want to nullify in the **Transform Message** component’s **fieldsToNull** field: ![Transform Message properties window for setting a field to null](/mulesoft/current/en-us/salesforce-connector/11.5/_images/salesforce-connector-10-set-fields-to-null.png) Figure 1. Specify the field names you want to nullify in the **Transform Message** component **fieldsToNull** field. ## Generate a Keystore File Salesforce Connector uses the Bouncy Castle cryptographic library to load the certificate from the keystore and sign the payload for the authentication requests. The library has a [vulnerability (CVE-2018-5382)](https://nvd.nist.gov/vuln/detail/CVE-2018-5382) that relates to the BKS-V1 keystore file type. By default, Salesforce Connector uses JKS or PKCS12 keystores. Avoid using BKS-V1 keystore files, as documented in the [Bouncy Castle proposed solution](https://www.kb.cert.org/vuls/id/306792). To generate a JKS keystore file: 1. Go to your Mule workspace and open the command prompt (for Windows) or Terminal (for Mac). 2. Enter this command: ```none keytool -genkeypair -alias salesforce-cert -keyalg RSA -keystore salesforce-cert.jks ``` 3. Enter the following information: - Password for the keystore - Your first name and last name - Your organization unit - Your city and state, and the two-letter code for your country The system generates a Java keystore file (JKS format) that contains a private or public key pair in your workspace. 4. Provide the file path for the keystore in your connector configuration. Enter this command: ```none keytool -exportcert -alias salesforce-cert -file salesforce-cert.crt -keystore salesforce-cert.jks ``` The system exports the public key from the keystore into the workspace. This is the public key to enter in your Salesforce instance. 5. Verify that you have both the keystore (`salesforce-cert.jks`) and the public key (`salesforce-cert.crt`) files in your workspace. ## Invoke APEX Rest Method The Invoke APEX Rest operation enables users to invoke a method from an Apex class that is exposed as a REST service. The following example shows a payload for this operation: ```example ``` In this example: - The `body` element contains `URLParameters`, which is a map containing the parameters that replace the wildcards in the path of the REST resource described in the Apex class. For example, if the REST resource is set to `@RestResource(urlMapping='/myResource/*/mySubResource/*')`, the value of `Parameter1` replaces the first `*`, and the value of `Parameter2` replaces the second `*`. - Key names must start with `Parameter`, followed by a number that shows the position of the `*` to be replaced. - After the `URLParameters` block, provide the content of the `body` value to send to the REST resource, as shown in the example `account` block. - The `headers` and `cookies` fields describe the headers and cookies to pass along with the HTTP request to the desired service. - The `queryParameters` field describes the query parameters to use, and the keys and values in this map that the specified Apex Class must accept. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.5 --- # Salesforce Connector 11.5 Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt These examples show several Mule flows for Salesforce Connector: - [Accept and Transform Data](#accandtrans) - [Create or Update an Object in a Parent-Child Relationship](#parentchild) - [Delete Accounts](#delete-accounts) - [Find Duplicate Accounts](#find-duplicate-accounts) ## Accept and Transform Data This example shows how to configure Salesforce Connector to create a new Salesforce account and query new accounts, and to use [File Connector](https://docs.mulesoft.com/file-connector/latest/) to write the new account data to a file. The example contains three flows: - The first flow configures a template for the HTML input form used to provide data for the new account. - The second flow creates a new Salesforce account based on information in the HTML input form. - The third flow queries new accounts by name and writes new account data to a CSV file. ![Accept and transform data flows](/mulesoft/current/en-us/salesforce-connector/11.5/_images/accept-and-transform-data-flows.png) ### Configure the First Flow Configure the first flow that configures an HTML template that provides the data used to create a new account. Creating the first flow involves configuring a **Listener** component and a **Parse Template** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/account` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/account`. #### Add the Parse Template Component Add the **Parse Template** component to create a template for an HTML form (`form.html`), which is located in the main resources folder and is used to convey information for creating a new account: 1. From the **Mule Palette** view, select **Core** and drag a **Parse Template** component to the right of **Listener**. 2. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the component, such as Parse Template.

Location

form.html

The following image shows an example of the **Parse Template** configuration in the properties window: ![Parse Template properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.5/_images/parse-template-properties-window.png) ### Configure the Second Flow Configure the second flow that creates a new Salesforce account based on the data in the HTTP input form. Creating the second flow involves configuring a **Listener** component, a **Transform Message** component, a **Create** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/createAccount` path: 1. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Accept the defaults. 4. In the properties window, set the **Path** field value to `/createAccount`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Create** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [{ Name: payload.Name, AccountNumber: payload.AccountNumber, BillingCity: payload.BillingCity }] ``` #### Add the Create Operation Add the **Create** operation to create a new Salesforce account using the field values passed by the **Transform Message** component: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Create** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Create** configuration of the global element: ![Create global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.5/_images/create-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

You can successfully pass a variable into Type, but there could be an issue when displaying the input metadata if the runtime fails to properly resolve the value of that variable.

Records

payload

The following image shows an example of the **Create** configuration in the properties window: ![Create properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.5/_images/create-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the field values to JSON format so the values can be used with [File Connector](https://docs.mulesoft.com/file-connector/latest/): 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Create**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { id:$.id, errors:$.errors, success:$.success } ``` ### Configure the Third Flow Configure the third flow that queries new Salesforce accounts by name and writes the matching accounts data to a Java file. Creating the third flow involves configuring an **On New Object** source, a **Query result list** operation, a **Query result stream by id** operation, a **Transform Message** component, and a **Write** operation. #### Configure the On New Object Source Configure the **On New Object** source to initiate a Mule flow when a new account is created on the `/account` path: 1. From the **Mule Palette** view, select **Salesforce** and drag the **On New Object** source to the canvas. 2. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

The following image shows an example of the **On New Object** configuration in the properties window: ![On New Object properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.5/_images/on-new-object-properties-window.png) #### Add the Query Result List Operation Add the **Query result list** operation to return a list of result IDs: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Query result list** operation to the right of **On New Object**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Query result list** configuration of the global element: ![Query result list global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.5/_images/query-result-list-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Batch info

payload

The following image shows an example of the **Query result list** configuration in the properties window: ![Query result list properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.5/_images/query-result-list-properties-window.png) #### Add the Query Result Stream by Id Operation Add the **Query result stream by id** operation to obtain the final query results: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Query result stream by id** operation to the right of **Query result list**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Query result stream by id** configuration of the global element: ![Query result stream by id global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.5/_images/query-result-stream-by-id-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Batch info

payload

The following image shows an example of the **Query result stream by id** configuration in the properties window: ![Query result stream by id properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.5/_images/query-result-stream-by-id-properties-window.png) #### Add the Transform Message Component Add the **Transform Message** component to convert the field values to JSON format so the values can be used with [File Connector](https://docs.mulesoft.com/file-connector/latest/): 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Query result stream by id**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { AccountNumber:$.AccountNumber, BillingAddress:$.BillingAddress, Id:$.Id, Name:$.Name } ``` #### Add the Write Operation Add the **Write** operation to write the new account data to a CSV file: 1. From the **Mule Palette** view, select **File** and drag the **Write** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Working Directory

If Connection is selected, the directory to consider the root of every relative path used with this connector. If not provided, it defaults to the value of the user.home system property. If that system property is not set, then the connector fails to initialize.

The following image shows an example of the **Write** configuration of the global element: ![Write global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.5/_images/write-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Path

/account

Content

payload

The following image shows an example of the **Write** configuration in the properties window: ![Write properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.5/_images/write-properties-window.png) ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Create or Update an Object in a Parent-Child Relationship This example shows how to create the object relationship structure in Salesforce needed to perform an upsert using Salesforce Connector. ![Create or Update an Object in a Parent-Child Relationship flow](/mulesoft/current/en-us/salesforce-connector/11.5/_images/create-update-flow.png) ### Configure the Flow A Salesforce object can have standard or custom relationships between objects. The relationships between objects are usually one-to-many (parent-child) relationships, but can be any link between two objects residing in Salesforce. The example uses two custom Salesforce object types that have a parent-child relationship: - `Plane__c`, the parent object that must exist in Salesforce - `Component__c`, the object to upsert using Salesforce Connector The relationship between the two custom objects is represented by a `Plane__r` field whose value is an object with two fields: - The `type` field, which has the referenced object type name as its value. In this example, the value of `type` is `Plane_c`. - A field that identifies the instance of the parent object to reference. In this example, the `Name` field references the `Cobra` instance of `Plane__c`. When you upsert `Component__c`, the POJO sent as input to Salesforce Connector looks like this: ```linenums ---- [{ // Component__c's fields ... Plane__r: { "type": "Plane__c", "Name": "Cobra" } }] ---- ``` Creating the flow involves configuring a **Listener** component, a **Transform Message** component, an **Upsert** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Upsert** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [{ Name: "NewPlaneComponent", Plane__r: { "type": "Plane__c", "Name": "Cobra" } }] ``` #### Add the Upsert Operation Add the **Upsert** operation to create or update a Salesforce object that is in a parent-child relationship: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Upsert** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Upsert** configuration of the global element: ![Upsert global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.5/_images/upsert-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Object type

Component_c

External id field name

Id

Records

payload

The following image shows an example of the **Upsert** configuration in the properties window: ![Upsert properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.5/_images/upsert-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Upsert**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Delete Accounts This example shows how to use Salesforce Connector to delete Salesforce accounts. ![Delete Accounts flow](/mulesoft/current/en-us/salesforce-connector/11.5/_images/delete-accounts-flow.png) ### Configure the Flow Creating the flow involves configuring a **Listener** component, a **Transform Message** component, a **Delete** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Delete** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [payload.Id] ``` #### Add the Delete Operation Add the **Delete** operation to delete Salesforce accounts: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Delete** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Delete** configuration of the global element: ![Delete global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.5/_images/delete-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Records to Delete Ids

payload

The following image shows an example of the **Delete** configuration in the properties window: ![Delete properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.5/_images/delete-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Delete**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { id:$.id, errors:$.errors, success:$.success } ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Find Duplicate Accounts This example shows how to use Salesforce Connector to find duplicate Salesforce accounts. ![Find Duplicate Accounts flow](/mulesoft/current/en-us/salesforce-connector/11.5/_images/find-duplicates-accounts-flow.png) ### Configure the Flow Creating the flow involves configuring a **Listener** component, a **Transform Message** component, a **Find duplicates** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/findDuplicates` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/findDuplicates`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Delete** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [ payload ] ``` #### Add the Find Duplicates Operation Add the **Find duplicates** operation to find duplicate Salesforce accounts: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Find duplicates** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Find duplicates** configuration of the global element: ![Find Duplicates global element configuration window](/mulesoft/current/en-us/salesforce-connector/11.5/_images/find-duplicates-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

Criteria

payload

The following image shows an example of the **Find duplicates** configuration in the properties window: ![Find Duplicates properties window configuration](/mulesoft/current/en-us/salesforce-connector/11.5/_images/find-duplicates-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Find duplicates**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- { success: payload.success, duplicateResults: { (payload.duplicateResults map { matchRecords: $.matchResults } ) }, duplicateRuleEntityType: payload.duplicateRuleEntityType, duplicateRule: payload.duplicateRule, allowSave: payload.allowSave, errorMessage: payload.errorMessage } ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.5 --- # Salesforce Connector 11.5 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt > [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality. > We maintained certain terms to avoid any effect on customer implementations. Anypoint Connector for Salesforce (Salesforce Connector) simplifies and accelerates integration across Sales Cloud, Service Cloud, Salesforce Platform, and Force.com. With comprehensive access to Salesforce entities, this connector streamlines automation of business processes—helping you unlock more value from your Salesforce investments, empower your sales teams, increase revenue, and provide better customer service. ## Configuration Default Configuration for Salesforce Connector.
NameTypeDescriptionDefault ValueRequired

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Read Timeout

Number

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

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

SECONDS

Name

String

Identifier of this element used to reference it in other components.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Fetch All Apex SOAP Metadata

Boolean

If true, DataSense is performed for all Apex classes in the organization. If false, DataSense is performed only for classes in Apex Class Names. If the organization contains many Apex classes, this might cause a ConnectionTimeout during DataSense.

false

Fetch All Apex REST Metadata

Boolean

If true, DataSense is performed for all Apex classes in the organization. If false, DataSense is performed only for classes in Apex Class Names. If the organization contains many Apex classes, this might cause a ConnectionTimeout during DataSense.

false

Apex Class Names

Array of String

List of Apex class names involved in metadata retrieval via DataSense.

Include null values

Boolean

Includes null values in the Apex Rest API request. This parameter applies to the Invoke Apex Rest Method operation only.

false

### Basic Authentication Connection Type (Supported by Salesforce API v64.0 and below) Uses a username and a password for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP is allowlisted on Salesforce.

Authorization URL

String

Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, https://login.salesforce.com/services/Soap/u/67.0. Always use lowercase when specifying the protocol (e.g., http, https).

Session Id

String

Value that identifies an active Salesforce session.

Service Endpoint

String

Specifies the service endpoint. This value is used only if the Session Id configuration property is used.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth v2.0 Connection Type Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint. Always use lowercase when specifying the protocol (e.g., http, https).

https://login.salesforce.com/services/oauth2/authorize

Access Token Url

String

URL of the service provider’s access token endpoint. Always use lowercase when specifying the protocol (e.g., http, https).

https://login.salesforce.com/services/oauth2/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after receiving an access token.

Listener Config

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

### OAuth JWT Connection Type Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication. > [!NOTE] Salesforce Connector supports providing a signed certificate only if you use the > `SHA256withRSA` algorithm for the OAuth JWT connection type. You can only enable **JSON Web Token-based access tokens** option on Salesforce server for REST API calls. This option isn’t compatible with Salesforce Connector.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Certificate Alias

String

Alias of the certificate.

Principal

String

Username of the desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

Audience Url

String

URL that identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.

Use the authorization server’s URL for the audience value if implementing for a community: https://login.salesforce.com, https://test.salesforce.com, or https://community.force.com/customers.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth Client Credentials Uses a client ID and client secret for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Client ID

String

The OAuth client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret that corresponds to the client ID.

x

Token URL

String

Service provider’s token endpoint URL. Always use lowercase when specifying the protocol (e.g., http, https).

https://{domain}.my.salesforce.com/services/oauth2/token

Scopes

String

The OAuth scopes to request during the OAuth dance.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

### OAuth Username Password Connection Type Uses OAuth 2.0 with a user and password for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Consumer Secret

String

Your application’s client secret (consumer secret in Remote Access Detail).

x

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP is allowlisted on Salesforce.

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth SAML Connection Type > [!NOTE] OAuth SAML currently uses only Salesforce as an identity provider. Refer to > [Salesforce as a SAML Identity Provider](https://help.salesforce.com/s/articleView?id=xcloud.sso_sfdc_idp_saml_parent.htm&type=5) > to enable Salesforce as an identity provider. Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Certificate Alias

String

Alias of the certificate.

Principal

String

Username of the desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

## Sources - [On Deleted Object](#deleted-object-listener) - [On Modified Object](#modified-object-listener) - [On New Object](#new-object-listener) - [Replay Channel Listener](#replay-channel-listener) - [Replay Topic Listener](#replay-topic-listener) > [!NOTE] The **On Deleted Object**, **On Modified Object**, and **On New Object** sources in > Salesforce Connector use Object Store to save watermarks. You might experience limitations that > are specific to the Object Store implementation you are using (Object Store for CloudHub > deployments or Object Store for on-premises deployments), so configure Object Store to suit your > needs. > For more information, see > [The Different Types of Object Stores Explained](https://help.salesforce.com/s/articleView?id=001123185&type=1). ### On Deleted Object `` Source that adds one or more `whereConditions` in the query calling the method.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### On Modified Object `` Source for modified objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### On New Object `` Source for new objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### Replay Channel Listener `` Source that subscribes to a streaming channel. First, the streaming channel must be published, and after that, a subscription to that streaming channel must be created. Salesforce allows you to subscribe to a nonexistent streaming channel but won’t send you notifications after the topic is created.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Streaming Channel

String

Name of the streaming channel to subscribe to.

x

Cache Events In Memory

Boolean

When the processing flow is slow, cache events in memory to reduce quota consumption.

false

Replay Option

Enumeration, one of:

  • ONLY_NEW

  • ALL

  • FROM_REPLAY_ID

  • FROM_LAST_REPLAY_ID

  • ONLY_NEW: -1

    Subscriber receives new events that are broadcast after the client subscribes.

  • ALL: -2

    Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription.

  • FROM_REPLAY_ID

    Subscriber receives only events that have a replay ID value greater than the specified replay ID.

  • FROM_LAST_REPLAY_ID

    Subscriber uses the highest replay ID stored in the object store regardless of whether it is processed successfully or not.

x

Replay Id

String

Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to ALL or ONLY_NEW.

Replay Failed Events If Any or Resume from Last Replay Id

Boolean

If true, the source starts consuming data with any failed events (if any) or starts consuming data from the last replay ID that is processed successfully.

false

The size (in bytes) of the event queue (DEPRECATED)

Number

In previous versions, this field was used to specify the size of the event queue which can lead to memory issues. Now, the messages are streamed and no buffering is needed.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

true

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Throw Exception When Organization Daily Limit Exceeded

Boolean

Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded.

false

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Attributes

Object

Attributes.

#[message.attributes]

#### Output

Type

Any

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### Replay Topic Listener `` Salesforce stores events for 24 hours and enables you to retrieve stored and new events. Source in which subscribers choose which events to receive by using replay options.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Topic

String

Name of the topic to subscribe to.

x

Cache Events In Memory

Boolean

When the processing flow is slow, cache events in memory to reduce quota consumption.

false

Replay Option

Enumeration, one of:

  • ONLY_NEW

  • ALL

  • FROM_REPLAY_ID

  • FROM_LAST_REPLAY_ID

  • ONLY_NEW: -1

    Subscriber receives new events that are broadcast after the client subscribes.

  • ALL: -2

    Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription.

  • FROM_REPLAY_ID

    Subscriber receives only events that have a replay ID value greater than the specified replay ID.

  • FROM_LAST_REPLAY_ID

    Subscriber uses the highest replay ID stored in the object store regardless of whether it is processed successfully or not.

x

Replay Id

String

Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to ALL or ONLY_NEW.

Replay Failed Events If Any or Resume from Last Replay Id

Boolean

If true, the source starts consuming data with any failed events (if any) or starts consuming data from the last replay ID that is processed successfully.

false

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

true

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Throw Exception When Organization Daily Limit Exceeded

Boolean

Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded.

false

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Attributes

Object

Attributes.

#[message.attributes]

#### Output

Type

Any

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ## Operations > [!NOTE] If you set `LocalDate` for a field in the payload, the input time is automatically > converted to `GMT` or the server’s time zone based on the Gregorian calendar. This conversion > impacts date calculations or comparisons in Salesforce Connector operations, as `LocalDate` is > adjusted to align with the server’s time zone or defaults to GMT. - [Abort Job](#abortJob) - [Abort Job Bulk Api V2](#abortJobBulkApiV2) - [Abort Query Job Bulk Api V2](#abortQueryJobBulkApiV2) - [Batch Info](#batchInfo) - [Batch Info List](#batchInfoList) - [Batch Result](#batchResult) - [Batch Result Stream](#batchResultStream) - [Change Own Password](#changeOwnPassword) - [Close Job](#closeJob) - [Convert Lead](#convertLead) - [Create](#create) - [Create Batch](#createBatch) - [Create Batch For Query](#createBatchForQuery) - [Create Batch Stream](#createBatchStream) - [Create Job](#createJob) - [Create Job Bulk Api V2](#createJobBulkApiV2) - [Create Metadata](#createMetadata) - [Create Query Job Bulk Api V2](#createQueryJobBulkApiV2) - [Delete](#delete) - [Delete Job Bulk Api V2](#deleteJobBulkApiV2) - [Delete Metadata](#deleteMetadata) - [Delete Query Job Bulk Api V2](#deleteQueryJobBulkApiV2) - [Deploy Metadata](#deployMetadata) - [Describe Global](#describeGlobal) - [Describe Metadata](#describeMetadata) - [Describe Sobject](#describeSobject) - [Find Duplicates](#findDuplicates) - [Find Duplicates By Ids](#findDuplicatesByIds) - [Get All Jobs Bulk Api V2](#getAllJobsBulkApiV2) - [Get All Query Jobs Bulk Api V2](#getAllQueryJobsBulkApiV2) - [Get Deleted](#getDeleted) - [Get Job State Bulk Api V2](#getJobStateBulkApiV2) - [Get Query Job Info Bulk Api V2](#getQueryJobInfoBulkApiV2) - [Get Query Job Results Bulk Api V2](#getQueryJobResultsBulkApiV2) - [Get Server Timestamp](#getServerTimestamp) - [Get updated objects](#getUpdated) - [Get User Info](#getUserInfo) - [Invoke Apex Rest Method](#invokeApexRestMethod) - [Invoke Apex Soap Method](#invokeApexSoapMethod) - [Job Info](#jobInfo) - [List Metadata](#listMetadata) - [Merge](#merge) - [Merge Multiple](#mergemultiple) - [Publish Platform Event Message](#publishPlatformEventMessage) - [Publish Streaming Channel](#publishStreamingChannel) - [Publish Topic](#publishTopic) - [Push Generic Event](#pushGenericEvent) - [Query (Deprecated)](#query) - [Query All](#queryAll) - [Query Result List](#queryResultList) - [Query Result Stream By Id](#queryResultStreamById) - [Query Xml Stream](#queryXmlStream) - [Read Metadata](#readMetadata) - [Rename Metadata](#renameMetadata) - [Reset Password](#resetPassword) - [Retrieve](#retrieve) - [Retrieve Job Failed Results Bulk V2](#retrieveJobFailedResultsBulkV2) - [Retrieve Job Successful Results Bulk V2](#retrieveJobSuccessfulResultsBulkV2) - [Retrieve Job Unprocessed Results Bulk V2](#retrieveJobUnprocessedResultsBulkV2) - [Retrieve Metadata](#retrieveMetadata) - [Search](#search) - [Set Password](#setPassword) - [Unauthorize](#unauthorize) - [Update](#update) - [Update Metadata](#updateMetadata) - [Upsert](#upsert) - [Upsert Metadata](#upsertMetadata) ### Abort Job `` Aborts an open job given its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID that identifies the job to abort.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Abort Job Bulk Api V2 `` Aborts an ongoing Bulk API v2 Job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Abort Query Job Bulk Api V2 `` Abort the indicated query job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job to abort.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job Info

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Info `` Accesses the latest BatchInfo of a submitted BatchInfo. Enables you to track the execution status.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo that is monitored.

#[payload]

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Info List `` Gets information about all batches in a job.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job Id

String

ID of the job to retrieve batch information for.

x

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Result `` Accesses `com.sforce.async.BatchResult` of a submitted BatchInfo.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch To Retrieve

com.sforce.async.BatchInfo that is monitored.

#[payload]

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Result Stream `` Accesses `com.sforce.async.BatchResult` of a submitted BatchInfo.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch To Retrieve

com.sforce.async.BatchInfo that is monitored.

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Change Own Password `` Changes the password of the user linked to the connector’s configuration.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Old Password

String

Old password to change.

x

New Password

String

New password to change.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Close Job `` Closes an open job given its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID identifying the job to close.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Convert Lead `` Converts a lead into an account, contact, or (optionally) an opportunity.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Lead Convert Request

Information for lead conversion.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Lead Convert Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Create `` Adds one or more new records to your organization’s data. > [!IMPORTANT] When you map your objects to the input of this message processor, the objects must > match the expected type of the object at Salesforce. For example, if you set the **CloseDate** > field of an opportunity to a string of value `2011-12-13`, it is sent to Salesforce as a string. > The operation is rejected because the CloseDate is not of the expected type. The correct way to > map it is to generate a Java Date object. You can do so using the Groovy expression evaluator as > `#[groovy:Date.parse("yyyy-MM-dd", "2011-12-13")]`.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to add.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Create Batch `` Creates a batch using the given objects within the specified Job. The job can be of XML or CSV type. This call uses the Bulk API. This operation is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

com.sforce.async.JobInfo in which the batch is created. The job can be of XML, JSON, or CSV type.

x

SObjects

Array of Object

List of one or more SObject objects.

#[payload]

SObject Max Depth

Number

Asynchronous SObject recursive MAX_DEPTH check.

5

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Batch For Query `` Creates a batch using the given query. This call uses the Bulk API. This operation is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

JobInfo in which the batch is created.

x

Query

String

Query to execute.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Batch Stream `` Creates a batch using the given stream within the specified job. The stream can have a CSV, XML, ZIP\_CSV, or ZIP\_XML format. This call uses the Bulk API and is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

JobInfo in which the batch is created.

#[payload]

x

Stream

Any

Stream containing the data. The stream can have a CSV, XML, ZIP_CSV, or ZIP_XML format.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Job `` Creates a job to perform one or more batches through Bulk API operations.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

  • queryAll

OperationEnum that is executed by the job.

x

Type

String

Type of Salesforce object that the job processes.

x

Create Job Request

Creates the job request.

If you input the value in literal mode, an example value is:

{
    “externalIdFieldName”: “employeeId”,
    “contentType”: “XML”,
    “concurrencyMode”: “Serial”
}

If you input the value in expression mode, then the input can be dynamic using output application/json or output application/java, and can be transformed into the required input.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Job Bulk Api V2 `` Creates a Bulk API v2 job containing the data to insert, update, delete, or upsert. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Type of object to work with.

x

sObjects

Binary

Array of one or more SObject objects.

#[payload]

Operation

Enumeration, one of:

  • insert

  • update

  • delete

  • hardDelete

  • upsert

Operation to execute.

x

Line Ending

String

Line ending of CSV data.

LF

Column Delimiter

String

Column delimiter of CSV data.

COMMA

Assignment Rule Id

String

ID of an assignment rule to run for a case or a lead. The assignment rule can be active or inactive.

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the ID lookup field property for standard objects.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Salesforce headers. For information, see Create a Job in the Salesforce documentation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Metadata `` Adds one or more new metadata components to your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type to create.

x

Metadata Objects

Array of Object

List of Map<String,Object> representing the metadata to create.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Create Query Job Bulk Api V2 `` Creates a query job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Query

String

Query used to create the job.

x

Operation

Enumeration, one of:

  • QUERY

  • QUERY_ALL

Operation used.

QUERY

Column Delimiter

String

Type of delimiter used.

COMMA

Line Ending

String

Line ending used.

CRLF

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Salesforce headers. For information, see Create a Query Job in the Salesforce documentation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job State

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Delete `` Deletes one or more records from your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Records To Delete Ids

Array of String

Array of one or more IDs associated with the objects to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Delete Job Bulk Api V2 `` Deletes a Bulk API v2 Job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Delete Metadata `` Deletes one or more metadata components from your organization, given the API name of the objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to delete.

x

Full Names

Array of String

Full names of the components to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Delete Query Job Bulk Api V2 `` Deletes a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Deploy Metadata `` A file-based call to deploy XML components. Use this operation to take file representations of components and deploy them into an organization by creating, updating, or deleting the components they represent.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Deploy Metadata Request

Data needed by this operation.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Global `` Retrieves a list of available objects for your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe Global Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Metadata `` Retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other components.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Sobject `` Describes metadata (field list and object properties) for the specified object.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Object. The specified value must be a valid object for your organization. For a complete list of objects, see Standard Objects.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe S Object Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Find Duplicates `` Performs rule-based searches for duplicate records. The input is an array of Salesforce objects, each of which specifies the values to search for and the type of object that supplies the duplicate rules. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the values to do the search. The output identifies the detected duplicates for each SObject.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of SObjects to find duplicates for.

x

Criteria

Array of Object

List of SObjects used as a criterion when searching for duplicates.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Find Duplicates Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Find Duplicates By Ids `` Performs rule-based searches for duplicate records. The input is an array of IDs, each of which specifies the records for which to search for duplicates. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the record IDs to do the search. The output identifies the detected duplicates for each ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Ids List

Array of String

List of IDs to find duplicates.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Find Duplicates Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get All Jobs Bulk Api V2 `` Retrieves all Bulk jobs. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Desired concurrency mode.

Parallel

Pk Chunking

Boolean

Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Bulk Job V2 Result

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get All Query Jobs Bulk Api V2 `` Retrieves all Bulk query jobs.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Pk Chunking

Boolean

Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Job Type

Enumeration, one of:

  • BigObjectIngest

  • Classic

  • V2Query

Job type.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Desired concurrency mode.

Parallel

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Query Jobs Info Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Deleted `` Retrieves the list of records deleted from a particular time in the past (specified in minutes).
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type. The specified value must be a valid object for your organization.

x

Start Date

DateTime

Starting date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

x

End Date

DateTime

Ending date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC).

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get Deleted Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get Job State Bulk Api V2 `` Gets the state of a v2 Bulk job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Query Job Info Bulk Api V2 `` Returns the details of a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Query Job Results Bulk Api V2 `` Returns the results of a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Max Records Per Page

Number

Number of records that are on each page retrieved from the API. This number influences the number of API requests and the memory used by the connector to handle the results.

Salesforce Connector automatically handles pagination and retrieves all pages before the next processing job starts.

2000

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Server Timestamp `` Retrieves the current system timestamp, in Coordinated Universal Time (UTC), from the API.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

DateTime

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get updated objects `` Retrieves the list of individual records that are created or updated between the specified start and end date.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type. The specified value must be a valid object for your organization.

x

Start Date

DateTime

Starting date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

x

End Date

DateTime

Ending date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If a value is not provided, the current server time is used.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get Updated Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get User Info `` Retrieves personal information for the user associated with the current session.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get User Info Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Invoke Apex Rest Method `` Invokes any operation from an Apex class that is exposed as a REST web service.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Request

Object

Object containing request information, some of which can include object queryParams with key-value pairs. These parameters are passed as URL parameters to the Apex Rest endpoint, for example:

queryParams: {AccountId : "a0w0E0000069MDxQAM" , ContactId: "0030E00000rRSJ6QAO" }

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Apex Class Name

String

Apex class name.

x

Apex Class Method Name

String

Apex class method name. The method name format is:

ApexMethodName^RestResourceURL^HttpMethod^OutputType^InputParameterName1=ParameterType1,InputParameterName2=ParameterType2

For example:

getAccountInfo^/accountInfo/*^HttpGet^void

Special characters aren’t allowed in ApexMethodName.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Invoke Apex Soap Method `` Invokes any operation from an Apex class that is exposed as a SOAP web service.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Input

Binary

InputStream with XML that contains information about the method to invoke and its parameters. The XML must adhere to the WSDL standards.

#[payload]

Apex Headers

Object

Parameters specifying the SOAP Headers to send to the API. For more information about the supported headers, see SOAP API and SOAP Headers for Apex.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Apex Class Name

String

Apex class name.

x

Apex Class Method Name

String

Apex class method name.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Job Info `` Accesses the latest JobInfo of a submitted JobInfo ID. This operation enables you to track the execution status.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID of the job that is monitored.

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### List Metadata `` Retrieves property information about metadata components in your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type used as a criterion when querying for information.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of File Properties

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Merge `` Merges up to three records into one record.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Records To Merge Ids

Array of String

List of IDs of the objects to merge.

#[payload]

Type

String

Type of record to merge.

x

Master Record

Object

Must provide the ID of the object that other records are merged into. Optionally, provide the fields to update and their values.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Merge Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Merge Multiple `` Combines up to three records of the same type into one record. The input is an array of MergeRequest elements, each of which specifies the records to combine. #### Limitations - The only supported object types are: - Lead - Contact - Account - Person Account - Individual Only objects of the same type can be merged. For example, merge leads only with leads. - The **Merge Multiple** operation enables you to specify a list of a maximum of 200 merge requests. - A merge request can contain a maximum of three IDs: - The master record ID - Up to two IDs for the records to merge into the primary record
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

List of Merge Records

Array of Merge Record

List of merge records. Each merge record contains the primary record, the record to merge IDs into, and an optional additional information map.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Map<String, Object>

Declares the request headers to use with this operation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Merge Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Platform Event Message `` Adds one new platform event to your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Platform Event name

String

Name of the platform event to create.

x

Platform Event Message

Array of Object

List<PlatformEventMessage> to create.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Streaming Channel `` Creates a streaming channel in which generic, custom messages are pushed.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Channel name

String

Descriptive name of the streaming channel. Limit of 80 characters, and must start with /u/. This value identifies the channel and must be unique.

x

Owner Id

String

Identifier for the channel owner.

Description

String

Description of what kinds of records are returned by the query. Limit of 255 characters.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Topic `` Creates a topic representing a query that is used to notify listeners when changes are made to records in an organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Topic Name

String

Topic name.

x

Query

String

Query name.

x

Description

String

Description.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Push Generic Event `` Pushes generic streaming custom events to the specified streaming channel.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Events

Event list.

#[payload]

Channel Id

String

Streaming channel name.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Push Event Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query (Deprecated) `` Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are strings and, if necessary, you can convert them to the appropriate type, for example, by using DataWeave and **Transform Message**. The **Query** operation is now deprecated. Use the [**Query Xml Stream**](#queryXmlStream) operation instead.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query All `` Retrieves data from specified objects, whether or not they have been deleted.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query Result List `` Returns a list of result IDs for a specific batch. If the batch requires retries, there is more than one element in the output. Use this operation with [Query Result Stream By Id](#queryResultStreamById) to obtain the results of the query.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo to retrieve the results for.

#[payload]

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation.

XML

Output Mime Type

String

MIME type of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of a variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of String

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Query Result Stream By Id `` Returns an InputStream with the query results for a specific result ID of a submitted BatchInfo. Obtain the result IDs first by using the [Query Result List](#queryResultList) operation.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo that returns the result ID.

#[payload]

x

Result ID

String

Result ID obtained with Query Result List.

x

Output Mime Type

String

MIME type of the payload output of this operation.

Output Encoding

String

Encoding of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configure how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of a variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Binary

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Query Xml Stream `` Executes a query against the specified object and returns data that matches the specified criteria. This operation returns paginated results. Each result is an InputStream of XML records.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Output Mime Type

String

MIME type of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Headers

Object

Headers to include in the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of String payload and Void attributes

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED - SALESFORCE:RETRY\_EXHAUSTED ### Read Metadata `` Returns one or more metadata components from your organization, given the objects' API names.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to read.

x

Full Names

Array of String

List of full names of the components to read.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Rename Metadata `` Renames a metadata component in your organization, given its old API name and the new name.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the component to rename.

x

Old Full Name

String

Current component full name.

x

New Full Name

String

New component full name.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Reset Password `` Resets the password of the user corresponding to the provided user ID, or the user linked to the connector’s configuration, if the user ID field is null.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User to reset the password for. If unspecified, the current user is used.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Reset Password Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Retrieve `` Retrieves one or more records based on the specified IDs.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to retrieve.

x

Retrieve Request

Must provide the IDs and specify the fields for the records to retrieve.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Retrieve Job Failed Results Bulk V2 `` Gets the status of the failed processed SObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Job Failed Record Results

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Job Successful Results Bulk V2 `` Gets the status of the successfully processed SObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Job Successful Record Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Job Unprocessed Results Bulk V2 `` Gets the status of the unprocessed sObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Metadata `` Retrieves XML file representations of components in an organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Package Names

Array of String

List of package names to retrieve. If you are retrieving only unpackaged components, do not specify a name. You can retrieve packaged and unpackaged components in the same retrieval operation.

Specific Files

Array of String

List of file names to retrieve. If a value is specified for this property, Package Names must be set to null.

Unpackaged

Binary

Stream containing a list of components to retrieve that are not in a package.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Binary

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Search `` Searches for objects using Salesforce Object Search Language (SOSL). Mimics using the search box inside the Salesforce UI.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Search String

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Search Language (SOSL).

x

Parameters

Object

Map with values for placeholders in Search String.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Search Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Set Password `` Changes the password of a user or a self service user to a value that you specify.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User to set the password for.

x

New Password

String

New password for the user.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Unauthorize `` Deletes all of the access token information of a given resource owner ID so that it is impossible to execute an operation for that user without performing the OAuth dance.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner for whom to invalidate access.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

#### Associated Configurations - [Configuration](#sfdc-config) ### Update `` Updates one or more existing records in your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to update.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Update Metadata `` Updates one or more metadata components in your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to update.

x

Metadata Objects

Array of Object

List of Map<String, Object> representing the metadata to update.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Upsert `` Upserts a homogeneous list of objects. Creates new records and updates existing records using a custom field to determine the presence of existing records. In most cases, use `#upsert(String, String, List, Map)` over `#create(String, List, Map)` to avoid creating unwanted, duplicate records. > [!NOTE] Although you cannot change the **Content Type** value for a bulk upsert, you can use the > [**Create Job**](#createJob) operation to set the content type to CSV (or zipped CSV if you reach > the character limit) and then follow up with the [**Create Batch**](#createBatch) operation.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Type of record to upsert.

x

External Id Field Name

String

Either of the following:

  • For a custom object, the name of the field that contains the external ID field name

  • For a standard object, the name of the field that contains the ID lookup field name

Unless you configure the External Id Field Name field for the SObject to upsert, the Upsert operation fails.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Upsert Metadata `` Creates or updates one or more metadata components in your organization. For a picklist field in an object, the **Upsert Metadata** operation updates only the picklist mapping for that specific object. To update the actual picklist values, such as adding or removing values in the picklist, use the [**Deploy Metadata**](#deployMetadata) operation. You must perform a metadata deploy for **Custom Field** or **Global Picklist** based on whether the picklist is tied to a custom field or is a global picklist.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to create or update.

x

Metadata Objects

Array of Object

List of Map<String, Object> representing the metadata to upsert.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Upsert Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ## Object Types - [Action Override](#ActionOverride) - [Additional Information Map](#AdditionalInformationMap) - [Batch Info](#BatchInfo) - [Bulk Item](#BulkItem) - [Bulk Job State](#BulkJobState) - [Bulk Job V2 Result](#BulkJobV2Result) - [Bulk Operation Result](#BulkOperationResult) - [Child Relationship](#ChildRelationship) - [Create Job Request](#CreateJobRequest) - [CRL File](#crl-file) - [Cron](#cron) - [Custom OCSP Responder](#custom-ocsp-responder) - [Deleted Record](#DeletedRecord) - [Deploy Metadata Request](#DeployMetadataRequest) - [Describe Global Result](#DescribeGlobalResult) - [Describe Global S Object Result](#DescribeGlobalSObjectResult) - [Describe Metadata Object](#DescribeMetadataObject) - [Describe Metadata Result](#DescribeMetadataResult) - [Describe S Object Result](#DescribeSObjectResult) - [Duplicate Result](#DuplicateResult) - [Entity Search Metadata](#EntitySearchMetadata) - [Error](#Error) - [Error Mapping](#ErrorMapping) - [Expiration Policy](#ExpirationPolicy) - [Field](#Field) - [Field Diff](#FieldDiff) - [Field Level Search Metadata](#FieldLevelSearchMetadata) - [File Properties](#FileProperties) - [Filtered Lookup Info](#FilteredLookupInfo) - [Find Duplicates Result](#FindDuplicatesResult) - [Fixed Frequency](#fixed-frequency) - [Generic Streaming Event](#GenericStreamingEvent) - [Get Deleted Result](#GetDeletedResult) - [Get Updated Result](#GetUpdatedResult) - [Get User Info Result](#GetUserInfoResult) - [Job Failed Record Results](#JobFailedRecordResults) - [Job Info](#JobInfo) - [Job Successful Record Result](#JobSuccessfulRecordResult) - [Job Unprocessed Record Result](#JobUnprocessedRecordResult) - [Keystore](#KeyStore) - [Labels Search Metadata](#LabelsSearchMetadata) - [Lead Convert Result](#LeadConvertResult) - [Lead Convert Request](#LeadConvertRequest) - [Match Record](#MatchRecord) - [Match Result](#MatchResult) - [Merge Record](#MergeRecord) - [Merge Result](#MergeResult) - [Metadata Result](#MetadataResult) - [Name Value Pair](#NameValuePair) - [Named Layout Info](#NamedLayoutInfo) - [Non-Repeatable Stream](#non-repeatable-stream) - [Pick List Entry](#PickListEntry) - [Proxy](#ProxyConfiguration) - [Push Event Result](#PushEventResult) - [Query Job Info](#QueryJobInfo) - [Query Job State](#QueryJobState) - [Query Jobs Info Result](#QueryJobsInfoResult) - [Reconnect](#reconnect) - [Reconnect Forever](#reconnect-forever) - [Reconnection](#reconnection) - [Record Type Info](#RecordTypeInfo) - [Redelivery Policy](#RedeliveryPolicy) - [Redelivery Policy Message Identifier](#RedeliveryPolicyMessageIdentifier) - [Repeatable File Store Iterable](#repeatable-file-store-iterable) - [Repeatable File Store Stream](#repeatable-file-store-stream) - [Repeatable In Memory Iterable](#repeatable-in-memory-iterable) - [Repeatable In Memory Stream](#repeatable-in-memory-stream) - [Reset Password Result](#ResetPasswordResult) - [Result](#Result) - [Retrieve Request](#RetrieveRequest) - [Search Record](#SearchRecord) - [Search Record Metadata](#SearchRecordMetadata) - [Search Result](#SearchResult) - [Search Results Metadata](#SearchResultsMetadata) - [Search Snippet](#SearchSnippet) - [Simple Error](#SimpleError) - [Standard Revocation Check](#standard-revocation-check) - [TLS](#Tls) - [Truststore](#TrustStore) - [Upsert Metadata Result](#UpsertMetadataResult) ### Action Override Action override.
FieldTypeDescriptionDefault ValueRequired

Available In Touch

Boolean

Indicates whether available in touch or not.

From Factor

String

From factor.

Name

String

Name.

Page Id

String

Page ID.

Url

String

URL.

### Additional Information Map Additional information map.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name of the map.

Value

String

Value of the map.

### Batch Info Batch information.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Created Date

DateTime

Date created.

Id

String

ID name.

Job Id

String

Job ID.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

State

Enumeration, one of:

  • Queued

  • InProgress

  • Completed

  • Failed

  • NotProcessed

State.

State Message

String

State message.

System Modstamp

DateTime

System modstamp.

Total Processing Time

Number

Total processing time.

### Bulk Item Bulk item.
FieldTypeDescriptionDefault ValueRequired

Exception

Any

Exception.

Id

Any

ID.

Message

String

Message.

Payload

Payload.

Status Code

String

Status code.

Successful

Boolean

Determines if successful or not.

### Bulk Job State Bulk job state.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Api Version

Number

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Error Message

String

Error message.

External Id Field Name

String

External ID field name.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

Object

String

Object.

Operation

String

Operation name.

Retries

Number

Number of retries.

State

String

State.

System Modstamp

String

System modstamp.

Total Processing Time

Number

Total processing time.

### Bulk Job V2 Result Bulk job v2 result.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Content Url

String

Content URL.

Created By Id

String

Created by ID.

Created Date

String

Date created.

External Id Field Name

String

External ID field name.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Bulk Operation Result Bulk operation result.
FieldTypeDescriptionDefault ValueRequired

Id

Any

ID.

Items

Array of Bulk Item

Array of the Bulk Item type.

Successful

Boolean

Determines if successful or not.

### Child Relationship Child relationship.
FieldTypeDescriptionDefault ValueRequired

Cascade Delete

Boolean

Cascade delete.

Child S Object

String

Child SObject.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Field

String

Field.

Junction Id List Names

Array of String

Junction ID list names.

Junction Reference To

Array of String

Junction reference to.

Relationship Name

String

Relationship name.

### Create Job Request Create job request.
FieldTypeDescriptionDefault ValueRequired

External Id Field Name

String

Name of the field on this object. Use this attribute for custom objects or the ID lookup field property for standard objects (only required for upsert operations).

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type for the job results.

When specifying a content type different from XML for a query type, use the queryResultStream(BatchInfo) method to retrieve results.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Concurrency mode of the job.

### CRL File Specifies the location of the certification revocation list (CRL) file.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the CRL file.

### Cron CRON.
FieldTypeDescriptionDefault ValueRequired

Expression

String

Cron expression.

x

Time zone

String

ID of the time zone on which to base the expression. Refer to the java.util.TimeZone Javadoc for the format and valid values for this ID.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.
FieldTypeDescriptionDefault ValueRequired

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

### Deleted Record Deleted record.
FieldTypeDescriptionDefault ValueRequired

Deleted Date

DateTime

Deleted date.

Id

String

ID name.

### Deploy Metadata Request Deploy metadata request.
FieldTypeDescriptionDefault ValueRequired

Stream

Binary

Stream containing the data. This parameter defaults to the payload content.

x

Ignore Warnings

Boolean

If true, a warning allows a deployment to complete successfully.

false

Purge On Delete

Boolean

If true, the deleted components in the destructiveChanges.xml manifest file are not stored in the Recycle Bin. This option only works in the Developer Edition or in sandbox organizations; it does not work in production organizations.

false

Rollback On Error

Boolean

If true, failures cause a complete rollback.

true

### Describe Global Result Describe global result.
FieldTypeDescriptionDefault ValueRequired

Encoding

String

Encoding.

Max Batch Size

Number

Maximum batch size.

Sobjects

SObject results.

### Describe Global S Object Result Describe global SObject results.
FieldTypeDescriptionDefault ValueRequired

Activateable

Boolean

Indicates whether activateable or not.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Custom Setting

Boolean

Indicates whether there is a custom setting or not.

Deletable

Boolean

Indicates whether deletable or not.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Feed Enabled

Boolean

Indicates whether the feed is enabled.

Key Prefix

String

Key prefix.

Label

String

Label.

Label Plural

String

Label plural.

Layoutable

Boolean

Indicates whether layoutable or not.

Mergeable

Boolean

Indicates whether mergeable or not.

Mru Enabled

Boolean

Indicates whether MRU is enabled or not.

Name

String

Name.

Queryable

Boolean

Indicates whether queryable or not.

Replicateable

Boolean

Indicates whether replicateable or not.

Retrieveable

Boolean

Indicates whether retrieveable or not.

Searchable

Boolean

Indicates whether searchable or not.

Triggerable

Boolean

Indicates whether triggerable or not.

Undeleteable

Boolean

Indicates whether undeleteable or not.

Updateable

Boolean

Indicates whether updateable or not.

### Describe Metadata Object Describe metadata object.
FieldTypeDescriptionDefault ValueRequired

Child Xml Names

Array of String

Child XML names.

Directory Name

String

Directory name.

In Folder

Boolean

Indicates whether the metadata object is in the folder.

Meta File

Boolean

Indicates whether the metadata object is a meta file.

Suffix

String

Suffix.

Xml Name

String

XML name.

### Describe Metadata Result Describe metadata result.
FieldTypeDescriptionDefault ValueRequired

Metadata Objects

Metadata objects.

Organization Namespace

String

Organization namespace.

Partial Save Allowed

Boolean

Indicates whether partial save is allowed.

Test Required

Boolean

Indicates whether a test is required.

### Describe S Object Result Describe SObject result.
FieldTypeDescriptionDefault ValueRequired

Action Overrides

Action overrides.

Activateble

Boolean

Indicates whether activateable or not.

Child Relationships

Child relationships.

Compact Layoutable

Boolean

Compact layoutable.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Custom Setting

Boolean

Indicates whether there is a custom setting or not.

Deletable

Boolean

Indicates whether deletable or not.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Feed Enabled

Boolean

Indicates whether the feed is enabled.

Fields

Array of Field

Fields.

Key Prefix

String

Key prefix.

Label

String

Label.

Label Plural

String

Label plural.

Layoutable

Boolean

Indicates whether layoutable or not.

Mergeable

Boolean

Indicates whether mergeable or not.

Mru Enabled

Boolean

Indicates whether MRU is enabled or not.

Name

String

Name.

Named Layout Infos

Named layout information.

Network Scope Field Name

String

Network scope field name.

Queryable

Boolean

Indicates whether queryable or not.

Record Type Infos

Record type information.

Replicateable

Boolean

Indicates whether replicateable or not.

Retrieveable

Boolean

Indicates whether retrieveable or not.

Search Layoutable

Boolean

Indicates whether the search is layoutable or not.

Searchable

Boolean

Indicates whether searchable or not.

Triggerable

Boolean

Indicates whether triggerable or not.

Undeleteable

Boolean

Indicates whether undeleteable or not.

Updateable

Boolean

Indicates whether updateable or not.

Url Detail

String

URL detail.

Url Edit

String

URL edit.

Url New

String

URL new.

### Duplicate Result Duplicate result.
FieldTypeDescriptionDefault ValueRequired

Allow Save

Boolean

Determines whether to allow saving or not.

Duplicate Rule

String

Duplicate rule.

Duplicate Rule Entity Type

String

Duplicate rule entity type.

Error Message

String

Error message.

Match Results

Array of Match Result

Match results.

### Entity Search Metadata Entity search metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Name

String

Entity name.

Field Metadata

Field metadata.

### Error Error.
FieldTypeDescriptionDefault ValueRequired

Duplicate Result

Duplicate result.

Fields

Array of String

Fields.

Message

String

Message.

Status Code

String

Status code.

### Error Mapping Error mapping.
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Source.

Target

String

Target.

x

### Expiration Policy Configures an expiration policy strategy.
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

### Field Field.
FieldTypeDescriptionDefault ValueRequired

Autonumber

Boolean

Indicates autonumber.

Byte Length

Number

Byte length.

Calculated

Boolean

Indicates whether calculated or not.

Case Sensitive

Boolean

Indicates whether case sensitive or not.

Controller Name

String

Controller name.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Default Value

Any

Default value.

Default Value Formula

String

Default value formula.

Defaulted On Create

Boolean

Indicates whether defaulted on create.

Dependent Pick List

Boolean

Indicates whether dependent pick list or not.

Deprecate And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Digits

Number

Digits.

Display Location In Decimal

Boolean

Indicates whether the display location is in decimal.

Encrypted

Boolean

Indicates whether encrypted or not.

Extra Type Info

String

Extra type information.

Field Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INT

  • DOUBLE

  • DATE

  • DATETIME

  • TIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANYTYPE

  • DATACATEGORYGROUPREFERENCE

  • ENCRYPTEDSTRING

  • ADDRESS

  • COMPLEXVALUE

  • LOCATION

  • JSON

  • LONG

Field type.

Filterable

Boolean

Indicates whether filterable or not.

Filtered Lookup Info

Filtered lookup information.

Formula

String

Formula.

Groupable

Boolean

Indicates whether groupable or not.

High Scale Number

Boolean

Indicates whether high scale number or not.

Html Formatted

Boolean

Indicates whether HTML formatted or not.

Id Lookup

Boolean

Indicates ID lookup.

Inline Help Text

String

Inline help text.

Label

String

Label.

Length

Number

Length.

Mask

String

Mask.

Mask Type

String

Mask type.

Name

String

Name.

Name Field

Boolean

Indicates name field.

Name Pointing

Boolean

Indicates name pointing.

Nullable

Boolean

Indicates whether nullable or not.

Permissinable

Boolean

Indicates whether permissionable or not.

Picklist Values

Picklist values.

Polymorphic Foreign Key

Boolean

Indicates polymorphic foreign key.

Precision

Number

Precision.

Reference Target Field

String

Reference target field.

Reference To

Array of String

Reference to.

Relationship Name

String

Relationship name.

Relationship Order

Number

Relationship order.

Required

Boolean

Indicates whether required or not.

Restricted Picklist

Boolean

Indicates whether restricted picklist or not.

Scale

Number

Scale.

Search Filterable

Boolean

Indicates whether search filterable or not.

Sortable

Boolean

Indicates whether sortable or not.

Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INT

  • DOUBLE

  • DATE

  • DATETIME

  • TIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANYTYPE

  • DATACATEGORYGROUPREFERENCE

  • ENCRYPTEDSTRING

  • ADDRESS

  • COMPLEXVALUE

  • LOCATION

  • JSON

  • LONG

Type.

Unique

Boolean

Indicates whether unique or not.

Updateable

Boolean

Indicates whether updateable or not.

Write Requires Master Read

Boolean

Indicates whether write requires master read or not.

### Field Diff Field difference.
FieldTypeDescriptionDefault ValueRequired

Difference

Enumeration, one of:

  • DIFFERENT

  • NULL

  • SAME

  • SIMILAR

Field differences.

Name

String

Name of the field.

### Field Level Search Metadata Field level search metadata.
FieldTypeDescriptionDefault ValueRequired

Label

String

Label.

Name

String

Name.

Type

String

Type.

### File Properties File properties.
FieldTypeDescriptionDefault ValueRequired

Created By

String

Created by.

Created By Name

String

Created by name.

Created Date

DateTime

Date created.

File Name

String

File name.

Full Name

String

Full name.

Id

String

ID name.

Last Modified By Id

String

Last modified by ID.

Last Modified By Name

String

Last modified by name.

Last Modified Date

String

Last modified date.

Manageable State

Enumeration, one of:

  • released

  • deleted

  • deprecated

  • installed

  • beta

  • unmanaged

Manageable state.

Namespace Prefix

String

Namespace prefix.

Type

String

Type.

### Filtered Lookup Info Filtered lookup information.
FieldTypeDescriptionDefault ValueRequired

Controlling Fields

Array of String

Controlling fields.

Dependent

Boolean

Indicates dependent or not.

Optional Filter

Boolean

Indicates optional filter or not.

### Find Duplicates Result Find duplicates result.
FieldTypeDescriptionDefault ValueRequired

Duplicate Results

Duplicate results.

Errors

Array of Error

Errors.

Success

Boolean

Determines if successful or not.

### Fixed Frequency Fixed frequency.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

Frequency at which the scheduler initiates the flow, based on the time unit specified in the Time Unit field.

1000 (MILLISECONDS)

x

Start delay

Number

Amount of time that the scheduler waits before initiating the flow for the first time after the app starts. This value is based on the time unit specified in the Time Unit field.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Frequency and Start delay fields.

MILLISECONDS

### Generic Streaming Event Generic streaming event.
FieldTypeDescriptionDefault ValueRequired

Payload

String

Payload.

User Ids

Array of String

User IDs.

### Get Deleted Result Get deleted result.
FieldTypeDescriptionDefault ValueRequired

Deleted Records

Deleted records.

Earliest Date Available

DateTime

Earliest date available.

Latest Date Covered

DateTime

Latest date covered.

### Get Updated Result Get updated result.
FieldTypeDescriptionDefault ValueRequired

Ids

Array of String

IDs.

Latest Date Covered

DateTime

Latest date covered.

### Get User Info Result Get user information result.
FieldTypeDescriptionDefault ValueRequired

Accessibility Mode

Boolean

Indicates accessibility mode.

Currency Symbol

String

Currency symbol.

Org Attachment File Size Limit

Number

Organization attachment file size limit.

Org Default Currency Iso Code

String

Organization default currency ISO code.

Org Default Currency Locale

String

Organization default currency locale.

Org Disallow Html Attachments

Boolean

Indicates whether the organization disallows HTML attachments.

Org Has Person Accounts

Boolean

Indicates whether the organization contains person accounts.

Organization Id

String

Organization ID.

Organization Multi Currency

Boolean

Organization multicurrency.

Organization Name

String

Organization name.

Profile Id

String

Profile ID.

Role Id

String

Role ID.

Session Seconds Valid

Number

Session seconds valid.

User Default Currency Iso Code

String

User default currency ISO code.

User Email

String

User email.

User Full Name

String

User full name.

User Id

String

User ID.

User Language

String

User language.

User Locale

String

User locale.

User Name

String

User name.

User Time Zone

String

User time zone.

User Type

String

User type.

User Ui Skin

String

User UI skin.

### Job Failed Record Results Job failed record results.
FieldTypeDescriptionDefault ValueRequired

Error Message

String

Error message.

Id

String

ID name.

Original Fields

Object

Original fields.

### Job Info Job info.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Api Version

Number

API version.

Assignment Rule Id

String

ID of an assignment rule for a case or lead. The assignment rule can be active or inactive.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Concurrency mode.

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type.

Created By Id

String

Created by ID.

Created Date

DateTime

Date created.

External Id Field Name

String

External ID field name.

Fast Path Enabled

Boolean

Determines whether fast path is enabled.

Id

String

ID name.

Number Batches Completed

Number

Number of batches that are completed.

Number Batches Failed

Number

Number of batches that failed.

Number Batches In Progress

Number

Number of batches in progress.

Number Batches Queued

Number

Number of batches that are queued.

Number Batches Total

Number

Number of batches in total.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

Number Retries

Number

Number of retries.

Object

String

Object.

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

  • queryAll

Operation name.

State

Enumeration, one of:

  • Open

  • Closed

  • Aborted

  • Failed

State.

System Modstamp

DateTime

System modstamp.

Total Processing Time

Number

Total processing time.

### Job Successful Record Result Job successful record result.
FieldTypeDescriptionDefault ValueRequired

Created

Boolean

Indicates whether the job is created or not.

Id

String

ID name.

Original Fields

Object

Original fields.

### Job Unprocessed Record Result Job unprocessed record result.
FieldTypeDescriptionDefault ValueRequired

Original Fields

Object

Original fields.

### Keystore Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

### Labels Search Metadata Labels search metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Field Labels

Entity field labels.

Entity Name

String

Entity name.

### Lead Convert Result Lead convert result.
FieldTypeDescriptionDefault ValueRequired

Account Id

String

Account ID.

Contact Id

String

Contact ID.

Errors

Array of Error

Errors.

Lead Id

String

Lead ID.

Opportunity Id

String

Opportunity ID.

Success

Boolean

Determines if successful or not.

### Lead Convert Request Lead convert request.
FieldTypeDescriptionDefault ValueRequired

Contact Id

String

ID of the contact into which the lead is merged (this contact must be associated with the specified account ID, and an account ID must be specified). Required only when updating an existing contact.

If you are converting a lead into a person account, do not specify the contact ID or else an error results. Specify only the account ID of the person account. If no contact ID is specified, then the API creates a new contact that is implicitly associated with the account. To create a new contact, the client application must be logged in with sufficient access rights. To merge a lead into an existing contact, the client application must be logged in with read or write access to the specified contact. The contact name and other existing data are not overwritten (unless Over Write Lead Source is set to true, in which case only the lead source field is overwritten). For information on IDs, see ID Field Type.

Account Id

String

ID of the account into which the lead is merged. Required only when updating an existing account, including person accounts. If no account ID is specified, then the API creates a new account. To create a new account, the client application must be logged in with sufficient access rights. To merge a lead into an existing account, the client application must be logged in with read or write access to the specified account. The account name and other existing data are not overwritten. For information on IDs, see ID Field Type.

Send Email To Owner

Boolean

If true, specifies whether to send a notification email to the owner specified in the Owner ID.

false

Opportunity Name

String

Name of the opportunity to create. If unspecified, this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If Do Not Create Opportunity is true, then no opportunity is created and this field must be left blank; otherwise, an error is returned.

Do Not Create Opportunity

Boolean

Specifies whether to create an opportunity during lead conversion. Set this flag to true only if you do not want to create an opportunity from the lead. An opportunity is created by default.

false

Over Write Lead Source

Boolean

Specifies whether to overwrite the lead source field on the target contact object with the contents of the lead source field in the source lead object. To set this field to true, the client application must specify a Contact Id for the target contact.

false

Opportunity Id

String

ID of an existing opportunity to relate to a lead during lead conversion.

Owner Id

String

Name associated with the owner ID that owns this lead.

Related Person Account Id

String

When converting a lead to a business account and an existing person account, this value specifies the ID of the person account.

Related Person Account Record

Object

When converting a lead to a business account and a new person account, this value specifies the entity record of the new person account.

### Match Record Match record.
FieldTypeDescriptionDefault ValueRequired

Additional Information

Additional information.

Field Diffs

Array of Field Diff

Field differences.

Match Confidence

Number

Match confidence.

Record

Object

Record.

### Match Result Match result.
FieldTypeDescriptionDefault ValueRequired

Entity Type

String

Entity type.

Errors

Array of Simple Error

Errors.

Match Engine

String

Match engine name.

Match Records

Array of Match Record

Match records.

Rule

String

Rule name.

Size

Number

Size.

Success

Boolean

Determines if successful or not.

### Merge Record Merge record.
FieldTypeDescriptionDefault ValueRequired

Master Record

Object

Master record that contains at least the ID and the type of the object that other records merge into. Optionally, provide the fields and their values to update.

x

Record To Merge Ids

Array of String

Additional records to merge into the primary record. Minimum of one record and maximum of two records.

x

Additional Information Map

Object

Field-value map. When a portal user ID is merged, it must contain two entries: name: PortalUserId and value: ID of the portal user. In all other merge cases, set to null or leave empty.

### Merge Result Merge result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Errors.

Id

String

ID name.

Merged Record Ids

Array of String

Merged record IDs.

Success

Boolean

Determines if successful or not.

Updated Related Ids

Array of String

Updated related IDs.

### Metadata Result Metadata result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Errors.

Full Name

String

Full name.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

### Name Value Pair Name value pair.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name.

Value

String

Value.

### Named Layout Info Named layout information.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name.

### Non-Repeatable Stream Configures the non-repeatable streaming strategy, in which Mule disables repeatable streams. Use this strategy if your use case requires reading the content only once. In some cases, you might want to disable the repeatable stream functionality and use non-repeatable streams, which can have less performance overhead, memory use, and cost. ### Pick List Entry Pick list entry.
FieldTypeDescriptionDefault ValueRequired

Active

Boolean

Indicates active or not.

Default Value

Boolean

Indicates default value.

Label

String

Label.

Valid For

Binary

Indicates when valid for.

Value

String

Value.

### Proxy Configures a proxy for outbound connections.
FieldTypeDescriptionDefault ValueRequired

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

### Push Event Result Push event result.
FieldTypeDescriptionDefault ValueRequired

Fanout Count

Number

Fanout count.

User Online Status

Object

User online status.

### Query Job Info Query job information.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Number Records Processed

Number

Number of records that are processed.

Object

String

Object.

Operation

String

Operation name.

Pk Chunking Supported

Boolean

Whether or not PK chunking is supported.

Retries

Number

Number of retries.

State

String

State.

System Modstamp

String

System modstamp.

Total Processing Time

Number

Total processing time.

### Query Job State Query job state.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Query Jobs Info Result Query jobs information result.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Reconnect Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

### Reconnection Configures a reconnection strategy for an operation.
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

### Record Type Info Record type information.
FieldTypeDescriptionDefault ValueRequired

Available

Boolean

Indicates whether available or not.

Default Record Type Mapping

Boolean

Indicates default record type mapping.

Id

String

ID name.

Master

Boolean

Indicates master.

Name

String

Name.

### Redelivery Policy Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
FieldTypeDescriptionDefault ValueRequired

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

### Redelivery Policy Message Identifier Configures the redelivery policy message identifier type.
FieldTypeDescriptionDefault ValueRequired

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if the Use Secure Hash field is false.

### Repeatable File Store Iterable Repeatable file store iterable.
FieldTypeDescriptionDefault ValueRequired

In Memory Objects

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Repeatable In Memory Iterable Repeatable in memory iterable.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower means that the buffer must not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### Reset Password Result Reset password result.
FieldTypeDescriptionDefault ValueRequired

Password

String

Password to authenticate against the proxy server.

### Result Result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Array of the Error type.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

### Retrieve Request Retrieve request.
FieldTypeDescriptionDefault ValueRequired

Fields

Array of String

Fields.

Ids

Array of String

IDs.

### Search Record Search record.
FieldTypeDescriptionDefault ValueRequired

Record

Object

Record.

Search Record Metadata

Search record metadata.

Snippet

Snippet.

### Search Record Metadata Search record metadata.
FieldTypeDescriptionDefault ValueRequired

Spell Corrected

Boolean

Indicates whether the search is spelled correctly.

### Search Result Search result.
FieldTypeDescriptionDefault ValueRequired

Query Id

String

Query ID.

Search Records

Array of Search Record

Search records.

Search Results Metadata

Search results metadata.

### Search Results Metadata Search results metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Label Metadata

Entity label metadata.

Entity Metadata

Entity metadata.

### Search Snippet Search snippet.
FieldTypeDescriptionDefault ValueRequired

Text

String

Text.

Whole Fields

Whole fields.

### Simple Error Simple error.
FieldTypeDescriptionDefault ValueRequired

Fields

Array of String

Fields.

Message

String

Message.

Status Code

String

Status code.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

### TLS Configures TLS to provide secure communications for the Mule app.
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

### Truststore Configures the truststore for TLS.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

### Upsert Metadata Result Upsert metadata result.
FieldTypeDescriptionDefault ValueRequired

Created

Boolean

Indicates whether created or not.

Errors

Array of Error

Errors.

Full Name

String

Full name.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.5 --- # Salesforce Connector 11.5 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule app in XML either from the Anypoint Studio XML editor or a text editor, perform the following actions to get access to the connector: - Add the namespace for the connector to your XML flow. - Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/salesforce http://www.mulesoft.org/schema/mule/salesforce/current/mule-salesforce.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The Maven `pom.xml` file generated by Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector. ```xml com.mulesoft.connectors mule-salesforce-connector x.x.x mule-plugin ``` Replace `x.x.x` with version information from Exchange. Ensure the connector version corresponds to the one 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 `salesforce`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next After completing your namespace and `pom.xml` file, you can try the [Salesforce Examples](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 12.0 is-latest-version: true --- # Salesforce Connector 12.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce (Salesforce Connector) enables you to create apps that react to Salesforce events such as adding, changing, or deleting objects, topics, documents, and channels. Salesforce Connector enables you to connect to the Salesforce APIs. This connector exposes methods for accessing Salesforce, including working with the [Salesforce Apex classes](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_dev_process_chapter.htm). This connector works with the Salesforce SOAP API, REST API, Bulk API, and Streaming API, depending on the operation you configure. Each API call uses a request/response pattern over an HTTPS connection. All required request headers, error handling, and HTTPS connection configurations are built into the connector. For compatibility information and fixed issues, see the Salesforce Connector release notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce SOAP, REST, Bulk, and Streaming APIs - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Access to the Salesforce target resource, which requires a [Salesforce developer account](https://developer.salesforce.com) and [Salesforce security token](https://help.salesforce.com/s/articleView?language=en_US&id=user_security_token.htm). You can receive a new security token by email if you run **Reset Security Token** through **My Personal Information** from the Salesforce Setup pages. - A consumer key and secret (available in your Salesforce developer account) - The namespace and schema location, if you are using OAuth authentication. If you plan to create the XML for your Mule app, include the correct namespace and schema location in your XML file. Studio adds this information to the XML file automatically when you add Salesforce Connector to a flow in a Mule app. ## Limitations - Salesforce Connector does not expose all possible operations of the Salesforce APIs. - Salesforce Connector does not provide access to the Chatter API or Tooling API. ## Audience - New users Read this document and create your Mule app in [Anypoint Studio](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-studio). The [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-config-topics) topic helps you extend your understanding of the connector. - Advanced users Read [XML and Maven Support](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-xml-maven), the [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-config-topics) topic, and [Examples](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-examples). ## Common Use Cases for the Connector Common use cases for Salesforce Connector include: - **ERP Integration** Give your sales team access to all relevant customer data from one system via real-time synchronization of data between Salesforce and your ERP & finance applications. For example, use Anypoint Connector for SAP (SAP Connector) to sync data between Salesforce and SAP and Anypoint Connector for NetSuite (NetSuite Connector) to sync data between Salesforce and NetSuite. - **Data Aggregation** Collect data from multiple Salesforce orgs, other CRMs, ERP systems, and databases into one Salesforce instance or use that information to generate reports. - **Legacy Modernization** Easily manage data post-acquisition, move off of a legacy CRM system, or migrate ERP data into Salesforce by automatically moving your data into Salesforce. - **Customer Experience** Deliver a consistent, connected customer experience across channels, increase customer satisfaction, and drive revenue growth by integrating Salesforce to applications such as ServiceNow, Marketo, and others. For examples of these use cases, refer to [Salesforce Connector Examples](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-examples). ## Authentication Types Salesforce Connector connections use the following authentication types: - Basic authentication Uses a username and password for authentication - OAuth 2.0 Delegates user authentication to the service hosting the user account - OAuth JWT Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication - OAuth Client Credentials Uses a client ID and client secret for authentication - OAuth SAML Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token For information about configuring these authentication types, see [Using Anypoint Studio to Configure Salesforce Connector](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-studio). ## Salesforce Connector Configurations and Examples The following table provides links to specific Salesforce Connector information:
SubjectDescription

Accept and Transform Data

Accept and transform data from Salesforce example

Apex SOAP and REST

Configure for APEX SOAP API and APEX REST API

APIs

List of Salesforce APIs that this connector can access

Application Development

Process order and integration patterns

Batched Data

Batch data using the Salesforce Bulk API

Lead Convert Request ID

Specify a lead ID using DataWeave

Parent Child Relationships

Create and update parent and child relationships example

Anypoint Exchange Templates and Examples

Simplify Salesforce Connector development with a template or example

Subscribe Topic

Subscribe to a Salesforce topic

Subscribe Streaming Channel

Subscribe to a Salesforce streaming channel

Replay Topic

Replay events from a Topic

Replay Streaming Channel

Replay Events from a Salesforce streaming channel

Custom Event Notifications

Get custom event notifications over a streaming channel

Push Event Notifications

Push Events to a Streaming Channel

Object Store Usage

Object Store usage and limitations

## Develop an Application To build an app, perform the following tasks: 1. Configure the connector. 2. Test the connection. 3. Build the rest of your flow. 4. Add and configure DataWeave. When developing an app, Salesforce Connector provides these integration patterns you can use with the Salesforce APIs: - Batch Data Synchronization An external system accesses, changes, deletes, or adds data in Salesforce in batches, and vice versa (Salesforce to external system). - Remote Call-In An external system accesses, changes, deletes, or adds data in Salesforce, and vice versa (Salesforce to external system). - Fire and Forget Remote Process Invocation Salesforce initiates a process in a third-party system and receives an acknowledgment that the process has started. The third-party system continues processing independent of Salesforce. - Request-Reply Remote Process Invocation Salesforce initiates a process in a remote system, waits for the remote system to finish processing, and accepts control returned from the remote system. - User Interface Update Based on Data Changes The Salesforce UI updates in response to a change in a third-party system. ## Salesforce APIs Salesforce Connector works with the Salesforce Apex SOAP API, Apex REST API, Bulk API, Metadata API, and Streaming API, but does not provide access to the Chatter API or the Tooling API. Each API call uses a request/response pattern over an HTTPS connection. All required request headers, error handling, and HTTPS connection configurations are built into the connector. - Apex SOAP API Salesforce [Apex SOAP API](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_api.htm?search_text=soap) exposes Apex class methods as custom SOAP web service calls. This allows an external app to invoke an Apex web service to perform an action in Salesforce. - Apex REST API Salesforce [Apex REST API](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest.htm) creates your own REST-based web services using Apex. This API has all of the advantages of the REST architecture, while adding the ability to define custom logic and including automatic argument or object mapping. - Bulk API Salesforce [Bulk API](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) quickly and securely loads batches of your organization’s data into Salesforce. See also [Load Data in Batches](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-config-topics#batchdata). - Metadata API Salesforce [Metadata API](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_intro.htm) manages customizations and build tools that work with the metadata model, not the data itself. - SOAP API Salesforce [SOAP API](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_quickstart_intro.htm) provides secure access to your organization’s information on Salesforce. Most of the operations that Salesforce Connector performs map to this API. All the Salesforce operations performed through the SOAP API have an optional parameter called `Headers` that can take any of the [Salesforce SOAP headers](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/soap_headers.htm). - Streaming API Salesforce [Streaming API](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/intro_stream.htm) securely receives notifications about changes to your organization’s information in Salesforce. See [Create a Streaming Channel to Receive Data from Salesforce](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-processing-events#createchannel) for more information about the use of the Streaming API. ## Anypoint Exchange Templates and Examples [Anypoint Exchange](https://www.mulesoft.com/exchange/) provides templates you can use as a starting point for your app, as well as examples that illustrate a complete solution. ### Salesforce Connector Templates in Exchange [Anypoint Exchange templates](https://www.mulesoft.com/exchange/?search=salesforce&type=template) provide starting points for Studio projects such as: - Account Broadcast template [Salesforce to Salesforce, Workday, SAP, and database account broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc.wday.sap.db-account-broadcast/) - Aggregation [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-contact-aggregation/), [opportunity](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-aggregation/), [user](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-user-aggregation/) - Bidirectional Sync template - Between Salesforce organizations [accounts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-account-bidirectional-sync/), [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-contact-bidirectional-sync/), [custom objects](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-casecustomobject-bidirectional-sync/), [opportunities](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-bidirectional-sync/), [users](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-user-bidirectional-sync/) - Other sources [database](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2db-account-bidirectional-sync/), [Microsoft Dynamics CRM](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2msdyn-account-bidirectional-sync/), [Siebel](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sieb-account-bidirectional-sync/) - Migration [accounts](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-account-migration/), [contacts](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-contact-migration/), [opportunities](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc-opportunity-migration/) ### Salesforce Connector Examples in Exchange [Anypoint Exchange examples](https://www.mulesoft.com/exchange/?search=salesforce&type=example) enable you to create complete Studio projects such as: - Batch processing [database](https://www.mulesoft.com/exchange/org.mule.examples/salesforce-to-MySQL-DB-using-Batch-Processing/) and [import leads](https://www.mulesoft.com/exchange/org.mule.examples/import-leads-into-salesforce/) - [Contacts](https://www.mulesoft.com/exchange/org.mule.examples/cache-scope-with-salesforce-contacts/) - [Data retrieval](https://www.mulesoft.com/exchange/org.mule.examples/salesforce-data-retrieval/) - [DataWeave](https://www.mulesoft.com/exchange/org.mule.examples/dataweave-with-flowreflookup/) ## Next Steps After you complete the prerequisites and experiment with templates and examples, you are ready to create an app with [Anypoint Studio](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce APIs: What they are and when to use them](https://developer.salesforce.com/) - [Which Salesforce API should I use?](https://help.salesforce.com/s/articleView?id=integrate_what_is_api.htm&language=en_US&type=5) - [Salesforce Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-connector-release-notes-mule-4) - [Salesforce Connector in Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-salesforce-connector/) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 12.0 is-latest-version: true --- # Salesforce Connector 12.0 Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Configure Anypoint Connector for Salesforce (Salesforce Connector) to: - Load data in batches - Specify a Lead ID for a Lead Convert Request operation - Update field values to `null` - Generate an OAuth 2.0 keystore file - Invoke an APEX Rest method ## Load Data in Batches The Salesforce Bulk API loads batches of your organization’s data into Salesforce. Salesforce Connector provides the **Create** and **Create Bulk** operations for working with the Bulk API. For all bulk operations, Salesforce handles the creation process in the background. The connector replies with a `BatchInfo` object, which contains the ID of the batch and the ID of the job it creates to upload the batched objects. In Salesforce, you can track the status of bulk data load jobs and their associated batches by using the job ID for Bulk Data Load Jobs: 1. Click ** Setup > Monitoring > Bulk Data Load Jobs**. 2. Click the job ID to view the job detail page. The job detail page includes a list of all the batches related to the job. The list provides `View Request` and `View Response` links for each batch. If the batch is a CSV file, the links return the request or response in CSV format. If the batch is an XML file, the links return the request or response in XML format. ## Specify a Lead Convert Request ID To specify a lead ID for a `LeadConvertRequest` operation, use a DataWeave transform message. When you use a transform message before the operation, you must add the `leadId` field, because the metadata for the operation doesn’t specify it: ```example ``` ## Update Field Values to Null To set field values to `null`, use an **Update** or **Upsert** request operation and insert the names of the fields you want to nullify in the **Transform Message** component’s **fieldsToNull** field: ![Transform Message properties window for setting a field to null](/mulesoft/current/en-us/salesforce-connector/latest/_images/salesforce-connector-10-set-fields-to-null.png) Figure 1. Specify the field names you want to nullify in the **Transform Message** component **fieldsToNull** field. ## Generate a Keystore File Salesforce Connector uses the Bouncy Castle cryptographic library to load the certificate from the keystore and sign the payload for the authentication requests. The library has a [vulnerability (CVE-2018-5382)](https://nvd.nist.gov/vuln/detail/CVE-2018-5382) that relates to the BKS-V1 keystore file type. By default, Salesforce Connector uses JKS or PKCS12 keystores. Avoid using BKS-V1 keystore files, as documented in the [Bouncy Castle proposed solution](https://www.kb.cert.org/vuls/id/306792). To generate a JKS keystore file: 1. Go to your Mule workspace and open the command prompt (for Windows) or Terminal (for Mac). 2. Enter this command: ```none keytool -genkeypair -alias salesforce-cert -keyalg RSA -keystore salesforce-cert.jks ``` 3. Enter the following information: - Password for the keystore - Your first name and last name - Your organization unit - Your city and state, and the two-letter code for your country The system generates a Java keystore file (JKS format) that contains a private or public key pair in your workspace. 4. Provide the file path for the keystore in your connector configuration. Enter this command: ```none keytool -exportcert -alias salesforce-cert -file salesforce-cert.crt -keystore salesforce-cert.jks ``` The system exports the public key from the keystore into the workspace. This is the public key to enter in your Salesforce instance. 5. Verify that you have both the keystore (`salesforce-cert.jks`) and the public key (`salesforce-cert.crt`) files in your workspace. ## Invoke APEX Rest Method The Invoke APEX Rest operation enables users to invoke a method from an Apex class that is exposed as a REST service. The following example shows a payload for this operation: ```example ``` In this example: - The `body` element contains `URLParameters`, which is a map containing the parameters that replace the wildcards in the path of the REST resource described in the Apex class. For example, if the REST resource is set to `@RestResource(urlMapping='/myResource/*/mySubResource/*')`, the value of `Parameter1` replaces the first `*`, and the value of `Parameter2` replaces the second `*`. - Key names must start with `Parameter`, followed by a number that shows the position of the `*` to be replaced. - After the `URLParameters` block, provide the content of the `body` value to send to the REST resource, as shown in the example `account` block. - The `headers` and `cookies` fields describe the headers and cookies to pass along with the HTTP request to the desired service. - The `queryParameters` field describes the query parameters to use, and the keys and values in this map that the specified Apex Class must accept. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 12.0 is-latest-version: true --- # Salesforce Connector 12.0 Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt These examples show several Mule flows for Salesforce Connector: - [Accept and Transform Data](#accandtrans) - [Create or Update an Object in a Parent-Child Relationship](#parentchild) - [Delete Accounts](#delete-accounts) - [Find Duplicate Accounts](#find-duplicate-accounts) ## Accept and Transform Data This example shows how to configure Salesforce Connector to create a new Salesforce account and query new accounts, and to use [File Connector](https://docs.mulesoft.com/file-connector/latest/) to write the new account data to a file. The example contains three flows: - The first flow configures a template for the HTML input form used to provide data for the new account. - The second flow creates a new Salesforce account based on information in the HTML input form. - The third flow queries new accounts by name and writes new account data to a CSV file. ![Accept and transform data flows](/mulesoft/current/en-us/salesforce-connector/latest/_images/accept-and-transform-data-flows.png) ### Configure the First Flow Configure the first flow that configures an HTML template that provides the data used to create a new account. Creating the first flow involves configuring a **Listener** component and a **Parse Template** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/account` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/account`. #### Add the Parse Template Component Add the **Parse Template** component to create a template for an HTML form (`form.html`), which is located in the main resources folder and is used to convey information for creating a new account: 1. From the **Mule Palette** view, select **Core** and drag a **Parse Template** component to the right of **Listener**. 2. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the component, such as Parse Template.

Location

form.html

The following image shows an example of the **Parse Template** configuration in the properties window: ![Parse Template properties window configuration](/mulesoft/current/en-us/salesforce-connector/latest/_images/parse-template-properties-window.png) ### Configure the Second Flow Configure the second flow that creates a new Salesforce account based on the data in the HTTP input form. Creating the second flow involves configuring a **Listener** component, a **Transform Message** component, a **Create** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/createAccount` path: 1. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Accept the defaults. 4. In the properties window, set the **Path** field value to `/createAccount`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Create** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [{ Name: payload.Name, AccountNumber: payload.AccountNumber, BillingCity: payload.BillingCity }] ``` #### Add the Create Operation Add the **Create** operation to create a new Salesforce account using the field values passed by the **Transform Message** component: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Create** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Create** configuration of the global element: ![Create global element configuration window](/mulesoft/current/en-us/salesforce-connector/latest/_images/create-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

You can successfully pass a variable into Type, but there could be an issue when displaying the input metadata if the runtime fails to properly resolve the value of that variable.

Records

payload

The following image shows an example of the **Create** configuration in the properties window: ![Create properties window configuration](/mulesoft/current/en-us/salesforce-connector/latest/_images/create-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the field values to JSON format so the values can be used with [File Connector](https://docs.mulesoft.com/file-connector/latest/): 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Create**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { id:$.id, errors:$.errors, success:$.success } ``` ### Configure the Third Flow Configure the third flow that queries new Salesforce accounts by name and writes the matching accounts data to a Java file. Creating the third flow involves configuring an **On New Object** source, a **Query result list** operation, a **Query result stream by id** operation, a **Transform Message** component, and a **Write** operation. #### Configure the On New Object Source Configure the **On New Object** source to initiate a Mule flow when a new account is created on the `/account` path: 1. From the **Mule Palette** view, select **Salesforce** and drag the **On New Object** source to the canvas. 2. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

The following image shows an example of the **On New Object** configuration in the properties window: ![On New Object properties window configuration](/mulesoft/current/en-us/salesforce-connector/latest/_images/on-new-object-properties-window.png) #### Add the Query Result List Operation Add the **Query result list** operation to return a list of result IDs: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Query result list** operation to the right of **On New Object**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Query result list** configuration of the global element: ![Query result list global element configuration window](/mulesoft/current/en-us/salesforce-connector/latest/_images/query-result-list-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Batch info

payload

The following image shows an example of the **Query result list** configuration in the properties window: ![Query result list properties window configuration](/mulesoft/current/en-us/salesforce-connector/latest/_images/query-result-list-properties-window.png) #### Add the Query Result Stream by Id Operation Add the **Query result stream by id** operation to obtain the final query results: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Query result stream by id** operation to the right of **Query result list**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Query result stream by id** configuration of the global element: ![Query result stream by id global element configuration window](/mulesoft/current/en-us/salesforce-connector/latest/_images/query-result-stream-by-id-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Batch info

payload

The following image shows an example of the **Query result stream by id** configuration in the properties window: ![Query result stream by id properties window configuration](/mulesoft/current/en-us/salesforce-connector/latest/_images/query-result-stream-by-id-properties-window.png) #### Add the Transform Message Component Add the **Transform Message** component to convert the field values to JSON format so the values can be used with [File Connector](https://docs.mulesoft.com/file-connector/latest/): 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Query result stream by id**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { AccountNumber:$.AccountNumber, BillingAddress:$.BillingAddress, Id:$.Id, Name:$.Name } ``` #### Add the Write Operation Add the **Write** operation to write the new account data to a CSV file: 1. From the **Mule Palette** view, select **File** and drag the **Write** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Working Directory

If Connection is selected, the directory to consider the root of every relative path used with this connector. If not provided, it defaults to the value of the user.home system property. If that system property is not set, then the connector fails to initialize.

The following image shows an example of the **Write** configuration of the global element: ![Write global element configuration window](/mulesoft/current/en-us/salesforce-connector/latest/_images/write-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Path

/account

Content

payload

The following image shows an example of the **Write** configuration in the properties window: ![Write properties window configuration](/mulesoft/current/en-us/salesforce-connector/latest/_images/write-properties-window.png) ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Create or Update an Object in a Parent-Child Relationship This example shows how to create the object relationship structure in Salesforce needed to perform an upsert using Salesforce Connector. ![Create or Update an Object in a Parent-Child Relationship flow](/mulesoft/current/en-us/salesforce-connector/latest/_images/create-update-flow.png) ### Configure the Flow A Salesforce object can have standard or custom relationships between objects. The relationships between objects are usually one-to-many (parent-child) relationships, but can be any link between two objects residing in Salesforce. The example uses two custom Salesforce object types that have a parent-child relationship: - `Plane__c`, the parent object that must exist in Salesforce - `Component__c`, the object to upsert using Salesforce Connector The relationship between the two custom objects is represented by a `Plane__r` field whose value is an object with two fields: - The `type` field, which has the referenced object type name as its value. In this example, the value of `type` is `Plane_c`. - A field that identifies the instance of the parent object to reference. In this example, the `Name` field references the `Cobra` instance of `Plane__c`. When you upsert `Component__c`, the POJO sent as input to Salesforce Connector looks like this: ```linenums ---- [{ // Component__c's fields ... Plane__r: { "type": "Plane__c", "Name": "Cobra" } }] ---- ``` Creating the flow involves configuring a **Listener** component, a **Transform Message** component, an **Upsert** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Upsert** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [{ Name: "NewPlaneComponent", Plane__r: { "type": "Plane__c", "Name": "Cobra" } }] ``` #### Add the Upsert Operation Add the **Upsert** operation to create or update a Salesforce object that is in a parent-child relationship: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Upsert** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Upsert** configuration of the global element: ![Upsert global element configuration window](/mulesoft/current/en-us/salesforce-connector/latest/_images/upsert-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Object type

Component_c

External id field name

Id

Records

payload

The following image shows an example of the **Upsert** configuration in the properties window: ![Upsert properties window configuration](/mulesoft/current/en-us/salesforce-connector/latest/_images/upsert-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Upsert**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Delete Accounts This example shows how to use Salesforce Connector to delete Salesforce accounts. ![Delete Accounts flow](/mulesoft/current/en-us/salesforce-connector/latest/_images/delete-accounts-flow.png) ### Configure the Flow Creating the flow involves configuring a **Listener** component, a **Transform Message** component, a **Delete** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Delete** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [payload.Id] ``` #### Add the Delete Operation Add the **Delete** operation to delete Salesforce accounts: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Delete** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Delete** configuration of the global element: ![Delete global element configuration window](/mulesoft/current/en-us/salesforce-connector/latest/_images/delete-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Records to Delete Ids

payload

The following image shows an example of the **Delete** configuration in the properties window: ![Delete properties window configuration](/mulesoft/current/en-us/salesforce-connector/latest/_images/delete-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Delete**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- payload map { id:$.id, errors:$.errors, success:$.success } ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Find Duplicate Accounts This example shows how to use Salesforce Connector to find duplicate Salesforce accounts. ![Find Duplicate Accounts flow](/mulesoft/current/en-us/salesforce-connector/latest/_images/find-duplicates-accounts-flow.png) ### Configure the Flow Creating the flow involves configuring a **Listener** component, a **Transform Message** component, a **Find duplicates** operation, and a second **Transform Message** component. #### Configure the HTTP Listener Configure the **Listener** component to initiate a Mule flow when a call is made to the `/findDuplicates` path: 1. Create a new Mule project in Studio. 2. From the **Mule Palette** view, select **HTTP** and drag the **Listener** component to the canvas. 3. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 4. Accept the defaults. 5. In the properties window, set the **Path** field value to `/findDuplicates`. #### Add the First Transform Message Component Add the first **Transform Message** component to convert the values from the HTTP input form to Java format so they can be used as input to the **Delete** operation: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Listener**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/java --- [ payload ] ``` #### Add the Find Duplicates Operation Add the **Find duplicates** operation to find duplicate Salesforce accounts: 1. From the **Mule Palette** view, select **Salesforce** and drag the **Find duplicates** operation to the right of **Transform Message**. 2. In the properties window, click **+** next to the **Connector configuration** field to add a global element. 3. Configure the global element depending on the connection, for example:
FieldValue

Username

${salesforce.username}

Password

${salesforce.password}

Security

${salesforce.securityToken}

Authorization URL

https://login.salesforce.com/services/Soap/u/53.0

The following image shows an example of the **Find duplicates** configuration of the global element: ![Find Duplicates global element configuration window](/mulesoft/current/en-us/salesforce-connector/latest/_images/find-duplicates-global-config.png) 4. In the properties window, configure the following fields:
FieldValue

Display Name

Name for the connector operation.

Connector configuration

Global configuration you just created.

Type

Account

Criteria

payload

The following image shows an example of the **Find duplicates** configuration in the properties window: ![Find Duplicates properties window configuration](/mulesoft/current/en-us/salesforce-connector/latest/_images/find-duplicates-properties-window.png) #### Add the Second Transform Message Component Add the second **Transform Message** component to convert the values from Java format to JSON format: 1. From the **Mule Palette** view, select **Core** and drag a **Transform Message** component to the right of **Find duplicates**. 2. In the properties window, overlay the brackets in the **Output** section with this DataWeave code: ```dataweave %dw 2.0 output application/json --- { success: payload.success, duplicateResults: { (payload.duplicateResults map { matchRecords: $.matchResults } ) }, duplicateRuleEntityType: payload.duplicateRuleEntityType, duplicateRule: payload.duplicateRule, allowSave: payload.allowSave, errorMessage: payload.errorMessage } ``` ### XML for This Example Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 12.0 is-latest-version: true --- # Salesforce Connector 12.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt > [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality. > We maintained certain terms to avoid any effect on customer implementations. Anypoint Connector for Salesforce (Salesforce Connector) simplifies and accelerates integration across Sales Cloud, Service Cloud, Salesforce Platform, and Force.com. With comprehensive access to Salesforce entities, this connector streamlines automation of business processes—helping you unlock more value from your Salesforce investments, empower your sales teams, increase revenue, and provide better customer service. ## Configuration Default Configuration for Salesforce Connector.
NameTypeDescriptionDefault ValueRequired

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Read Timeout

Number

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

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

SECONDS

Name

String

Identifier of this element used to reference it in other components.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Fetch All Apex SOAP Metadata

Boolean

If true, DataSense is performed for all Apex classes in the organization. If false, DataSense is performed only for classes in Apex Class Names. If the organization contains many Apex classes, this might cause a ConnectionTimeout during DataSense.

false

Fetch All Apex REST Metadata

Boolean

If true, DataSense is performed for all Apex classes in the organization. If false, DataSense is performed only for classes in Apex Class Names. If the organization contains many Apex classes, this might cause a ConnectionTimeout during DataSense.

false

Apex Class Names

Array of String

List of Apex class names involved in metadata retrieval via DataSense.

Include null values

Boolean

Includes null values in the Apex Rest API request. This parameter applies to the Invoke Apex Rest Method operation only.

false

### Basic Authentication Connection Type (Supported by Salesforce API v64.0 and below) Uses a username and a password for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP is allowlisted on Salesforce.

Authorization URL

String

Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, https://login.salesforce.com/services/Soap/u/67.0. Always use lowercase when specifying the protocol (e.g., http, https).

Session Id

String

Value that identifies an active Salesforce session.

Service Endpoint

String

Specifies the service endpoint. This value is used only if the Session Id configuration property is used.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth v2.0 Connection Type Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint. Always use lowercase when specifying the protocol (e.g., http, https).

https://login.salesforce.com/services/oauth2/authorize

Access Token Url

String

URL of the service provider’s access token endpoint. Always use lowercase when specifying the protocol (e.g., http, https).

https://login.salesforce.com/services/oauth2/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after receiving an access token.

Listener Config

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

### OAuth JWT Connection Type Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication. > [!NOTE] Salesforce Connector supports providing a signed certificate only if you use the > `SHA256withRSA` algorithm for the OAuth JWT connection type. > [!NOTE] When configuring a Salesforce external client app for OAuth JWT authentication, disable > **Issue JSON Web Token (JWT)-based access tokens for named users** so that Salesforce returns an > opaque access token instead of a JWT-formatted access token.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Certificate Alias

String

Alias of the certificate.

Principal

String

Username of the desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

Audience Url

String

URL that identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.

Use the authorization server’s URL for the audience value if implementing for a community: https://login.salesforce.com, https://test.salesforce.com, or https://community.force.com/customers.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth Client Credentials Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). Uses a client ID and client secret for authentication.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Client ID

String

The OAuth client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret that corresponds to the client ID.

x

Token URL

String

Service provider’s token endpoint URL. Always use lowercase when specifying the protocol (e.g., http, https).

https://{domain}.my.salesforce.com/services/oauth2/token

Scopes

String

The OAuth scopes to request during the OAuth dance.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

### OAuth SAML Connection Type Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). > [!NOTE] OAuth SAML currently uses only Salesforce as an identity provider. Refer to > [Salesforce as a SAML Identity Provider](https://help.salesforce.com/s/articleView?id=xcloud.sso_sfdc_idp_saml_parent.htm&type=5) > to enable Salesforce as an identity provider. Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token.
NameTypeDescriptionDefault ValueRequired

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to 0. A value of 0 means wait indefinitely.

0

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout parameter.

SECONDS

Login Request Timeout

Number

How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to 0. A default value of 0 means an indefinite wait, so set a non-zero value to avoid prolonged waits based on your requirements.

Login Request Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Login Request Timeout field.

Proxy configuration

Configures a proxy for outbound connections.

Object TTL

Number

How long an object in the connection pool lives if the object is not used.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Object TTL field.

SECONDS

Max Entries

Number

Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released.

10

Api Version

Number

API version used. Defaults to the latest API version supported by the connector.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Certificate Alias

String

Alias of the certificate.

Principal

String

Username of the desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server that provides the authentication token.

https://login.salesforce.com/services/oauth2/token

TLS configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

## Sources - [On Deleted Object](#deleted-object-listener) - [On Modified Object](#modified-object-listener) - [On New Object](#new-object-listener) - [Replay Channel Listener](#replay-channel-listener) - [Replay Topic Listener](#replay-topic-listener) > [!NOTE] The **On Deleted Object**, **On Modified Object**, and **On New Object** sources in > Salesforce Connector use Object Store to save watermarks. You might experience limitations that > are specific to the Object Store implementation you are using (Object Store for CloudHub > deployments or Object Store for on-premises deployments), so configure Object Store to suit your > needs. > For more information, see > [The Different Types of Object Stores Explained](https://help.salesforce.com/s/articleView?id=001123185&type=1). ### On Deleted Object `` Source that adds one or more `whereConditions` in the query calling the method.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Query Time Buffer (Seconds)

Number

Number of seconds to subtract from the current time when querying for changes. This prevents data loss caused by records committed after the query timestamp but before the next poll. The value must be between 0 and 120 seconds.

0

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### On Modified Object `` Source for modified objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Query Time Buffer (Seconds)

Number

Number of seconds to subtract from the current time when querying for changes. This prevents data loss caused by records committed after the query timestamp but before the next poll. The value must be between 0 and 120 seconds.

0

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### On New Object `` Source for new objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type.

x

Triggers Query

String

Query used to filter the trigger results, for example, Name='Filter'.

Since

String

Specify a 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.

Query Time Buffer (Seconds)

Number

Number of seconds to subtract from the current time when querying for changes. This prevents data loss caused by records committed after the query timestamp but before the next poll. The value must be between 0 and 120 seconds.

0

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### Replay Channel Listener `` Source that subscribes to a streaming channel. First, the streaming channel must be published, and after that, a subscription to that streaming channel must be created. Salesforce allows you to subscribe to a nonexistent streaming channel but won’t send you notifications after the topic is created.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Streaming Channel

String

Name of the streaming channel to subscribe to.

x

Cache Events In Memory

Boolean

When the processing flow is slow, cache events in memory to reduce quota consumption.

false

Replay Option

Enumeration, one of:

  • ONLY_NEW

  • ALL

  • FROM_REPLAY_ID

  • FROM_LAST_REPLAY_ID

  • ONLY_NEW: -1

    Subscriber receives new events that are broadcast after the client subscribes.

  • ALL: -2

    Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription.

  • FROM_REPLAY_ID

    Subscriber receives only events that have a replay ID value greater than the specified replay ID.

  • FROM_LAST_REPLAY_ID

    Subscriber uses the highest replay ID stored in the object store regardless of whether it is processed successfully or not.

x

Replay Id

String

Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to ALL or ONLY_NEW.

Replay Failed Events If Any or Resume from Last Replay Id

Boolean

If true, the source starts consuming data with any failed events (if any) or starts consuming data from the last replay ID that is processed successfully.

false

The size (in bytes) of the event queue (DEPRECATED)

Number

In previous versions, this field was used to specify the size of the event queue which can lead to memory issues. Now, the messages are streamed and no buffering is needed.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

true

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Throw Exception When Organization Daily Limit Exceeded

Boolean

Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded.

false

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Attributes

Object

Attributes.

#[message.attributes]

#### Output

Type

Any

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ### Replay Topic Listener `` Salesforce stores events for 24 hours and enables you to retrieve stored and new events. Source in which subscribers choose which events to receive by using replay options.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Topic

String

Name of the topic to subscribe to.

x

Cache Events In Memory

Boolean

When the processing flow is slow, cache events in memory to reduce quota consumption.

false

Replay Option

Enumeration, one of:

  • ONLY_NEW

  • ALL

  • FROM_REPLAY_ID

  • FROM_LAST_REPLAY_ID

  • ONLY_NEW: -1

    Subscriber receives new events that are broadcast after the client subscribes.

  • ALL: -2

    Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription.

  • FROM_REPLAY_ID

    Subscriber receives only events that have a replay ID value greater than the specified replay ID.

  • FROM_LAST_REPLAY_ID

    Subscriber uses the highest replay ID stored in the object store regardless of whether it is processed successfully or not.

x

Replay Id

String

Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to ALL or ONLY_NEW.

Replay Failed Events If Any or Resume from Last Replay Id

Boolean

If true, the source starts consuming data with any failed events (if any) or starts consuming data from the last replay ID that is processed successfully.

false

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. This parameter doesn’t have any impact on non-cluster mode with multiple workers.

true

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Throw Exception When Organization Daily Limit Exceeded

Boolean

Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded.

false

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Attributes

Object

Attributes.

#[message.attributes]

#### Output

Type

Any

Attributes Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) ## Operations > [!NOTE] If you set `LocalDate` for a field in the payload, the input time is automatically > converted to `GMT` or the server’s time zone based on the Gregorian calendar. This conversion > impacts date calculations or comparisons in Salesforce Connector operations, as `LocalDate` is > adjusted to align with the server’s time zone or defaults to GMT. - [Abort Job](#abortJob) - [Abort Job Bulk Api V2](#abortJobBulkApiV2) - [Abort Query Job Bulk Api V2](#abortQueryJobBulkApiV2) - [Batch Info](#batchInfo) - [Batch Info List](#batchInfoList) - [Batch Result](#batchResult) - [Batch Result Stream](#batchResultStream) - [Change Own Password](#changeOwnPassword) - [Close Job](#closeJob) - [Convert Lead](#convertLead) - [Create](#create) - [Create Batch](#createBatch) - [Create Batch For Query](#createBatchForQuery) - [Create Batch Stream](#createBatchStream) - [Create Job](#createJob) - [Create Job Bulk Api V2](#createJobBulkApiV2) - [Create Metadata](#createMetadata) - [Create Query Job Bulk Api V2](#createQueryJobBulkApiV2) - [Delete](#delete) - [Delete Job Bulk Api V2](#deleteJobBulkApiV2) - [Delete Metadata](#deleteMetadata) - [Delete Query Job Bulk Api V2](#deleteQueryJobBulkApiV2) - [Deploy Metadata](#deployMetadata) - [Describe Global](#describeGlobal) - [Describe Metadata](#describeMetadata) - [Describe Sobject](#describeSobject) - [Find Duplicates](#findDuplicates) - [Find Duplicates By Ids](#findDuplicatesByIds) - [Get All Jobs Bulk Api V2](#getAllJobsBulkApiV2) - [Get All Query Jobs Bulk Api V2](#getAllQueryJobsBulkApiV2) - [Get Deleted](#getDeleted) - [Get Job State Bulk Api V2](#getJobStateBulkApiV2) - [Get Query Job Info Bulk Api V2](#getQueryJobInfoBulkApiV2) - [Get Query Job Results Bulk Api V2](#getQueryJobResultsBulkApiV2) - [Get Server Timestamp](#getServerTimestamp) - [Get updated objects](#getUpdated) - [Get User Info](#getUserInfo) - [Invoke Apex Rest Method](#invokeApexRestMethod) - [Invoke Apex Soap Method](#invokeApexSoapMethod) - [Job Info](#jobInfo) - [List Metadata](#listMetadata) - [Merge](#merge) - [Merge Multiple](#mergemultiple) - [Publish Platform Event Message](#publishPlatformEventMessage) - [Publish Streaming Channel](#publishStreamingChannel) - [Publish Topic](#publishTopic) - [Push Generic Event](#pushGenericEvent) - [Query (Deprecated)](#query) - [Query All](#queryAll) - [Query Result List](#queryResultList) - [Query Result Stream By Id](#queryResultStreamById) - [Query Xml Stream](#queryXmlStream) - [Read Metadata](#readMetadata) - [Rename Metadata](#renameMetadata) - [Reset Password](#resetPassword) - [Retrieve](#retrieve) - [Retrieve Job Failed Results Bulk V2](#retrieveJobFailedResultsBulkV2) - [Retrieve Job Successful Results Bulk V2](#retrieveJobSuccessfulResultsBulkV2) - [Retrieve Job Unprocessed Results Bulk V2](#retrieveJobUnprocessedResultsBulkV2) - [Retrieve Metadata](#retrieveMetadata) - [Search](#search) - [Set Password](#setPassword) - [Unauthorize](#unauthorize) - [Update](#update) - [Update Metadata](#updateMetadata) - [Upsert](#upsert) - [Upsert Metadata](#upsertMetadata) ### Abort Job `` Aborts an open job given its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID that identifies the job to abort.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Abort Job Bulk Api V2 `` Aborts an ongoing Bulk API v2 Job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Abort Query Job Bulk Api V2 `` Abort the indicated query job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job to abort.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job Info

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Info `` Accesses the latest BatchInfo of a submitted BatchInfo. Enables you to track the execution status.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo that is monitored.

#[payload]

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Info List `` Gets information about all batches in a job.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job Id

String

ID of the job to retrieve batch information for.

x

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Result `` Accesses `com.sforce.async.BatchResult` of a submitted BatchInfo.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch To Retrieve

com.sforce.async.BatchInfo that is monitored.

#[payload]

Content type

Enumeration, one of:

  • XML

  • JSON

  • ZIP_XML

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Batch Result Stream `` Accesses `com.sforce.async.BatchResult` of a submitted BatchInfo.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch To Retrieve

com.sforce.async.BatchInfo that is monitored.

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Change Own Password `` Changes the password of the user linked to the connector’s configuration.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Old Password

String

Old password to change.

x

New Password

String

New password to change.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Close Job `` Closes an open job given its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID identifying the job to close.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Convert Lead `` Converts a lead into an account, contact, or (optionally) an opportunity.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Lead Convert Request

Information for lead conversion.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Lead Convert Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Create `` Adds one or more new records to your organization’s data. > [!IMPORTANT] When you map your objects to the input of this message processor, the objects must > match the expected type of the object at Salesforce. For example, if you set the **CloseDate** > field of an opportunity to a string of value `2011-12-13`, it is sent to Salesforce as a string. > The operation is rejected because the CloseDate is not of the expected type. The correct way to > map it is to generate a Java Date object. You can do so using the Groovy expression evaluator as > `#[groovy:Date.parse("yyyy-MM-dd", "2011-12-13")]`.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to add.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Create Batch `` Creates a batch using the given objects within the specified Job. The job can be of XML or CSV type. This call uses the Bulk API. This operation is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

com.sforce.async.JobInfo in which the batch is created. The job can be of XML, JSON, or CSV type.

x

SObjects

Array of Object

List of one or more SObject objects.

#[payload]

SObject Max Depth

Number

Asynchronous SObject recursive MAX_DEPTH check.

5

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Batch For Query `` Creates a batch using the given query. This call uses the Bulk API. This operation is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

JobInfo in which the batch is created.

x

Query

String

Query to execute.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Batch Stream `` Creates a batch using the given stream within the specified job. The stream can have a CSV, XML, ZIP\_CSV, or ZIP\_XML format. This call uses the Bulk API and is performed asynchronously.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job info

JobInfo in which the batch is created.

#[payload]

x

Stream

Any

Stream containing the data. The stream can have a CSV, XML, ZIP_CSV, or ZIP_XML format.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Batch Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Job `` Creates a job to perform one or more batches through Bulk API operations.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

  • queryAll

OperationEnum that is executed by the job.

x

Type

String

Type of Salesforce object that the job processes.

x

Create Job Request

Creates the job request.

If you input the value in literal mode, an example value is:

{
    “externalIdFieldName”: “employeeId”,
    “contentType”: “XML”,
    “concurrencyMode”: “Serial”
}

If you input the value in expression mode, then the input can be dynamic using output application/json or output application/java, and can be transformed into the required input.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Job Bulk Api V2 `` Creates a Bulk API v2 job containing the data to insert, update, delete, or upsert. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Type of object to work with.

x

sObjects

Binary

Array of one or more SObject objects.

#[payload]

Operation

Enumeration, one of:

  • insert

  • update

  • delete

  • hardDelete

  • upsert

Operation to execute.

x

Line Ending

String

Line ending of CSV data.

LF

Column Delimiter

String

Column delimiter of CSV data.

COMMA

Assignment Rule Id

String

ID of an assignment rule to run for a case or a lead. The assignment rule can be active or inactive.

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the ID lookup field property for standard objects.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Salesforce headers. For information, see Create a Job in the Salesforce documentation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Create Metadata `` Adds one or more new metadata components to your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type to create.

x

Metadata Objects

Array of Object

List of Map<String,Object> representing the metadata to create.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Create Query Job Bulk Api V2 `` Creates a query job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Query

String

Query used to create the job.

x

Operation

Enumeration, one of:

  • QUERY

  • QUERY_ALL

Operation used.

QUERY

Column Delimiter

String

Type of delimiter used.

COMMA

Line Ending

String

Line ending used.

CRLF

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Salesforce headers. For information, see Create a Query Job in the Salesforce documentation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job State

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Delete `` Deletes one or more records from your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Records To Delete Ids

Array of String

Array of one or more IDs associated with the objects to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Delete Job Bulk Api V2 `` Deletes a Bulk API v2 Job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Delete Metadata `` Deletes one or more metadata components from your organization, given the API name of the objects.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to delete.

x

Full Names

Array of String

Full names of the components to delete.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Delete Query Job Bulk Api V2 `` Deletes a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Deploy Metadata `` A file-based call to deploy XML components. Use this operation to take file representations of components and deploy them into an organization by creating, updating, or deleting the components they represent.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Deploy Metadata Request

Data needed by this operation.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Global `` Retrieves a list of available objects for your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe Global Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Metadata `` Retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other components.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Describe Sobject `` Describes metadata (field list and object properties) for the specified object.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Object. The specified value must be a valid object for your organization. For a complete list of objects, see Standard Objects.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Describe S Object Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Find Duplicates `` Performs rule-based searches for duplicate records. The input is an array of Salesforce objects, each of which specifies the values to search for and the type of object that supplies the duplicate rules. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the values to do the search. The output identifies the detected duplicates for each SObject.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of SObjects to find duplicates for.

x

Criteria

Array of Object

List of SObjects used as a criterion when searching for duplicates.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Find Duplicates Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Find Duplicates By Ids `` Performs rule-based searches for duplicate records. The input is an array of IDs, each of which specifies the records for which to search for duplicates. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the record IDs to do the search. The output identifies the detected duplicates for each ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Ids List

Array of String

List of IDs to find duplicates.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Find Duplicates Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get All Jobs Bulk Api V2 `` Retrieves all Bulk jobs. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Desired concurrency mode.

Parallel

Pk Chunking

Boolean

Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Bulk Job V2 Result

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get All Query Jobs Bulk Api V2 `` Retrieves all Bulk query jobs.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Pk Chunking

Boolean

Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Job Type

Enumeration, one of:

  • BigObjectIngest

  • Classic

  • V2Query

Job type.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Desired concurrency mode.

Parallel

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Query Jobs Info Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Deleted `` Retrieves the list of records deleted from a particular time in the past (specified in minutes).
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type. The specified value must be a valid object for your organization.

x

Start Date

DateTime

Starting date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

x

End Date

DateTime

Ending date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC).

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get Deleted Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get Job State Bulk Api V2 `` Gets the state of a v2 Bulk job. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Job State

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Query Job Info Bulk Api V2 `` Returns the details of a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Query Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Query Job Results Bulk Api V2 `` Returns the results of a query job based on its ID.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Id

String

ID of the query job.

x

Max Records Per Page

Number

Number of records that are on each page retrieved from the API. This number influences the number of API requests and the memory used by the connector to handle the results.

Salesforce Connector automatically handles pagination and retrieves all pages before the next processing job starts.

2000

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Get Server Timestamp `` Retrieves the current system timestamp, in Coordinated Universal Time (UTC), from the API.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

DateTime

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get updated objects `` Retrieves the list of individual records that are created or updated between the specified start and end date.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Object type. The specified value must be a valid object for your organization.

x

Start Date

DateTime

Starting date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

x

End Date

DateTime

Ending date or time, in Coordinated Universal Time (UTC), of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified DateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If a value is not provided, the current server time is used.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get Updated Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Get User Info `` Retrieves personal information for the user associated with the current session.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Get User Info Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Invoke Apex Rest Method `` Invokes any operation from an Apex class that is exposed as a REST web service.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Request

Object

Object containing request information, some of which can include object queryParams with key-value pairs. These parameters are passed as URL parameters to the Apex Rest endpoint, for example:

queryParams: {AccountId : "a0w0E0000069MDxQAM" , ContactId: "0030E00000rRSJ6QAO" }

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Apex Class Name

String

Apex class name.

x

Apex Class Method Name

String

Apex class method name. The method name format is:

ApexMethodName^RestResourceURL^HttpMethod^OutputType^InputParameterName1=ParameterType1,InputParameterName2=ParameterType2

For example:

getAccountInfo^/accountInfo/*^HttpGet^void

Special characters aren’t allowed in ApexMethodName.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Invoke Apex Soap Method `` Invokes any operation from an Apex class that is exposed as a SOAP web service.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Input

Binary

InputStream with XML that contains information about the method to invoke and its parameters. The XML must adhere to the WSDL standards.

#[payload]

Apex Headers

Object

Parameters specifying the SOAP Headers to send to the API. For more information about the supported headers, see SOAP API and SOAP Headers for Apex.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Apex Class Name

String

Apex class name.

x

Apex Class Method Name

String

Apex class method name.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Any

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Job Info `` Accesses the latest JobInfo of a submitted JobInfo ID. This operation enables you to track the execution status.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID of the job that is monitored.

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation.

XML

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Job Info

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### List Metadata `` Retrieves property information about metadata components in your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type used as a criterion when querying for information.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of File Properties

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Merge `` Merges up to three records into one record.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Records To Merge Ids

Array of String

List of IDs of the objects to merge.

#[payload]

Type

String

Type of record to merge.

x

Master Record

Object

Must provide the ID of the object that other records are merged into. Optionally, provide the fields to update and their values.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Merge Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Merge Multiple `` Combines up to three records of the same type into one record. The input is an array of MergeRequest elements, each of which specifies the records to combine. #### Limitations - The only supported object types are: - Lead - Contact - Account - Person Account - Individual Only objects of the same type can be merged. For example, merge leads only with leads. - The **Merge Multiple** operation enables you to specify a list of a maximum of 200 merge requests. - A merge request can contain a maximum of three IDs: - The master record ID - Up to two IDs for the records to merge into the primary record
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

List of Merge Records

Array of Merge Record

List of merge records. Each merge record contains the primary record, the record to merge IDs into, and an optional additional information map.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Map<String, Object>

Declares the request headers to use with this operation.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Merge Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Platform Event Message `` Adds one new platform event to your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Platform Event name

String

Name of the platform event to create.

x

Platform Event Message

Array of Object

List<PlatformEventMessage> to create.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Streaming Channel `` Creates a streaming channel in which generic, custom messages are pushed.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Channel name

String

Descriptive name of the streaming channel. Limit of 80 characters, and must start with /u/. This value identifies the channel and must be unique.

x

Owner Id

String

Identifier for the channel owner.

Description

String

Description of what kinds of records are returned by the query. Limit of 255 characters.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Publish Topic `` Creates a topic representing a query that is used to notify listeners when changes are made to records in an organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Topic Name

String

Topic name.

x

Query

String

Query name.

x

Description

String

Description.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Push Generic Event `` Pushes generic streaming custom events to the specified streaming channel.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Events

Event list.

#[payload]

Channel Id

String

Streaming channel name.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Push Event Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query (Deprecated) `` Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are strings and, if necessary, you can convert them to the appropriate type, for example, by using DataWeave and **Transform Message**. The **Query** operation is now deprecated. Use the [**Query Xml Stream**](#queryXmlStream) operation instead.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query All `` Retrieves data from specified objects, whether or not they have been deleted.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Query Result List `` Returns a list of result IDs for a specific batch. If the batch requires retries, there is more than one element in the output. Use this operation with [Query Result Stream By Id](#queryResultStreamById) to obtain the results of the query.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo to retrieve the results for.

#[payload]

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation.

XML

Output Mime Type

String

MIME type of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of a variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of String

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Query Result Stream By Id `` Returns an InputStream with the query results for a specific result ID of a submitted BatchInfo. Obtain the result IDs first by using the [Query Result List](#queryResultList) operation.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Batch info

BatchInfo that returns the result ID.

#[payload]

x

Result ID

String

Result ID obtained with Query Result List.

x

Output Mime Type

String

MIME type of the payload output of this operation.

Output Encoding

String

Encoding of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configure how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of a variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Binary

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Query Xml Stream `` Executes a query against the specified object and returns data that matches the specified criteria. This operation returns paginated results. Each result is an InputStream of XML records.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders in Salesforce Query.

Escape characters for parameters value

Boolean

Escapes special characters for the Parameters value.

false

Output Mime Type

String

MIME type of the payload output of this operation.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Headers

Object

Headers to include in the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of String payload and Void attributes

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED - SALESFORCE:RETRY\_EXHAUSTED ### Read Metadata `` Returns one or more metadata components from your organization, given the objects' API names.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to read.

x

Full Names

Array of String

List of full names of the components to read.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Rename Metadata `` Renames a metadata component in your organization, given its old API name and the new name.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the component to rename.

x

Old Full Name

String

Current component full name.

x

New Full Name

String

New component full name.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Reset Password `` Resets the password of the user corresponding to the provided user ID, or the user linked to the connector’s configuration, if the user ID field is null.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User to reset the password for. If unspecified, the current user is used.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Reset Password Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Retrieve `` Retrieves one or more records based on the specified IDs.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to retrieve.

x

Retrieve Request

Must provide the IDs and specify the fields for the records to retrieve.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Retrieve Job Failed Results Bulk V2 `` Gets the status of the failed processed SObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Job Failed Record Results

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Job Successful Results Bulk V2 `` Gets the status of the successfully processed SObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Job Successful Record Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Job Unprocessed Results Bulk V2 `` Gets the status of the unprocessed sObjects. This call uses the Bulk API v2.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

ID of the job.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Attributes Type

Object

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT ### Retrieve Metadata `` Retrieves XML file representations of components in an organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Package Names

Array of String

List of package names to retrieve. If you are retrieving only unpackaged components, do not specify a name. You can retrieve packaged and unpackaged components in the same retrieval operation.

Specific Files

Array of String

List of file names to retrieve. If a value is specified for this property, Package Names must be set to null.

Unpackaged

Binary

Stream containing a list of components to retrieve that are not in a package.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Binary

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Search `` Searches for objects using Salesforce Object Search Language (SOSL). Mimics using the search box inside the Salesforce UI.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Search String

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Search Language (SOSL).

x

Parameters

Object

Map with values for placeholders in Search String.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Search Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Set Password `` Changes the password of a user or a self service user to a value that you specify.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User to set the password for.

x

New Password

String

New password for the user.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Unauthorize `` Deletes all of the access token information of a given resource owner ID so that it is impossible to execute an operation for that user without performing the OAuth dance.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner for whom to invalidate access.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

#### Associated Configurations - [Configuration](#sfdc-config) ### Update `` Updates one or more existing records in your organization’s data.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Type of record to update.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Update Metadata `` Updates one or more metadata components in your organization.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to update.

x

Metadata Objects

Array of Object

List of Map<String, Object> representing the metadata to update.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ### Upsert `` Upserts a homogeneous list of objects. Creates new records and updates existing records using a custom field to determine the presence of existing records. In most cases, use `#upsert(String, String, List, Map)` over `#create(String, List, Map)` to avoid creating unwanted, duplicate records. > [!NOTE] Although you cannot change the **Content Type** value for a bulk upsert, you can use the > [**Create Job**](#createJob) operation to set the content type to CSV (or zipped CSV if you reach > the character limit) and then follow up with the [**Create Batch**](#createBatch) operation.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Object Type

String

Type of record to upsert.

x

External Id Field Name

String

Either of the following:

  • For a custom object, the name of the field that contains the external ID field name

  • For a standard object, the name of the field that contains the ID lookup field name

Unless you configure the External Id Field Name field for the SObject to upsert, the Upsert operation fails.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Bulk Operation Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:LIMIT\_EXCEEDED - SALESFORCE:CONNECTIVITY - SALESFORCE:INVALID\_RESPONSE - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:TIMEOUT - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INSUFFICIENT\_PERMISSIONS - SALESFORCE:COMMUNICATION - SALESFORCE:UNAVAILABLE - SALESFORCE:NOT\_FOUND - SALESFORCE:INVALID\_INPUT - SALESFORCE:OPERATION\_NOT\_SUPPORTED ### Upsert Metadata `` Creates or updates one or more metadata components in your organization. For a picklist field in an object, the **Upsert Metadata** operation updates only the picklist mapping for that specific object. To update the actual picklist values, such as adding or removing values in the picklist, use the [**Deploy Metadata**](#deployMetadata) operation. You must perform a metadata deploy for **Custom Field** or **Global Picklist** based on whether the picklist is tied to a custom field or is a global picklist.
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Type

String

Metadata type of the components to create or update.

x

Metadata Objects

Array of Object

List of Map<String, Object> representing the metadata to upsert.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Headers

Object

Map of HTTP headers allowed by Salesforce SOAP API to pass with the request.

Read Timeout

Number

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

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

Array of Upsert Metadata Result

#### Associated Configurations - [Configuration](#sfdc-config) #### Throws - SALESFORCE:CONNECTIVITY - SALESFORCE:RETRY\_EXHAUSTED - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED - SALESFORCE:INVALID\_INPUT ## Object Types - [Action Override](#ActionOverride) - [Additional Information Map](#AdditionalInformationMap) - [Batch Info](#BatchInfo) - [Bulk Item](#BulkItem) - [Bulk Job State](#BulkJobState) - [Bulk Job V2 Result](#BulkJobV2Result) - [Bulk Operation Result](#BulkOperationResult) - [Child Relationship](#ChildRelationship) - [Create Job Request](#CreateJobRequest) - [CRL File](#crl-file) - [Cron](#cron) - [Custom OCSP Responder](#custom-ocsp-responder) - [Deleted Record](#DeletedRecord) - [Deploy Metadata Request](#DeployMetadataRequest) - [Describe Global Result](#DescribeGlobalResult) - [Describe Global S Object Result](#DescribeGlobalSObjectResult) - [Describe Metadata Object](#DescribeMetadataObject) - [Describe Metadata Result](#DescribeMetadataResult) - [Describe S Object Result](#DescribeSObjectResult) - [Duplicate Result](#DuplicateResult) - [Entity Search Metadata](#EntitySearchMetadata) - [Error](#Error) - [Error Mapping](#ErrorMapping) - [Expiration Policy](#ExpirationPolicy) - [Field](#Field) - [Field Diff](#FieldDiff) - [Field Level Search Metadata](#FieldLevelSearchMetadata) - [File Properties](#FileProperties) - [Filtered Lookup Info](#FilteredLookupInfo) - [Find Duplicates Result](#FindDuplicatesResult) - [Fixed Frequency](#fixed-frequency) - [Generic Streaming Event](#GenericStreamingEvent) - [Get Deleted Result](#GetDeletedResult) - [Get Updated Result](#GetUpdatedResult) - [Get User Info Result](#GetUserInfoResult) - [Job Failed Record Results](#JobFailedRecordResults) - [Job Info](#JobInfo) - [Job Successful Record Result](#JobSuccessfulRecordResult) - [Job Unprocessed Record Result](#JobUnprocessedRecordResult) - [Keystore](#KeyStore) - [Labels Search Metadata](#LabelsSearchMetadata) - [Lead Convert Result](#LeadConvertResult) - [Lead Convert Request](#LeadConvertRequest) - [Match Record](#MatchRecord) - [Match Result](#MatchResult) - [Merge Record](#MergeRecord) - [Merge Result](#MergeResult) - [Metadata Result](#MetadataResult) - [Name Value Pair](#NameValuePair) - [Named Layout Info](#NamedLayoutInfo) - [Non-Repeatable Stream](#non-repeatable-stream) - [Pick List Entry](#PickListEntry) - [Proxy](#ProxyConfiguration) - [Push Event Result](#PushEventResult) - [Query Job Info](#QueryJobInfo) - [Query Job State](#QueryJobState) - [Query Jobs Info Result](#QueryJobsInfoResult) - [Reconnect](#reconnect) - [Reconnect Forever](#reconnect-forever) - [Reconnection](#reconnection) - [Record Type Info](#RecordTypeInfo) - [Redelivery Policy](#RedeliveryPolicy) - [Redelivery Policy Message Identifier](#RedeliveryPolicyMessageIdentifier) - [Repeatable File Store Iterable](#repeatable-file-store-iterable) - [Repeatable File Store Stream](#repeatable-file-store-stream) - [Repeatable In Memory Iterable](#repeatable-in-memory-iterable) - [Repeatable In Memory Stream](#repeatable-in-memory-stream) - [Reset Password Result](#ResetPasswordResult) - [Result](#Result) - [Retrieve Request](#RetrieveRequest) - [Search Record](#SearchRecord) - [Search Record Metadata](#SearchRecordMetadata) - [Search Result](#SearchResult) - [Search Results Metadata](#SearchResultsMetadata) - [Search Snippet](#SearchSnippet) - [Simple Error](#SimpleError) - [Standard Revocation Check](#standard-revocation-check) - [TLS](#Tls) - [Truststore](#TrustStore) - [Upsert Metadata Result](#UpsertMetadataResult) ### Action Override Action override.
FieldTypeDescriptionDefault ValueRequired

Available In Touch

Boolean

Indicates whether available in touch or not.

From Factor

String

From factor.

Name

String

Name.

Page Id

String

Page ID.

Url

String

URL.

### Additional Information Map Additional information map.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name of the map.

Value

String

Value of the map.

### Batch Info Batch information.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Created Date

DateTime

Date created.

Id

String

ID name.

Job Id

String

Job ID.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

State

Enumeration, one of:

  • Queued

  • InProgress

  • Completed

  • Failed

  • NotProcessed

State.

State Message

String

State message.

System Modstamp

DateTime

System modstamp.

Total Processing Time

Number

Total processing time.

### Bulk Item Bulk item.
FieldTypeDescriptionDefault ValueRequired

Exception

Any

Exception.

Id

Any

ID.

Message

String

Message.

Payload

Payload.

Status Code

String

Status code.

Successful

Boolean

Determines if successful or not.

### Bulk Job State Bulk job state.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Api Version

Number

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Error Message

String

Error message.

External Id Field Name

String

External ID field name.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

Object

String

Object.

Operation

String

Operation name.

Retries

Number

Number of retries.

State

String

State.

System Modstamp

String

System modstamp.

Total Processing Time

Number

Total processing time.

### Bulk Job V2 Result Bulk job v2 result.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Content Url

String

Content URL.

Created By Id

String

Created by ID.

Created Date

String

Date created.

External Id Field Name

String

External ID field name.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Bulk Operation Result Bulk operation result.
FieldTypeDescriptionDefault ValueRequired

Id

Any

ID.

Items

Array of Bulk Item

Array of the Bulk Item type.

Successful

Boolean

Determines if successful or not.

### Child Relationship Child relationship.
FieldTypeDescriptionDefault ValueRequired

Cascade Delete

Boolean

Cascade delete.

Child S Object

String

Child SObject.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Field

String

Field.

Junction Id List Names

Array of String

Junction ID list names.

Junction Reference To

Array of String

Junction reference to.

Relationship Name

String

Relationship name.

### Create Job Request Create job request.
FieldTypeDescriptionDefault ValueRequired

External Id Field Name

String

Name of the field on this object. Use this attribute for custom objects or the ID lookup field property for standard objects (only required for upsert operations).

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type for the job results.

When specifying a content type different from XML for a query type, use the queryResultStream(BatchInfo) method to retrieve results.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Concurrency mode of the job.

### CRL File Specifies the location of the certification revocation list (CRL) file.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the CRL file.

### Cron CRON.
FieldTypeDescriptionDefault ValueRequired

Expression

String

Cron expression.

x

Time zone

String

ID of the time zone on which to base the expression. Refer to the java.util.TimeZone Javadoc for the format and valid values for this ID.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.
FieldTypeDescriptionDefault ValueRequired

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

### Deleted Record Deleted record.
FieldTypeDescriptionDefault ValueRequired

Deleted Date

DateTime

Deleted date.

Id

String

ID name.

### Deploy Metadata Request Deploy metadata request.
FieldTypeDescriptionDefault ValueRequired

Stream

Binary

Stream containing the data. This parameter defaults to the payload content.

x

Ignore Warnings

Boolean

If true, a warning allows a deployment to complete successfully.

false

Purge On Delete

Boolean

If true, the deleted components in the destructiveChanges.xml manifest file are not stored in the Recycle Bin. This option only works in the Developer Edition or in sandbox organizations; it does not work in production organizations.

false

Rollback On Error

Boolean

If true, failures cause a complete rollback.

true

### Describe Global Result Describe global result.
FieldTypeDescriptionDefault ValueRequired

Encoding

String

Encoding.

Max Batch Size

Number

Maximum batch size.

Sobjects

SObject results.

### Describe Global S Object Result Describe global SObject results.
FieldTypeDescriptionDefault ValueRequired

Activateable

Boolean

Indicates whether activateable or not.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Custom Setting

Boolean

Indicates whether there is a custom setting or not.

Deletable

Boolean

Indicates whether deletable or not.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Feed Enabled

Boolean

Indicates whether the feed is enabled.

Key Prefix

String

Key prefix.

Label

String

Label.

Label Plural

String

Label plural.

Layoutable

Boolean

Indicates whether layoutable or not.

Mergeable

Boolean

Indicates whether mergeable or not.

Mru Enabled

Boolean

Indicates whether MRU is enabled or not.

Name

String

Name.

Queryable

Boolean

Indicates whether queryable or not.

Replicateable

Boolean

Indicates whether replicateable or not.

Retrieveable

Boolean

Indicates whether retrieveable or not.

Searchable

Boolean

Indicates whether searchable or not.

Triggerable

Boolean

Indicates whether triggerable or not.

Undeleteable

Boolean

Indicates whether undeleteable or not.

Updateable

Boolean

Indicates whether updateable or not.

### Describe Metadata Object Describe metadata object.
FieldTypeDescriptionDefault ValueRequired

Child Xml Names

Array of String

Child XML names.

Directory Name

String

Directory name.

In Folder

Boolean

Indicates whether the metadata object is in the folder.

Meta File

Boolean

Indicates whether the metadata object is a meta file.

Suffix

String

Suffix.

Xml Name

String

XML name.

### Describe Metadata Result Describe metadata result.
FieldTypeDescriptionDefault ValueRequired

Metadata Objects

Metadata objects.

Organization Namespace

String

Organization namespace.

Partial Save Allowed

Boolean

Indicates whether partial save is allowed.

Test Required

Boolean

Indicates whether a test is required.

### Describe S Object Result Describe SObject result.
FieldTypeDescriptionDefault ValueRequired

Action Overrides

Action overrides.

Activateble

Boolean

Indicates whether activateable or not.

Child Relationships

Child relationships.

Compact Layoutable

Boolean

Compact layoutable.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Custom Setting

Boolean

Indicates whether there is a custom setting or not.

Deletable

Boolean

Indicates whether deletable or not.

Deprecated And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Feed Enabled

Boolean

Indicates whether the feed is enabled.

Fields

Array of Field

Fields.

Key Prefix

String

Key prefix.

Label

String

Label.

Label Plural

String

Label plural.

Layoutable

Boolean

Indicates whether layoutable or not.

Mergeable

Boolean

Indicates whether mergeable or not.

Mru Enabled

Boolean

Indicates whether MRU is enabled or not.

Name

String

Name.

Named Layout Infos

Named layout information.

Network Scope Field Name

String

Network scope field name.

Queryable

Boolean

Indicates whether queryable or not.

Record Type Infos

Record type information.

Replicateable

Boolean

Indicates whether replicateable or not.

Retrieveable

Boolean

Indicates whether retrieveable or not.

Search Layoutable

Boolean

Indicates whether the search is layoutable or not.

Searchable

Boolean

Indicates whether searchable or not.

Triggerable

Boolean

Indicates whether triggerable or not.

Undeleteable

Boolean

Indicates whether undeleteable or not.

Updateable

Boolean

Indicates whether updateable or not.

Url Detail

String

URL detail.

Url Edit

String

URL edit.

Url New

String

URL new.

### Duplicate Result Duplicate result.
FieldTypeDescriptionDefault ValueRequired

Allow Save

Boolean

Determines whether to allow saving or not.

Duplicate Rule

String

Duplicate rule.

Duplicate Rule Entity Type

String

Duplicate rule entity type.

Error Message

String

Error message.

Match Results

Array of Match Result

Match results.

### Entity Search Metadata Entity search metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Name

String

Entity name.

Field Metadata

Field metadata.

### Error Error.
FieldTypeDescriptionDefault ValueRequired

Duplicate Result

Duplicate result.

Fields

Array of String

Fields.

Message

String

Message.

Status Code

String

Status code.

### Error Mapping Error mapping.
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Source.

Target

String

Target.

x

### Expiration Policy Configures an expiration policy strategy.
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

### Field Field.
FieldTypeDescriptionDefault ValueRequired

Autonumber

Boolean

Indicates autonumber.

Byte Length

Number

Byte length.

Calculated

Boolean

Indicates whether calculated or not.

Case Sensitive

Boolean

Indicates whether case sensitive or not.

Controller Name

String

Controller name.

Createable

Boolean

Indicates whether createable or not.

Custom

Boolean

Indicates whether customizable or not.

Default Value

Any

Default value.

Default Value Formula

String

Default value formula.

Defaulted On Create

Boolean

Indicates whether defaulted on create.

Dependent Pick List

Boolean

Indicates whether dependent pick list or not.

Deprecate And Hidden

Boolean

Indicates whether deprecated and hidden or not.

Digits

Number

Digits.

Display Location In Decimal

Boolean

Indicates whether the display location is in decimal.

Encrypted

Boolean

Indicates whether encrypted or not.

Extra Type Info

String

Extra type information.

Field Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INT

  • DOUBLE

  • DATE

  • DATETIME

  • TIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANYTYPE

  • DATACATEGORYGROUPREFERENCE

  • ENCRYPTEDSTRING

  • ADDRESS

  • COMPLEXVALUE

  • LOCATION

  • JSON

  • LONG

Field type.

Filterable

Boolean

Indicates whether filterable or not.

Filtered Lookup Info

Filtered lookup information.

Formula

String

Formula.

Groupable

Boolean

Indicates whether groupable or not.

High Scale Number

Boolean

Indicates whether high scale number or not.

Html Formatted

Boolean

Indicates whether HTML formatted or not.

Id Lookup

Boolean

Indicates ID lookup.

Inline Help Text

String

Inline help text.

Label

String

Label.

Length

Number

Length.

Mask

String

Mask.

Mask Type

String

Mask type.

Name

String

Name.

Name Field

Boolean

Indicates name field.

Name Pointing

Boolean

Indicates name pointing.

Nullable

Boolean

Indicates whether nullable or not.

Permissinable

Boolean

Indicates whether permissionable or not.

Picklist Values

Picklist values.

Polymorphic Foreign Key

Boolean

Indicates polymorphic foreign key.

Precision

Number

Precision.

Reference Target Field

String

Reference target field.

Reference To

Array of String

Reference to.

Relationship Name

String

Relationship name.

Relationship Order

Number

Relationship order.

Required

Boolean

Indicates whether required or not.

Restricted Picklist

Boolean

Indicates whether restricted picklist or not.

Scale

Number

Scale.

Search Filterable

Boolean

Indicates whether search filterable or not.

Sortable

Boolean

Indicates whether sortable or not.

Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INT

  • DOUBLE

  • DATE

  • DATETIME

  • TIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANYTYPE

  • DATACATEGORYGROUPREFERENCE

  • ENCRYPTEDSTRING

  • ADDRESS

  • COMPLEXVALUE

  • LOCATION

  • JSON

  • LONG

Type.

Unique

Boolean

Indicates whether unique or not.

Updateable

Boolean

Indicates whether updateable or not.

Write Requires Master Read

Boolean

Indicates whether write requires master read or not.

### Field Diff Field difference.
FieldTypeDescriptionDefault ValueRequired

Difference

Enumeration, one of:

  • DIFFERENT

  • NULL

  • SAME

  • SIMILAR

Field differences.

Name

String

Name of the field.

### Field Level Search Metadata Field level search metadata.
FieldTypeDescriptionDefault ValueRequired

Label

String

Label.

Name

String

Name.

Type

String

Type.

### File Properties File properties.
FieldTypeDescriptionDefault ValueRequired

Created By

String

Created by.

Created By Name

String

Created by name.

Created Date

DateTime

Date created.

File Name

String

File name.

Full Name

String

Full name.

Id

String

ID name.

Last Modified By Id

String

Last modified by ID.

Last Modified By Name

String

Last modified by name.

Last Modified Date

String

Last modified date.

Manageable State

Enumeration, one of:

  • released

  • deleted

  • deprecated

  • installed

  • beta

  • unmanaged

Manageable state.

Namespace Prefix

String

Namespace prefix.

Type

String

Type.

### Filtered Lookup Info Filtered lookup information.
FieldTypeDescriptionDefault ValueRequired

Controlling Fields

Array of String

Controlling fields.

Dependent

Boolean

Indicates dependent or not.

Optional Filter

Boolean

Indicates optional filter or not.

### Find Duplicates Result Find duplicates result.
FieldTypeDescriptionDefault ValueRequired

Duplicate Results

Duplicate results.

Errors

Array of Error

Errors.

Success

Boolean

Determines if successful or not.

### Fixed Frequency Fixed frequency.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

Frequency at which the scheduler initiates the flow, based on the time unit specified in the Time Unit field.

1000 (MILLISECONDS)

x

Start delay

Number

Amount of time that the scheduler waits before initiating the flow for the first time after the app starts. This value is based on the time unit specified in the Time Unit field.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Frequency and Start delay fields.

MILLISECONDS

### Generic Streaming Event Generic streaming event.
FieldTypeDescriptionDefault ValueRequired

Payload

String

Payload.

User Ids

Array of String

User IDs.

### Get Deleted Result Get deleted result.
FieldTypeDescriptionDefault ValueRequired

Deleted Records

Deleted records.

Earliest Date Available

DateTime

Earliest date available.

Latest Date Covered

DateTime

Latest date covered.

### Get Updated Result Get updated result.
FieldTypeDescriptionDefault ValueRequired

Ids

Array of String

IDs.

Latest Date Covered

DateTime

Latest date covered.

### Get User Info Result Get user information result.
FieldTypeDescriptionDefault ValueRequired

Accessibility Mode

Boolean

Indicates accessibility mode.

Currency Symbol

String

Currency symbol.

Org Attachment File Size Limit

Number

Organization attachment file size limit.

Org Default Currency Iso Code

String

Organization default currency ISO code.

Org Default Currency Locale

String

Organization default currency locale.

Org Disallow Html Attachments

Boolean

Indicates whether the organization disallows HTML attachments.

Org Has Person Accounts

Boolean

Indicates whether the organization contains person accounts.

Organization Id

String

Organization ID.

Organization Multi Currency

Boolean

Organization multicurrency.

Organization Name

String

Organization name.

Profile Id

String

Profile ID.

Role Id

String

Role ID.

Session Seconds Valid

Number

Session seconds valid.

User Default Currency Iso Code

String

User default currency ISO code.

User Email

String

User email.

User Full Name

String

User full name.

User Id

String

User ID.

User Language

String

User language.

User Locale

String

User locale.

User Name

String

User name.

User Time Zone

String

User time zone.

User Type

String

User type.

User Ui Skin

String

User UI skin.

### Job Failed Record Results Job failed record results.
FieldTypeDescriptionDefault ValueRequired

Error Message

String

Error message.

Id

String

ID name.

Original Fields

Object

Original fields.

### Job Info Job info.
FieldTypeDescriptionDefault ValueRequired

Apex Processing Time

Number

Apex processing time.

Api Active Processing Time

Number

API active processing time.

Api Version

Number

API version.

Assignment Rule Id

String

ID of an assignment rule for a case or lead. The assignment rule can be active or inactive.

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Concurrency mode.

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type.

Created By Id

String

Created by ID.

Created Date

DateTime

Date created.

External Id Field Name

String

External ID field name.

Fast Path Enabled

Boolean

Determines whether fast path is enabled.

Id

String

ID name.

Number Batches Completed

Number

Number of batches that are completed.

Number Batches Failed

Number

Number of batches that failed.

Number Batches In Progress

Number

Number of batches in progress.

Number Batches Queued

Number

Number of batches that are queued.

Number Batches Total

Number

Number of batches in total.

Number Records Failed

Number

Number of records that failed.

Number Records Processed

Number

Number of records that are processed.

Number Retries

Number

Number of retries.

Object

String

Object.

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

  • queryAll

Operation name.

State

Enumeration, one of:

  • Open

  • Closed

  • Aborted

  • Failed

State.

System Modstamp

DateTime

System modstamp.

Total Processing Time

Number

Total processing time.

### Job Successful Record Result Job successful record result.
FieldTypeDescriptionDefault ValueRequired

Created

Boolean

Indicates whether the job is created or not.

Id

String

ID name.

Original Fields

Object

Original fields.

### Job Unprocessed Record Result Job unprocessed record result.
FieldTypeDescriptionDefault ValueRequired

Original Fields

Object

Original fields.

### Keystore Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

### Labels Search Metadata Labels search metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Field Labels

Entity field labels.

Entity Name

String

Entity name.

### Lead Convert Result Lead convert result.
FieldTypeDescriptionDefault ValueRequired

Account Id

String

Account ID.

Contact Id

String

Contact ID.

Errors

Array of Error

Errors.

Lead Id

String

Lead ID.

Opportunity Id

String

Opportunity ID.

Success

Boolean

Determines if successful or not.

### Lead Convert Request Lead convert request.
FieldTypeDescriptionDefault ValueRequired

Contact Id

String

ID of the contact into which the lead is merged (this contact must be associated with the specified account ID, and an account ID must be specified). Required only when updating an existing contact.

If you are converting a lead into a person account, do not specify the contact ID or else an error results. Specify only the account ID of the person account. If no contact ID is specified, then the API creates a new contact that is implicitly associated with the account. To create a new contact, the client application must be logged in with sufficient access rights. To merge a lead into an existing contact, the client application must be logged in with read or write access to the specified contact. The contact name and other existing data are not overwritten (unless Over Write Lead Source is set to true, in which case only the lead source field is overwritten). For information on IDs, see ID Field Type.

Account Id

String

ID of the account into which the lead is merged. Required only when updating an existing account, including person accounts. If no account ID is specified, then the API creates a new account. To create a new account, the client application must be logged in with sufficient access rights. To merge a lead into an existing account, the client application must be logged in with read or write access to the specified account. The account name and other existing data are not overwritten. For information on IDs, see ID Field Type.

Send Email To Owner

Boolean

If true, specifies whether to send a notification email to the owner specified in the Owner ID.

false

Opportunity Name

String

Name of the opportunity to create. If unspecified, this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If Do Not Create Opportunity is true, then no opportunity is created and this field must be left blank; otherwise, an error is returned.

Do Not Create Opportunity

Boolean

Specifies whether to create an opportunity during lead conversion. Set this flag to true only if you do not want to create an opportunity from the lead. An opportunity is created by default.

false

Over Write Lead Source

Boolean

Specifies whether to overwrite the lead source field on the target contact object with the contents of the lead source field in the source lead object. To set this field to true, the client application must specify a Contact Id for the target contact.

false

Opportunity Id

String

ID of an existing opportunity to relate to a lead during lead conversion.

Owner Id

String

Name associated with the owner ID that owns this lead.

Related Person Account Id

String

When converting a lead to a business account and an existing person account, this value specifies the ID of the person account.

Related Person Account Record

Object

When converting a lead to a business account and a new person account, this value specifies the entity record of the new person account.

### Match Record Match record.
FieldTypeDescriptionDefault ValueRequired

Additional Information

Additional information.

Field Diffs

Array of Field Diff

Field differences.

Match Confidence

Number

Match confidence.

Record

Object

Record.

### Match Result Match result.
FieldTypeDescriptionDefault ValueRequired

Entity Type

String

Entity type.

Errors

Array of Simple Error

Errors.

Match Engine

String

Match engine name.

Match Records

Array of Match Record

Match records.

Rule

String

Rule name.

Size

Number

Size.

Success

Boolean

Determines if successful or not.

### Merge Record Merge record.
FieldTypeDescriptionDefault ValueRequired

Master Record

Object

Master record that contains at least the ID and the type of the object that other records merge into. Optionally, provide the fields and their values to update.

x

Record To Merge Ids

Array of String

Additional records to merge into the primary record. Minimum of one record and maximum of two records.

x

Additional Information Map

Object

Field-value map. When a portal user ID is merged, it must contain two entries: name: PortalUserId and value: ID of the portal user. In all other merge cases, set to null or leave empty.

### Merge Result Merge result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Errors.

Id

String

ID name.

Merged Record Ids

Array of String

Merged record IDs.

Success

Boolean

Determines if successful or not.

Updated Related Ids

Array of String

Updated related IDs.

### Metadata Result Metadata result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Errors.

Full Name

String

Full name.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

### Name Value Pair Name value pair.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name.

Value

String

Value.

### Named Layout Info Named layout information.
FieldTypeDescriptionDefault ValueRequired

Name

String

Name.

### Non-Repeatable Stream Configures the non-repeatable streaming strategy, in which Mule disables repeatable streams. Use this strategy if your use case requires reading the content only once. In some cases, you might want to disable the repeatable stream functionality and use non-repeatable streams, which can have less performance overhead, memory use, and cost. ### Pick List Entry Pick list entry.
FieldTypeDescriptionDefault ValueRequired

Active

Boolean

Indicates active or not.

Default Value

Boolean

Indicates default value.

Label

String

Label.

Valid For

Binary

Indicates when valid for.

Value

String

Value.

### Proxy Configures a proxy for outbound connections.
FieldTypeDescriptionDefault ValueRequired

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

### Push Event Result Push event result.
FieldTypeDescriptionDefault ValueRequired

Fanout Count

Number

Fanout count.

User Online Status

Object

User online status.

### Query Job Info Query job information.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Number Records Processed

Number

Number of records that are processed.

Object

String

Object.

Operation

String

Operation name.

Pk Chunking Supported

Boolean

Whether or not PK chunking is supported.

Retries

Number

Number of retries.

State

String

State.

System Modstamp

String

System modstamp.

Total Processing Time

Number

Total processing time.

### Query Job State Query job state.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Query Jobs Info Result Query jobs information result.
FieldTypeDescriptionDefault ValueRequired

Api Version

String

API version.

Column Delimiter

String

Column delimiter.

Concurrency Mode

String

Concurrency mode.

Content Type

String

Content type.

Created By Id

String

Created by ID.

Created Date

String

Date created.

Id

String

ID name.

Job Type

String

Job type.

Line Ending

String

Line ending.

Object

String

Object.

Operation

String

Operation name.

State

String

State.

System Modstamp

String

System modstamp.

### Reconnect Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

### Reconnection Configures a reconnection strategy for an operation.
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

### Record Type Info Record type information.
FieldTypeDescriptionDefault ValueRequired

Available

Boolean

Indicates whether available or not.

Default Record Type Mapping

Boolean

Indicates default record type mapping.

Id

String

ID name.

Master

Boolean

Indicates master.

Name

String

Name.

### Redelivery Policy Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
FieldTypeDescriptionDefault ValueRequired

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

### Redelivery Policy Message Identifier Configures the redelivery policy message identifier type.
FieldTypeDescriptionDefault ValueRequired

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if the Use Secure Hash field is false.

### Repeatable File Store Iterable Repeatable file store iterable.
FieldTypeDescriptionDefault ValueRequired

In Memory Objects

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Repeatable In Memory Iterable Repeatable in memory iterable.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower means that the buffer must not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### Reset Password Result Reset password result.
FieldTypeDescriptionDefault ValueRequired

Password

String

Password to authenticate against the proxy server.

### Result Result.
FieldTypeDescriptionDefault ValueRequired

Errors

Array of Error

Array of the Error type.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

### Retrieve Request Retrieve request.
FieldTypeDescriptionDefault ValueRequired

Fields

Array of String

Fields.

Ids

Array of String

IDs.

### Search Record Search record.
FieldTypeDescriptionDefault ValueRequired

Record

Object

Record.

Search Record Metadata

Search record metadata.

Snippet

Snippet.

### Search Record Metadata Search record metadata.
FieldTypeDescriptionDefault ValueRequired

Spell Corrected

Boolean

Indicates whether the search is spelled correctly.

### Search Result Search result.
FieldTypeDescriptionDefault ValueRequired

Query Id

String

Query ID.

Search Records

Array of Search Record

Search records.

Search Results Metadata

Search results metadata.

### Search Results Metadata Search results metadata.
FieldTypeDescriptionDefault ValueRequired

Entity Label Metadata

Entity label metadata.

Entity Metadata

Entity metadata.

### Search Snippet Search snippet.
FieldTypeDescriptionDefault ValueRequired

Text

String

Text.

Whole Fields

Whole fields.

### Simple Error Simple error.
FieldTypeDescriptionDefault ValueRequired

Fields

Array of String

Fields.

Message

String

Message.

Status Code

String

Status code.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

### TLS Configures TLS to provide secure communications for the Mule app.
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

### Truststore Configures the truststore for TLS.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

### Upsert Metadata Result Upsert metadata result.
FieldTypeDescriptionDefault ValueRequired

Created

Boolean

Indicates whether created or not.

Errors

Array of Error

Errors.

Full Name

String

Full name.

Id

String

ID name.

Success

Boolean

Determines if successful or not.

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 12.0 is-latest-version: true --- # Salesforce Connector 12.0 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule app in XML either from the Anypoint Studio XML editor or a text editor, perform the following actions to get access to the connector: - Add the namespace for the connector to your XML flow. - Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/salesforce http://www.mulesoft.org/schema/mule/salesforce/current/mule-salesforce.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The Maven `pom.xml` file generated by Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector. ```xml com.mulesoft.connectors mule-salesforce-connector x.x.x mule-plugin ``` Replace `x.x.x` with version information from Exchange. Ensure the connector version corresponds to the one 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 `salesforce`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next After completing your namespace and `pom.xml` file, you can try the [Salesforce Examples](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.2 --- # Troubleshooting Salesforce Connector 11.2 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt To troubleshoot Anypoint Connector for Salesforce (Salesforce Connector), become familiar with the information about performing general troubleshooting and interpreting commonly thrown exception messages. ## Enable SSL Logging Enable SSL logs to investigate an issue related to TLS communications. Set your SSL log level depending on your required level of detail: 1. Enable only SSL log details: `javax.net.debug=ssl` 2. Enable only handshaking details. (The handshake protocol is a series of messages exchanged over the record protocol.) `javax.net.debug=ssl:handshake` 3. Enable handshaking details and SSL details at the same time: `javax.net.debug=ssl, handshake` 4. Enable the dumping of all details and traffic data: `javax.net.debug=all` > [!NOTE] This option is very verbose and under normal circumstances is not necessary. > [!WARNING] SSL logging results in a performance impact for HTTPS or other TLS connections. Enable > SSL logging only to troubleshoot a specific issue and do not enable it for extended periods. SSL > logging produces a significant amount of log messages and can inundate your log file if it is left > enabled and unattended. To enable SSL logs: Set the debug parameter as an argument in the runtime configuration for the application. 1. In Studio, right-click on the project and select **Run > Run Configurations**. 2. Go to the **Arguments** tab and add `-M-Djavax.net.debug=ssl` in the **VM arguments** section. ## Enable Verbose Exception Logging Enable verbose exception logs to show a complete stack trace of the error instead of the default truncated output: 1. In Studio, right-click on the project and select **Run > Run Configurations**. 2. Go to the **Arguments** tab and append the arguments in the **VM arguments** section to add the `mule.verbose.exceptions` property. For example: `-XX:PermSize=128M -XX:MaxPermSize=256M -Dmule.verbose.exceptions=true` ## Enable Verbose Logging To get a better understanding of why an application’s interaction with Salesforce Connector is failing, temporarily enable verbose logging for the connector. Remember to always disable enhanced verbosity after troubleshooting, because it can affect your Mule application’s performance. To enable verbose logging in the configuration file: 1. Access Anypoint Studio and navigate to the **Package Explorer** view. 2. Open your application’s project name. 3. Open the `src/main/resources` folder. 4. Open the `log4j2.xml` file inside the folder. 5. Add an `` tag inside the `` tag: ```xml ... ... ``` 6. Save your application changes. 7. Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule Application**. ## Perform General Troubleshooting Here is a list of general troubleshooting guidelines for Salesforce Connector: - [Currency](#currency) - [Evaluate Values in a Salesforce List](#evaluate-values-in-a-salesforce-list) - [Insert Values in a Salesforce Connector List](#insert-values-in-a-salesforce-connector-list) - [Japanese Support](#japanese-support) - [Limits on API Calls](#limits-on-api-calls) - [Opportunity Object](#opportunity-object) ### Currency Currency values cannot exceed 18 characters in length. When working with multiple currencies, you must know which currency your sObject uses to avoid inaccurate entries. The default currency matches the location at the organization level. ### Evaluate Values in a Salesforce List When using a value to evaluate against contents of an existing list field in Salesforce, use the exact value in the list. For example, if you use the value `US` to evaluate against contents of a list that contains the value `USA`, the evaluation works, but the result returns two values in the list: one for `US` and one for `USA`. ### Insert Values in a Salesforce Connector List Inserting dependent values into an existing list in Salesforce Connector does not always work. Test to confirm this functionality. ### Japanese Support Salesforce Connector supports Japanese characters for all operations, with the following exceptions: - The **Publish Streaming Channel** operation does not support Japanese characters in the **Channel name** field, which can contain only alphanumeric characters, and the `_` or `/` characters. Refer to the Salesforce [StreamingChannel](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_streamingchannel.htm) documentation for more information. - Metadata operations might return error messages if some fields contain Japanese characters. For example, creating custom objects or custom fields with a **Full Name** that contains Japanese characters triggers a `FIELD_INTEGRITY_EXCEPTION` error with the following message: `The Object Name field can only contain underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.` ### Limits on API Calls You must know the scope of the rate limiting policy that applies to your account so that you do not exceed the number of allotted API calls per day. ### Opportunity Object When extracting data from a Salesforce Opportunity object, be aware that a `quarter` in this context is relative to the fiscal year of the organization and not necessarily to the calendar year. ## Understand Commonly Thrown Exceptions Here is a list of commonly thrown exception messages and how to interpret them: - SALESFORCE:COMMUNICATION A communication error occurs between systems. - SALESFORCE:CONNECTIVITY A problem occurred and a connection could not be established. Review your Salesforce Connector configuration and reconnection strategy. - SALESFORCE:INSUFFICIENT\_PERMISSIONS The provided permissions are insufficient. - SALESFORCE:INVALID\_INPUT The provided input data for an operation is not valid. - SALESFORCE:INVALID\_RESPONSE The response from the server cannot be processed. - SALESFORCE:LIMIT\_EXCEEDED A specific limit is exceeded, for example, if you try to create more than 200 entities at once with the \*Create\* operation. - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED The mutual authentication failed. - SALESFORCE:NOT\_FOUND The server could not find the requested resource. - SALESFORCE:OPERATION\_NOT\_SUPPORTED The operation is not supported. - SALESFORCE:RETRY\_EXHAUSTED The maximum number of retries for the operation is reached. - SALESFORCE:TIMEOUT A specific request takes longer than a configured amount of time to complete. - SALESFORCE:UNAVAILABLE The server is unavailable. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Connector Reference](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-reference) - [Salesforce Help](https://help.salesforce.com) - [Known Issues](https://help.salesforce.com/s/issues) --- product: Salesforce Connector version: 11.3 --- # Troubleshooting Salesforce Connector 11.3 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt To troubleshoot Anypoint Connector for Salesforce (Salesforce Connector), become familiar with the information about performing general troubleshooting and interpreting commonly thrown exception messages. ## Enable SSL Logging Enable SSL logs to investigate an issue related to TLS communications. Set your SSL log level depending on your required level of detail: 1. Enable only SSL log details: `javax.net.debug=ssl` 2. Enable only handshaking details. (The handshake protocol is a series of messages exchanged over the record protocol.) `javax.net.debug=ssl:handshake` 3. Enable handshaking details and SSL details at the same time: `javax.net.debug=ssl, handshake` 4. Enable the dumping of all details and traffic data: `javax.net.debug=all` > [!NOTE] This option is very verbose and under normal circumstances is not necessary. > [!WARNING] SSL logging results in a performance impact for HTTPS or other TLS connections. Enable > SSL logging only to troubleshoot a specific issue and do not enable it for extended periods. SSL > logging produces a significant amount of log messages and can inundate your log file if it is left > enabled and unattended. To enable SSL logs: Set the debug parameter as an argument in the runtime configuration for the application. 1. In Studio, right-click on the project and select **Run > Run Configurations**. 2. Go to the **Arguments** tab and add `-M-Djavax.net.debug=ssl` in the **VM arguments** section. ## Enable Verbose Exception Logging Enable verbose exception logs to show a complete stack trace of the error instead of the default truncated output: 1. In Studio, right-click on the project and select **Run > Run Configurations**. 2. Go to the **Arguments** tab and append the arguments in the **VM arguments** section to add the `mule.verbose.exceptions` property. For example: `-XX:PermSize=128M -XX:MaxPermSize=256M -Dmule.verbose.exceptions=true` ## Enable Verbose Logging To get a better understanding of why an application’s interaction with Salesforce Connector is failing, temporarily enable verbose logging for the connector. Remember to always disable enhanced verbosity after troubleshooting, because it can affect your Mule application’s performance. To enable verbose logging in the configuration file: 1. Access Anypoint Studio and navigate to the **Package Explorer** view. 2. Open your application’s project name. 3. Open the `src/main/resources` folder. 4. Open the `log4j2.xml` file inside the folder. 5. Add an `` tag inside the `` tag: ```xml ... ... ``` 6. Save your application changes. 7. Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule Application**. ## Perform General Troubleshooting Here is a list of general troubleshooting guidelines for Salesforce Connector: - [Currency](#currency) - [Evaluate Values in a Salesforce List](#evaluate-values-in-a-salesforce-list) - [Insert Values in a Salesforce Connector List](#insert-values-in-a-salesforce-connector-list) - [Japanese Support](#japanese-support) - [Limits on API Calls](#limits-on-api-calls) - [Opportunity Object](#opportunity-object) ### Currency Currency values cannot exceed 18 characters in length. When working with multiple currencies, you must know which currency your sObject uses to avoid inaccurate entries. The default currency matches the location at the organization level. ### Evaluate Values in a Salesforce List When using a value to evaluate against contents of an existing list field in Salesforce, use the exact value in the list. For example, if you use the value `US` to evaluate against contents of a list that contains the value `USA`, the evaluation works, but the result returns two values in the list: one for `US` and one for `USA`. ### Insert Values in a Salesforce Connector List Inserting dependent values into an existing list in Salesforce Connector does not always work. Test to confirm this functionality. ### Japanese Support Salesforce Connector supports Japanese characters for all operations, with the following exceptions: - The **Publish Streaming Channel** operation does not support Japanese characters in the **Channel name** field, which can contain only alphanumeric characters, and the `_` or `/` characters. Refer to the Salesforce [StreamingChannel](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_streamingchannel.htm) documentation for more information. - Metadata operations might return error messages if some fields contain Japanese characters. For example, creating custom objects or custom fields with a **Full Name** that contains Japanese characters triggers a `FIELD_INTEGRITY_EXCEPTION` error with the following message: `The Object Name field can only contain underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.` ### Limits on API Calls You must know the scope of the rate limiting policy that applies to your account so that you do not exceed the number of allotted API calls per day. ### Opportunity Object When extracting data from a Salesforce Opportunity object, be aware that a `quarter` in this context is relative to the fiscal year of the organization and not necessarily to the calendar year. ## Understand Commonly Thrown Exceptions Here is a list of commonly thrown exception messages and how to interpret them: - SALESFORCE:COMMUNICATION A communication error occurs between systems. - SALESFORCE:CONNECTIVITY A problem occurred and a connection could not be established. Review your Salesforce Connector configuration and reconnection strategy. - SALESFORCE:INSUFFICIENT\_PERMISSIONS The provided permissions are insufficient. - SALESFORCE:INVALID\_INPUT The provided input data for an operation is not valid. - SALESFORCE:INVALID\_RESPONSE The response from the server cannot be processed. - SALESFORCE:LIMIT\_EXCEEDED A specific limit is exceeded, for example, if you try to create more than 200 entities at once with the \*Create\* operation. - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED The mutual authentication failed. - SALESFORCE:NOT\_FOUND The server could not find the requested resource. - SALESFORCE:OPERATION\_NOT\_SUPPORTED The operation is not supported. - SALESFORCE:RETRY\_EXHAUSTED The maximum number of retries for the operation is reached. - SALESFORCE:TIMEOUT A specific request takes longer than a configured amount of time to complete. - SALESFORCE:UNAVAILABLE The server is unavailable. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Connector Reference](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-reference) - [Salesforce Help](https://help.salesforce.com) - [Known Issues](https://help.salesforce.com/s/issues) --- product: Salesforce Connector version: 11.4 --- # Troubleshooting Salesforce Connector 11.4 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt To troubleshoot Anypoint Connector for Salesforce (Salesforce Connector), become familiar with the information about performing general troubleshooting and interpreting commonly thrown exception messages. ## Enable SSL Logging Enable SSL logs to investigate an issue related to TLS communications. Set your SSL log level depending on your required level of detail: 1. Enable only SSL log details: `javax.net.debug=ssl` 2. Enable only handshaking details. (The handshake protocol is a series of messages exchanged over the record protocol.) `javax.net.debug=ssl:handshake` 3. Enable handshaking details and SSL details at the same time: `javax.net.debug=ssl, handshake` 4. Enable the dumping of all details and traffic data: `javax.net.debug=all` > [!NOTE] This option is very verbose and under normal circumstances is not necessary. > [!WARNING] SSL logging results in a performance impact for HTTPS or other TLS connections. Enable > SSL logging only to troubleshoot a specific issue and do not enable it for extended periods. SSL > logging produces a significant amount of log messages and can inundate your log file if it is left > enabled and unattended. To enable SSL logs: Set the debug parameter as an argument in the runtime configuration for the application. 1. In Studio, right-click on the project and select **Run > Run Configurations**. 2. Go to the **Arguments** tab and add `-M-Djavax.net.debug=ssl` in the **VM arguments** section. ## Enable Verbose Exception Logging Enable verbose exception logs to show a complete stack trace of the error instead of the default truncated output: 1. In Studio, right-click on the project and select **Run > Run Configurations**. 2. Go to the **Arguments** tab and append the arguments in the **VM arguments** section to add the `mule.verbose.exceptions` property. For example: `-XX:PermSize=128M -XX:MaxPermSize=256M -Dmule.verbose.exceptions=true` ## Enable Verbose Logging To get a better understanding of why an application’s interaction with Salesforce Connector is failing, temporarily enable verbose logging for the connector. Remember to always disable enhanced verbosity after troubleshooting, because it can affect your Mule application’s performance. To enable verbose logging in the configuration file: 1. Access Anypoint Studio and navigate to the **Package Explorer** view. 2. Open your application’s project name. 3. Open the `src/main/resources` folder. 4. Open the `log4j2.xml` file inside the folder. 5. Add an `` tag inside the `` tag: ```xml ... ... ``` 6. Save your application changes. 7. Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule Application**. ## Perform General Troubleshooting Here is a list of general troubleshooting guidelines for Salesforce Connector: - [Currency](#currency) - [Evaluate Values in a Salesforce List](#evaluate-values-in-a-salesforce-list) - [Insert Values in a Salesforce Connector List](#insert-values-in-a-salesforce-connector-list) - [Japanese Support](#japanese-support) - [Limits on API Calls](#limits-on-api-calls) - [Opportunity Object](#opportunity-object) ### Currency Currency values cannot exceed 18 characters in length. When working with multiple currencies, you must know which currency your sObject uses to avoid inaccurate entries. The default currency matches the location at the organization level. ### Evaluate Values in a Salesforce List When using a value to evaluate against contents of an existing list field in Salesforce, use the exact value in the list. For example, if you use the value `US` to evaluate against contents of a list that contains the value `USA`, the evaluation works, but the result returns two values in the list: one for `US` and one for `USA`. ### Insert Values in a Salesforce Connector List Inserting dependent values into an existing list in Salesforce Connector does not always work. Test to confirm this functionality. ### Japanese Support Salesforce Connector supports Japanese characters for all operations, with the following exceptions: - The **Publish Streaming Channel** operation does not support Japanese characters in the **Channel name** field, which can contain only alphanumeric characters, and the `_` or `/` characters. Refer to the Salesforce [StreamingChannel](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_streamingchannel.htm) documentation for more information. - Metadata operations might return error messages if some fields contain Japanese characters. For example, creating custom objects or custom fields with a **Full Name** that contains Japanese characters triggers a `FIELD_INTEGRITY_EXCEPTION` error with the following message: `The Object Name field can only contain underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.` ### Limits on API Calls You must know the scope of the rate limiting policy that applies to your account so that you do not exceed the number of allotted API calls per day. ### Opportunity Object When extracting data from a Salesforce Opportunity object, be aware that a `quarter` in this context is relative to the fiscal year of the organization and not necessarily to the calendar year. ## Understand Commonly Thrown Exceptions Here is a list of commonly thrown exception messages and how to interpret them: - SALESFORCE:COMMUNICATION A communication error occurs between systems. - SALESFORCE:CONNECTIVITY A problem occurred and a connection could not be established. Review your Salesforce Connector configuration and reconnection strategy. - SALESFORCE:INSUFFICIENT\_PERMISSIONS The provided permissions are insufficient. - SALESFORCE:INVALID\_INPUT The provided input data for an operation is not valid. - SALESFORCE:INVALID\_RESPONSE The response from the server cannot be processed. - SALESFORCE:LIMIT\_EXCEEDED A specific limit is exceeded, for example, if you try to create more than 200 entities at once with the \*Create\* operation. - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED The mutual authentication failed. - SALESFORCE:NOT\_FOUND The server could not find the requested resource. - SALESFORCE:OPERATION\_NOT\_SUPPORTED The operation is not supported. - SALESFORCE:RETRY\_EXHAUSTED The maximum number of retries for the operation is reached. - SALESFORCE:TIMEOUT A specific request takes longer than a configured amount of time to complete. - SALESFORCE:UNAVAILABLE The server is unavailable. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Connector Reference](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-reference) - [Salesforce Help](https://help.salesforce.com) - [Known Issues](https://help.salesforce.com/s/issues) --- product: Salesforce Connector version: 11.5 --- # Troubleshooting Salesforce Connector 11.5 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt To troubleshoot Anypoint Connector for Salesforce (Salesforce Connector), become familiar with the information about performing general troubleshooting and interpreting commonly thrown exception messages. ## Enable SSL Logging Enable SSL logs to investigate an issue related to TLS communications. Set your SSL log level depending on your required level of detail: 1. Enable only SSL log details: `javax.net.debug=ssl` 2. Enable only handshaking details. (The handshake protocol is a series of messages exchanged over the record protocol.) `javax.net.debug=ssl:handshake` 3. Enable handshaking details and SSL details at the same time: `javax.net.debug=ssl, handshake` 4. Enable the dumping of all details and traffic data: `javax.net.debug=all` > [!NOTE] This option is very verbose and under normal circumstances is not necessary. > [!WARNING] SSL logging results in a performance impact for HTTPS or other TLS connections. Enable > SSL logging only to troubleshoot a specific issue and do not enable it for extended periods. SSL > logging produces a significant amount of log messages and can inundate your log file if it is left > enabled and unattended. To enable SSL logs: Set the debug parameter as an argument in the runtime configuration for the application. 1. In Studio, right-click on the project and select **Run > Run Configurations**. 2. Go to the **Arguments** tab and add `-M-Djavax.net.debug=ssl` in the **VM arguments** section. ## Enable Verbose Exception Logging Enable verbose exception logs to show a complete stack trace of the error instead of the default truncated output: 1. In Studio, right-click on the project and select **Run > Run Configurations**. 2. Go to the **Arguments** tab and append the arguments in the **VM arguments** section to add the `mule.verbose.exceptions` property. For example: `-XX:PermSize=128M -XX:MaxPermSize=256M -Dmule.verbose.exceptions=true` ## Enable Verbose Logging To get a better understanding of why an application’s interaction with Salesforce Connector is failing, temporarily enable verbose logging for the connector. Remember to always disable enhanced verbosity after troubleshooting, because it can affect your Mule application’s performance. To enable verbose logging in the configuration file: 1. Access Anypoint Studio and navigate to the **Package Explorer** view. 2. Open your application’s project name. 3. Open the `src/main/resources` folder. 4. Open the `log4j2.xml` file inside the folder. 5. Add an `` tag inside the `` tag: ```xml ... ... ``` 6. Save your application changes. 7. Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule Application**. ## Perform General Troubleshooting Here is a list of general troubleshooting guidelines for Salesforce Connector: - [Currency](#currency) - [Evaluate Values in a Salesforce List](#evaluate-values-in-a-salesforce-list) - [Insert Values in a Salesforce Connector List](#insert-values-in-a-salesforce-connector-list) - [Japanese Support](#japanese-support) - [Limits on API Calls](#limits-on-api-calls) - [Opportunity Object](#opportunity-object) ### Currency Currency values cannot exceed 18 characters in length. When working with multiple currencies, you must know which currency your sObject uses to avoid inaccurate entries. The default currency matches the location at the organization level. ### Evaluate Values in a Salesforce List When using a value to evaluate against contents of an existing list field in Salesforce, use the exact value in the list. For example, if you use the value `US` to evaluate against contents of a list that contains the value `USA`, the evaluation works, but the result returns two values in the list: one for `US` and one for `USA`. ### Insert Values in a Salesforce Connector List Inserting dependent values into an existing list in Salesforce Connector does not always work. Test to confirm this functionality. ### Japanese Support Salesforce Connector supports Japanese characters for all operations, with the following exceptions: - The **Publish Streaming Channel** operation does not support Japanese characters in the **Channel name** field, which can contain only alphanumeric characters, and the `_` or `/` characters. Refer to the Salesforce [StreamingChannel](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_streamingchannel.htm) documentation for more information. - Metadata operations might return error messages if some fields contain Japanese characters. For example, creating custom objects or custom fields with a **Full Name** that contains Japanese characters triggers a `FIELD_INTEGRITY_EXCEPTION` error with the following message: `The Object Name field can only contain underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.` ### Limits on API Calls You must know the scope of the rate limiting policy that applies to your account so that you do not exceed the number of allotted API calls per day. ### Opportunity Object When extracting data from a Salesforce Opportunity object, be aware that a `quarter` in this context is relative to the fiscal year of the organization and not necessarily to the calendar year. ## Understand Commonly Thrown Exceptions Here is a list of commonly thrown exception messages and how to interpret them: - SALESFORCE:COMMUNICATION A communication error occurs between systems. - SALESFORCE:CONNECTIVITY A problem occurred and a connection could not be established. Review your Salesforce Connector configuration and reconnection strategy. - SALESFORCE:INSUFFICIENT\_PERMISSIONS The provided permissions are insufficient. - SALESFORCE:INVALID\_INPUT The provided input data for an operation is not valid. - SALESFORCE:INVALID\_RESPONSE The response from the server cannot be processed. - SALESFORCE:LIMIT\_EXCEEDED A specific limit is exceeded, for example, if you try to create more than 200 entities at once with the \*Create\* operation. - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED The mutual authentication failed. - SALESFORCE:NOT\_FOUND The server could not find the requested resource. - SALESFORCE:OPERATION\_NOT\_SUPPORTED The operation is not supported. - SALESFORCE:RETRY\_EXHAUSTED The maximum number of retries for the operation is reached. - SALESFORCE:TIMEOUT A specific request takes longer than a configured amount of time to complete. - SALESFORCE:UNAVAILABLE The server is unavailable. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Connector Reference](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-reference) - [Salesforce Help](https://help.salesforce.com) - [Known Issues](https://help.salesforce.com/s/issues) --- product: Salesforce Connector version: 12.0 is-latest-version: true --- # Troubleshooting Salesforce Connector 12.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt To troubleshoot Anypoint Connector for Salesforce (Salesforce Connector), become familiar with the information about performing general troubleshooting and interpreting commonly thrown exception messages. ## Enable SSL Logging Enable SSL logs to investigate an issue related to TLS communications. Set your SSL log level depending on your required level of detail: 1. Enable only SSL log details: `javax.net.debug=ssl` 2. Enable only handshaking details. (The handshake protocol is a series of messages exchanged over the record protocol.) `javax.net.debug=ssl:handshake` 3. Enable handshaking details and SSL details at the same time: `javax.net.debug=ssl, handshake` 4. Enable the dumping of all details and traffic data: `javax.net.debug=all` > [!NOTE] This option is very verbose and under normal circumstances is not necessary. > [!WARNING] SSL logging results in a performance impact for HTTPS or other TLS connections. Enable > SSL logging only to troubleshoot a specific issue and do not enable it for extended periods. SSL > logging produces a significant amount of log messages and can inundate your log file if it is left > enabled and unattended. To enable SSL logs: Set the debug parameter as an argument in the runtime configuration for the application. 1. In Studio, right-click on the project and select **Run > Run Configurations**. 2. Go to the **Arguments** tab and add `-M-Djavax.net.debug=ssl` in the **VM arguments** section. ## Enable Verbose Exception Logging Enable verbose exception logs to show a complete stack trace of the error instead of the default truncated output: 1. In Studio, right-click on the project and select **Run > Run Configurations**. 2. Go to the **Arguments** tab and append the arguments in the **VM arguments** section to add the `mule.verbose.exceptions` property. For example: `-XX:PermSize=128M -XX:MaxPermSize=256M -Dmule.verbose.exceptions=true` ## Enable Verbose Logging To get a better understanding of why an application’s interaction with Salesforce Connector is failing, temporarily enable verbose logging for the connector. Remember to always disable enhanced verbosity after troubleshooting, because it can affect your Mule application’s performance. To enable verbose logging in the configuration file: 1. Access Anypoint Studio and navigate to the **Package Explorer** view. 2. Open your application’s project name. 3. Open the `src/main/resources` folder. 4. Open the `log4j2.xml` file inside the folder. 5. Add an `` tag inside the `` tag: ```xml ... ... ``` 6. Save your application changes. 7. Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule Application**. ## Perform General Troubleshooting Here is a list of general troubleshooting guidelines for Salesforce Connector: - [Currency](#currency) - [Evaluate Values in a Salesforce List](#evaluate-values-in-a-salesforce-list) - [Insert Values in a Salesforce Connector List](#insert-values-in-a-salesforce-connector-list) - [Japanese Support](#japanese-support) - [Limits on API Calls](#limits-on-api-calls) - [Opportunity Object](#opportunity-object) ### Currency Currency values cannot exceed 18 characters in length. When working with multiple currencies, you must know which currency your sObject uses to avoid inaccurate entries. The default currency matches the location at the organization level. ### Evaluate Values in a Salesforce List When using a value to evaluate against contents of an existing list field in Salesforce, use the exact value in the list. For example, if you use the value `US` to evaluate against contents of a list that contains the value `USA`, the evaluation works, but the result returns two values in the list: one for `US` and one for `USA`. ### Insert Values in a Salesforce Connector List Inserting dependent values into an existing list in Salesforce Connector does not always work. Test to confirm this functionality. ### Japanese Support Salesforce Connector supports Japanese characters for all operations, with the following exceptions: - The **Publish Streaming Channel** operation does not support Japanese characters in the **Channel name** field, which can contain only alphanumeric characters, and the `_` or `/` characters. Refer to the Salesforce [StreamingChannel](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_streamingchannel.htm) documentation for more information. - Metadata operations might return error messages if some fields contain Japanese characters. For example, creating custom objects or custom fields with a **Full Name** that contains Japanese characters triggers a `FIELD_INTEGRITY_EXCEPTION` error with the following message: `The Object Name field can only contain underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.` ### Limits on API Calls You must know the scope of the rate limiting policy that applies to your account so that you do not exceed the number of allotted API calls per day. ### Opportunity Object When extracting data from a Salesforce Opportunity object, be aware that a `quarter` in this context is relative to the fiscal year of the organization and not necessarily to the calendar year. ## Understand Commonly Thrown Exceptions Here is a list of commonly thrown exception messages and how to interpret them: - SALESFORCE:COMMUNICATION A communication error occurs between systems. - SALESFORCE:CONNECTIVITY A problem occurred and a connection could not be established. Review your Salesforce Connector configuration and reconnection strategy. - SALESFORCE:INSUFFICIENT\_PERMISSIONS The provided permissions are insufficient. - SALESFORCE:INVALID\_INPUT The provided input data for an operation is not valid. - SALESFORCE:INVALID\_RESPONSE The response from the server cannot be processed. - SALESFORCE:LIMIT\_EXCEEDED A specific limit is exceeded, for example, if you try to create more than 200 entities at once with the \*Create\* operation. - SALESFORCE:MUTUAL\_AUTHENTICATION\_FAILED The mutual authentication failed. - SALESFORCE:NOT\_FOUND The server could not find the requested resource. - SALESFORCE:OPERATION\_NOT\_SUPPORTED The operation is not supported. - SALESFORCE:RETRY\_EXHAUSTED The maximum number of retries for the operation is reached. - SALESFORCE:TIMEOUT A specific request takes longer than a configured amount of time to complete. - SALESFORCE:UNAVAILABLE The server is unavailable. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Connector Reference](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-reference) - [Salesforce Help](https://help.salesforce.com) - [Known Issues](https://help.salesforce.com/s/issues) --- product: Salesforce Connector version: 11.2 --- # Upgrading and Migrating Salesforce Connector to 11.x > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade Anypoint Connector for Salesforce (Salesforce Connector) from version 10.x to version 11.x. ## Supported Upgrade Paths
From VersionTo Version

10.x

11.2

## Changes ### 11.2 - Salesforce Connector now supports Salesforce API v64.0. ### 11.1 - Salesforce Connector now supports Salesforce API v62.0 and v63.0. ### 11.0 This release contains the following changes: - The **OAuth Client Credentials** connection type is added. - The **Subscribe Channel Listener** source is removed. Use the **Replay Channel Listener** source instead by using the `ONLY_NEW` replay option. - The **Subscribe Topic Listener** source is removed. Use the **Replay Topic Listener** source instead by using the `ONLY_NEW` replay option. - The deprecated **Query Result Stream** operation is removed. Use both of these operations instead: - The **Query Result List** operation to return a list of result IDs for a specific batch. - The **Query Result Stream by Id** operation to return an InputStream with the query results for a specific result ID of a submitted BatchInfo. ## Upgrade Prerequisites Before you perform the upgrade, you must: 1. Create a backup of your files, data, and configuration in case you need to restore to the previous version. 2. Install Salesforce Connector 11.x to replace the Salesforce operations that were previously included in Salesforce Connector 10.x. ## Upgrade Steps Follow these steps to perform the upgrade from Salesforce Connector v10.x to Salesforce Connector v11.x: 1. In Anypoint Studio, create a Mule project. 2. In the Mule Palette view, click **Search in Exchange**. 3. In the **Add Dependencies to Project** window, enter `Salesforce` in the search field. 4. In the **Available modules** section, select **Salesforce Connector - Mule 4** and click **Add**. 5. Click **Finish**. 6. Verify that the `salesforce-connector` dependency version is `11.x.x` in the `pom.xml` file, where `x.x` is the minor release and patch version number. For example, if you are upgrading to v11.0, the dependency version in the `pom.xml` file should be `11.0.0`. Studio upgrades the connector automatically. ## Verify the Upgrade After you install the latest version of the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Check the project `pom.xml` file and verify that there are no problems. 3. Test the connection and verify that the operations work. ## Troubleshooting If there are problems with caching the parameters and caching the metadata, try restarting Studio. ## Revert the Upgrade If it is necessary to revert to the previous version of Salesforce Connector, change the `salesforce-connector` dependency version in the project’s `pom.xml` file to the previous version. You must update the project’s `pom.xml` file in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.3 --- # Upgrading and Migrating Salesforce Connector to 11.x > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade Anypoint Connector for Salesforce (Salesforce Connector) from version 10.x to version 11.x. ## Supported Upgrade Paths
From VersionTo Version

10.x

11.3

## Changes ### 11.4 - Salesforce Connector now supports Salesforce API v66.0. ### 11.3 - Salesforce Connector now supports Salesforce API v65.0. ### 11.2 - Salesforce Connector now supports Salesforce API v64.0. ### 11.1 - Salesforce Connector now supports Salesforce API v62.0 and v63.0. ### 11.0 This release contains the following changes: - The **OAuth Client Credentials** connection type is added. - The **Subscribe Channel Listener** source is removed. Use the **Replay Channel Listener** source instead by using the `ONLY_NEW` replay option. - The **Subscribe Topic Listener** source is removed. Use the **Replay Topic Listener** source instead by using the `ONLY_NEW` replay option. - The deprecated **Query Result Stream** operation is removed. Use both of these operations instead: - The **Query Result List** operation to return a list of result IDs for a specific batch. - The **Query Result Stream by Id** operation to return an InputStream with the query results for a specific result ID of a submitted BatchInfo. ## Upgrade Prerequisites Before you perform the upgrade, you must: 1. Create a backup of your files, data, and configuration in case you need to restore to the previous version. 2. Install Salesforce Connector 11.x to replace the Salesforce operations that were previously included in Salesforce Connector 10.x. ## Upgrade Steps Follow these steps to perform the upgrade from Salesforce Connector v10.x to Salesforce Connector v11.x: 1. In Anypoint Studio, create a Mule project. 2. In the Mule Palette view, click **Search in Exchange**. 3. In the **Add Dependencies to Project** window, enter `Salesforce` in the search field. 4. In the **Available modules** section, select **Salesforce Connector - Mule 4** and click **Add**. 5. Click **Finish**. 6. Verify that the `salesforce-connector` dependency version is `11.x.x` in the `pom.xml` file, where `x.x` is the minor release and patch version number. For example, if you are upgrading to v11.0, the dependency version in the `pom.xml` file should be `11.0.0`. Studio upgrades the connector automatically. ## Verify the Upgrade After you install the latest version of the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Check the project `pom.xml` file and verify that there are no problems. 3. Test the connection and verify that the operations work. ## Troubleshooting If there are problems with caching the parameters and caching the metadata, try restarting Studio. ## Revert the Upgrade If it is necessary to revert to the previous version of Salesforce Connector, change the `salesforce-connector` dependency version in the project’s `pom.xml` file to the previous version. You must update the project’s `pom.xml` file in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.4 --- # Upgrading and Migrating Salesforce Connector to 11.x > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade Anypoint Connector for Salesforce (Salesforce Connector) from version 10.x to version 11.x. ## Supported Upgrade Paths
From VersionTo Version

10.x

11.4

## Changes ### 11.4 - Salesforce Connector now supports Salesforce API v66.0. ### 11.3 - Salesforce Connector now supports Salesforce API v65.0. ### 11.2 - Salesforce Connector now supports Salesforce API v64.0. ### 11.1 - Salesforce Connector now supports Salesforce API v62.0 and v63.0. ### 11.0 This release contains the following changes: - The **OAuth Client Credentials** connection type is added. - The **Subscribe Channel Listener** source is removed. Use the **Replay Channel Listener** source instead by using the `ONLY_NEW` replay option. - The **Subscribe Topic Listener** source is removed. Use the **Replay Topic Listener** source instead by using the `ONLY_NEW` replay option. - The deprecated **Query Result Stream** operation is removed. Use both of these operations instead: - The **Query Result List** operation to return a list of result IDs for a specific batch. - The **Query Result Stream by Id** operation to return an InputStream with the query results for a specific result ID of a submitted BatchInfo. ## Upgrade Prerequisites Before you perform the upgrade, you must: 1. Create a backup of your files, data, and configuration in case you need to restore to the previous version. 2. Install Salesforce Connector 11.x to replace the Salesforce operations that were previously included in Salesforce Connector 10.x. ## Upgrade Steps Follow these steps to perform the upgrade from Salesforce Connector v10.x to Salesforce Connector v11.x: 1. In Anypoint Studio, create a Mule project. 2. In the Mule Palette view, click **Search in Exchange**. 3. In the **Add Dependencies to Project** window, enter `Salesforce` in the search field. 4. In the **Available modules** section, select **Salesforce Connector - Mule 4** and click **Add**. 5. Click **Finish**. 6. Verify that the `salesforce-connector` dependency version is `11.x.x` in the `pom.xml` file, where `x.x` is the minor release and patch version number. For example, if you are upgrading to v11.0, the dependency version in the `pom.xml` file should be `11.0.0`. Studio upgrades the connector automatically. ## Verify the Upgrade After you install the latest version of the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Check the project `pom.xml` file and verify that there are no problems. 3. Test the connection and verify that the operations work. ## Troubleshooting If there are problems with caching the parameters and caching the metadata, try restarting Studio. ## Revert the Upgrade If it is necessary to revert to the previous version of Salesforce Connector, change the `salesforce-connector` dependency version in the project’s `pom.xml` file to the previous version. You must update the project’s `pom.xml` file in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.5 --- # Upgrading and Migrating Salesforce Connector to 11.x > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade Anypoint Connector for Salesforce (Salesforce Connector) from version 10.x to version 11.x. ## Supported Upgrade Paths
From VersionTo Version

10.x

11.5

## Changes ### 11.5 - Salesforce Connector now supports Salesforce API v67.0. ### 11.4 - Salesforce Connector now supports Salesforce API v66.0. ### 11.3 - Salesforce Connector now supports Salesforce API v65.0. ### 11.2 - Salesforce Connector now supports Salesforce API v64.0. ### 11.1 - Salesforce Connector now supports Salesforce API v62.0 and v63.0. ### 11.0 This release contains the following changes: - The **OAuth Client Credentials** connection type is added. - The **Subscribe Channel Listener** source is removed. Use the **Replay Channel Listener** source instead by using the `ONLY_NEW` replay option. - The **Subscribe Topic Listener** source is removed. Use the **Replay Topic Listener** source instead by using the `ONLY_NEW` replay option. - The deprecated **Query Result Stream** operation is removed. Use both of these operations instead: - The **Query Result List** operation to return a list of result IDs for a specific batch. - The **Query Result Stream by Id** operation to return an InputStream with the query results for a specific result ID of a submitted BatchInfo. ## Upgrade Prerequisites Before you perform the upgrade, you must: 1. Create a backup of your files, data, and configuration in case you need to restore to the previous version. 2. Install Salesforce Connector 11.x to replace the Salesforce operations that were previously included in Salesforce Connector 10.x. ## Upgrade Steps Follow these steps to perform the upgrade from Salesforce Connector v10.x to Salesforce Connector v11.x: 1. In Anypoint Studio, create a Mule project. 2. In the Mule Palette view, click **Search in Exchange**. 3. In the **Add Dependencies to Project** window, enter `Salesforce` in the search field. 4. In the **Available modules** section, select **Salesforce Connector - Mule 4** and click **Add**. 5. Click **Finish**. 6. Verify that the `salesforce-connector` dependency version is `11.x.x` in the `pom.xml` file, where `x.x` is the minor release and patch version number. For example, if you are upgrading to v11.0, the dependency version in the `pom.xml` file should be `11.0.0`. Studio upgrades the connector automatically. ## Verify the Upgrade After you install the latest version of the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Check the project `pom.xml` file and verify that there are no problems. 3. Test the connection and verify that the operations work. ## Troubleshooting If there are problems with caching the parameters and caching the metadata, try restarting Studio. ## Revert the Upgrade If it is necessary to revert to the previous version of Salesforce Connector, change the `salesforce-connector` dependency version in the project’s `pom.xml` file to the previous version. You must update the project’s `pom.xml` file in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 12.0 is-latest-version: true --- # Upgrading and Migrating Salesforce Connector to 12.x > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade Anypoint Connector for Salesforce (Salesforce Connector) from version 11.x to version 12.x. ## Supported Upgrade Paths
From VersionTo Version

11.x

12.x

## Changes ### 12.0 - This connector is now compatible with Java 17 only. - The **OAuth Username Password** connection type is removed because Salesforce is retiring the OAuth 2.0 Username-Password flow. Applications that use this connection type fail to deploy on 12.0.0. Migrate to another supported connection type, such as [OAuth 2.0](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-reference#sfdc-config_config-with-oauth), [OAuth Client Credentials](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-reference#sfdc-config_oauth-client-credentials), [OAuth JWT](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-reference#sfdc-config_jwt), or [OAuth SAML](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-reference#sfdc-config_saml). - The new **Query Time Buffer (Seconds)** field enables you to configure a polling time buffer (from `0` to `120` seconds) for source listeners to prevent missing records committed between polls for the **On New Object**, **On Modified Object**, and **On Deleted Object** sources. The query buffer time for the **On Modified Object** source now defaults to `0` seconds, instead of the former hardcoded default of `2` seconds. Applications that rely on the previous 2-second buffer must explicitly configure this value in the **Query Time Buffer (Seconds)** field. - The **On Modified Object** source now honors the read timeout configured in the connector configuration for internal `DescribeSObjects` calls. Previously, these calls defaulted to an infinite timeout (`readTimeout=0`), which caused connections to hang under certain network conditions. - These libraries are upgraded to address reported security vulnerabilities: - The Apache CXF library is upgraded to version 4.1.7. - The `jackson-core` and `jackson-databind` libraries are upgraded to version 2.21.5. - The `woodstox-core` library is upgraded to version 6.7.0. - The `httpclient` library is upgraded to version 4.5.14. - The `commons-codec` library is upgraded to version 1.22.0. - The `opencsv` library is upgraded to version 5.12.0. - The `jackson-annotations` library is upgraded to version 2.21. - The `gson` library is upgraded to version 2.12.0. - The `jaxws-rt` library is upgraded to version 2.3.7. - The `jetty` library is upgraded to version 12.1.10. - The `cometd-java` library is upgraded to version 8.0.7. ## Requirements Ensure your system meets the following compatibility requirements before you perform the upgrade:
Application/ServiceVersion

Mule runtime

4.9.0 and later

Java

17

Anypoint Studio

7.21 and later

## Upgrade Prerequisites Before you perform the upgrade, you must: 1. Create a backup of your files, data, and configuration in case you need to restore to the previous version. 2. Ensure that your environment meets the version 12.x requirements, including Java 17, Mule runtime 4.9.0 or later, and Anypoint Studio 7.21 or later. 3. If your app uses the **OAuth Username Password** connection type, migrate to the **OAuth Client Credentials**, **OAuth JWT**, **OAuth SAML**, or **OAuth 2.0** connection type, because the **OAuth Username Password** connection type is removed in version 12.x. 4. Install Salesforce Connector 12.x to replace the Salesforce operations that were previously included in Salesforce Connector 11.x. ## Upgrade Steps Follow these steps to perform the upgrade from Salesforce Connector v11.x to Salesforce Connector v12.x: 1. In Anypoint Studio, create a Mule project. 2. In the Mule Palette view, click **Search in Exchange**. 3. In the **Add Dependencies to Project** window, enter `Salesforce` in the search field. 4. In the **Available modules** section, select **Salesforce Connector - Mule 4** and click **Add**. 5. Click **Finish**. 6. Verify that the `salesforce-connector` dependency version is `12.x.x` in the `pom.xml` file, where `x.x` is the minor release and patch version number. For example, if you are upgrading to v12.0, the dependency version in the `pom.xml` file should be `12.0.0`. Studio upgrades the connector automatically. ## Verify the Upgrade After you install the latest version of the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Check the project `pom.xml` file and verify that there are no problems. 3. Test the connection and verify that the operations work. ## Troubleshooting If there are problems with caching the parameters and caching the metadata, try restarting Studio. ## Revert the Upgrade If it is necessary to revert to the previous version of Salesforce Connector, change the `salesforce-connector` dependency version in the project’s `pom.xml` file to the previous version. You must update the project’s `pom.xml` file in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.2 --- # Using Anypoint Studio to Configure Salesforce Connector 11.2 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure a source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element) 6. [Configure the other connector fields](#configure-other-fields). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Salesforce Reference](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-reference). ## 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 Salesforce 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 `salesforce` in the search field. 3. Click the connector name 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. A channel or topic must be published to Salesforce before a subscription to the channel can be created. You can configure one of these sources 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. - **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. > [!NOTE] A channel or topic must be published to Salesforce before a subscription to the channel > can be created. ### Example of Configuring a Source For example, to configure **On New Object** as a source: 1. In the **Mule Palette** view, select **On New Object**. 2. Drag **On New Object** to the Studio canvas. 3. In the On New Object properties window, specify a value for the **Path** field. 4. Optionally change the value of the **Display Name** field. 5. Select an object type and optionally specify a UTC value in the **Since** field. If the server is in a different time zone, you must specify a value in the **Since** field. If you leave the field empty, the connector uses the local timestamp. 6. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the **On New Object** source in the app. 7. In the **TLS** tab, optionally specify the TLS information for the connector. 8. In the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ### Redelivery Policy To configure a redelivery policy for a source, set the **Redelivery** field in the source’s properties window to the maximum number of redelivery attempts allowed after an initial failure. You can specify an object store for this policy. If you don’t specify an object store, Mule creates a nonpersistent object store. The number of transactions used to interact with the object store varies based on the number of retries configured for the redelivery policy. For more information about configuring a redelivery policy, see [Redelivery Policy](https://docs.mulesoft.com/mule-runtime/latest/redelivery-policy). ## 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 Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the 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 the connector uses to access the target Salesforce system. 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](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). To configure a global element for Salesforce 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. In the **General** tab, select one of these authentication methods for your connection: - [Basic authentication](#basic) - [OAuth 2.0 authentication](#oauth) - [OAuth JWT authentication](#oauth-jwt) - [OAuth Client Credentials authentication](#oauth-client-credentials) - [OAuth SAML authentication](#oauth-saml) - [OAuth Username Password authentication](#oauth-username-password) 4. In the **Apex** tab, optionally configure [Apex Settings](#apexsets). 5. In the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 6. Click **Test Connection** to confirm that Mule can connect with the specified server. 7. Click **OK**. ### Authentication For all OAuth connections, you can specify an object store that stores each resource owner’s ID data. If you don’t specify an object store, Mule automatically provisions the default object store. The app interacts with the object store automatically when a new resource owner is authenticated, the access token is refreshed, or the access token is invalidated. All authentication types support mutual TLS. To use mutual TLS, you need a keystore file and a password for the file. See [Generate a Keystore File](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-config-topics#generate-keystore) for more information. In Studio, when you configure the connector’s authentication method, specify the path to the keystore file and the TLS password on the **Security** tab. To set up a mutual TLS certificate in your Salesforce environment, see [Set Up a Mutual Authentication Certificate](https://help.salesforce.com/s/articleView?language=en_US&id=security_keys_uploading_mutual_auth_cert.htm&type=5). #### Basic Authentication Basic authentication uses a username and password for authentication. Important fields in the **General** tab include the following:
FieldDescription

Username

Salesforce username.

Password

Corresponding password.

Security token

Corresponding security token.

Callback path

Path for the callback, for example, /callback.

Authorization URL

Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, https://login.salesforce.com/services/Soap/u/64.0.

#### OAuth 2.0 Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). OAuth 2.0 delegates user authentication to the service hosting the user account. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Consumer secret

Password for the keystore.

Listener config

Configuration for the listener, for example, `HTTP_Listener_config.

Callback path

Path for the callback, for example, /callback.

Authorize path

Path for authorization, for example, /authorize.

External call back url

Callback URL, for example, http://localhost:8085/callback.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth JWT Authentication OAuth JWT uses OAuth 2.0 with a JSON Web Token (JWT) request for user authentication. Important fields in the **General tab** include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Key store

Path to the keystore that signs data during authentication. See Generate a Keystore File.

Store password

Password for the keystore.

Password

Corresponding password.

Certificate Alias

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

Principal

Username of the Salesforce user.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth Client Credentials Authentication OAuth Client Credentials uses a client ID and client secret for authentication. Important fields in the **General tab** include the following:
FieldDescription

Client id

The OAuth client ID as registered with the service provider.

Client secret

The OAuth client secret that corresponds to the client ID.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth SAML Authentication > [!NOTE] OAuth SAML currently uses only Salesforce as an identity provider. Refer to > [Salesforce as a SAML Identity Provider](https://help.salesforce.com/s/articleView?id=xcloud.sso_sfdc_idp_saml_parent.htm&type=5) > to enable Salesforce as an identity provider. OAuth SAML uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Key store

Path to the keystore that signs data during authentication. See Generate a Keystore File.

Store password

Password for the keystore.

Password

Corresponding password.

Certificate Alias

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

Principal

Username of the Salesforce user.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth Username Password Authentication OAuth Username Password authentication uses OAuth 2.0 with a user and password for authentication. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Consumer secret

Consumer secret for the connector to access Salesforce.

Username

Salesforce username.

Password

Corresponding password.

Security token

Corresponding security token.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

### Apex Settings Salesforce Connector gets the names of the Apex classes and the associated methods that can be invoked when you connect to Salesforce. To configure Apex settings in Studio: 1. Click the **Apex** tab in the global element properties screen. 2. Enter the following information:
FieldDescription

Fetch All Apex SOAP Metadata

Fetches the metadata of all the Apex SOAP classes. Takes precedence over Apex Class Name settings.

Fetch All Apex REST Metadata

Fetches the metadata of all the Apex REST classes. Takes precedence over Apex Class Name settings.

Apex Class Names

List of Apex class names to use for limiting the set of classes you fetch and the methods that they expose. This setting can accelerate the fetch process if you don’t need to fetch many classes. Valid values:

  • None

    No classes are specified for DataSense to acquire.

  • From a message

    Enables you to specify the class name using an expression.

  • Create object manually

    Enables you to create a list of class names for DataSense to acquire. DataSense acquires only those classes and their associated methods.

## Configure Additional Connector Fields After you configure a global element for Salesforce Connector, configure the other required fields for the connector. The following example shows four operations of the many you can configure for Salesforce Connector, as well as the important fields for these operations:
OperationDescription

Create

Adds one or more new records to your organization’s data. Important fields include:

  • Type

    Salesforce object type

  • Records

    Function editor expression

Query

Executes a query against the specified object and returns data that matches the specified criteria. Important fields include:

  • Salesforce query

    Salesforce query to retrieve objects

  • Parameters

    Values for placeholders in the Salesforce query

Update

Updates one or more existing records in your organization’s data. Important fields include:

  • Type

    Salesforce object type

  • Records

    Function editor expression that produces a collection of Salesforce objects to update

Delete

Deletes one or more records from your organization’s data. Important fields include:

  • Records To Delete IDs

    Function editor expression that produces a collection of Salesforce objects to delete

## 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 output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log 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/.log`. ## Next Step After completing Studio setup, see [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.2/salesforce-connector-config-topics). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.3 --- # Using Anypoint Studio to Configure Salesforce Connector 11.3 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure a source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element) 6. [Configure the other connector fields](#configure-other-fields). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Salesforce Reference](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-reference). ## 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 Salesforce 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 `salesforce` in the search field. 3. Click the connector name 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. A channel or topic must be published to Salesforce before a subscription to the channel can be created. You can configure one of these sources 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. - **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. > [!NOTE] A channel or topic must be published to Salesforce before a subscription to the channel > can be created. ### Example of Configuring a Source For example, to configure **On New Object** as a source: 1. In the **Mule Palette** view, select **On New Object**. 2. Drag **On New Object** to the Studio canvas. 3. In the On New Object properties window, specify a value for the **Path** field. 4. Optionally change the value of the **Display Name** field. 5. Select an object type and optionally specify a UTC value in the **Since** field. If the server is in a different time zone, you must specify a value in the **Since** field. If you leave the field empty, the connector uses the local timestamp. 6. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the **On New Object** source in the app. 7. In the **TLS** tab, optionally specify the TLS information for the connector. 8. In the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ### Redelivery Policy To configure a redelivery policy for a source, set the **Redelivery** field in the source’s properties window to the maximum number of redelivery attempts allowed after an initial failure. You can specify an object store for this policy. If you don’t specify an object store, Mule creates a nonpersistent object store. The number of transactions used to interact with the object store varies based on the number of retries configured for the redelivery policy. For more information about configuring a redelivery policy, see [Redelivery Policy](https://docs.mulesoft.com/mule-runtime/latest/redelivery-policy). ## 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 Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the 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 the connector uses to access the target Salesforce system. 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](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). To configure a global element for Salesforce 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. In the **General** tab, select one of these authentication methods for your connection: - [Basic authentication](#basic) - [OAuth 2.0 authentication](#oauth) - [OAuth JWT authentication](#oauth-jwt) - [OAuth Client Credentials authentication](#oauth-client-credentials) - [OAuth SAML authentication](#oauth-saml) - [OAuth Username Password authentication](#oauth-username-password) 4. In the **Apex** tab, optionally configure [Apex Settings](#apexsets). 5. In the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 6. Click **Test Connection** to confirm that Mule can connect with the specified server. 7. Click **OK**. ### Authentication For all OAuth connections, you can specify an object store that stores each resource owner’s ID data. If you don’t specify an object store, Mule automatically provisions the default object store. The app interacts with the object store automatically when a new resource owner is authenticated, the access token is refreshed, or the access token is invalidated. All authentication types support mutual TLS. To use mutual TLS, you need a keystore file and a password for the file. See [Generate a Keystore File](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-config-topics#generate-keystore) for more information. In Studio, when you configure the connector’s authentication method, specify the path to the keystore file and the TLS password on the **Security** tab. To set up a mutual TLS certificate in your Salesforce environment, see [Set Up a Mutual Authentication Certificate](https://help.salesforce.com/s/articleView?language=en_US&id=security_keys_uploading_mutual_auth_cert.htm&type=5). #### Basic Authentication Basic authentication uses a username and password for authentication. Important fields in the **General** tab include the following:
FieldDescription

Username

Salesforce username.

Password

Corresponding password.

Security token

Corresponding security token.

Callback path

Path for the callback, for example, /callback.

Authorization URL

Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, https://login.salesforce.com/services/Soap/u/65.0.

#### OAuth 2.0 Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). OAuth 2.0 delegates user authentication to the service hosting the user account. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Consumer secret

Password for the keystore.

Listener config

Configuration for the listener, for example, `HTTP_Listener_config.

Callback path

Path for the callback, for example, /callback.

Authorize path

Path for authorization, for example, /authorize.

External call back url

Callback URL, for example, http://localhost:8085/callback.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth JWT Authentication OAuth JWT uses OAuth 2.0 with a JSON Web Token (JWT) request for user authentication. Important fields in the **General tab** include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Key store

Path to the keystore that signs data during authentication. See Generate a Keystore File.

Store password

Password for the keystore.

Password

Corresponding password.

Certificate Alias

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

Principal

Username of the Salesforce user.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth Client Credentials Authentication OAuth Client Credentials uses a client ID and client secret for authentication. Important fields in the **General tab** include the following:
FieldDescription

Client id

The OAuth client ID as registered with the service provider.

Client secret

The OAuth client secret that corresponds to the client ID.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth SAML Authentication > [!NOTE] OAuth SAML currently uses only Salesforce as an identity provider. Refer to > [Salesforce as a SAML Identity Provider](https://help.salesforce.com/s/articleView?id=xcloud.sso_sfdc_idp_saml_parent.htm&type=5) > to enable Salesforce as an identity provider. OAuth SAML uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Key store

Path to the keystore that signs data during authentication. See Generate a Keystore File.

Store password

Password for the keystore.

Password

Corresponding password.

Certificate Alias

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

Principal

Username of the Salesforce user.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth Username Password Authentication OAuth Username Password authentication uses OAuth 2.0 with a user and password for authentication. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Consumer secret

Consumer secret for the connector to access Salesforce.

Username

Salesforce username.

Password

Corresponding password.

Security token

Corresponding security token.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

### Apex Settings Salesforce Connector gets the names of the Apex classes and the associated methods that can be invoked when you connect to Salesforce. To configure Apex settings in Studio: 1. Click the **Apex** tab in the global element properties screen. 2. Enter the following information:
FieldDescription

Fetch All Apex SOAP Metadata

Fetches the metadata of all the Apex SOAP classes. Takes precedence over Apex Class Name settings.

Fetch All Apex REST Metadata

Fetches the metadata of all the Apex REST classes. Takes precedence over Apex Class Name settings.

Apex Class Names

List of Apex class names to use for limiting the set of classes you fetch and the methods that they expose. This setting can accelerate the fetch process if you don’t need to fetch many classes. Valid values:

  • None

    No classes are specified for DataSense to acquire.

  • From a message

    Enables you to specify the class name using an expression.

  • Create object manually

    Enables you to create a list of class names for DataSense to acquire. DataSense acquires only those classes and their associated methods.

## Configure Additional Connector Fields After you configure a global element for Salesforce Connector, configure the other required fields for the connector. The following example shows four operations of the many you can configure for Salesforce Connector, as well as the important fields for these operations:
OperationDescription

Create

Adds one or more new records to your organization’s data. Important fields include:

  • Type

    Salesforce object type

  • Records

    Function editor expression

Query

Executes a query against the specified object and returns data that matches the specified criteria. Important fields include:

  • Salesforce query

    Salesforce query to retrieve objects

  • Parameters

    Values for placeholders in the Salesforce query

Update

Updates one or more existing records in your organization’s data. Important fields include:

  • Type

    Salesforce object type

  • Records

    Function editor expression that produces a collection of Salesforce objects to update

Delete

Deletes one or more records from your organization’s data. Important fields include:

  • Records To Delete IDs

    Function editor expression that produces a collection of Salesforce objects to delete

## 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 output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log 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/.log`. ## Next Step After completing Studio setup, see [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.3/salesforce-connector-config-topics). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.4 --- # Using Anypoint Studio to Configure Salesforce Connector 11.4 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure a source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element) 6. [Configure the other connector fields](#configure-other-fields). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Salesforce Reference](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-reference). ## 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 Salesforce 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 `salesforce` in the search field. 3. Click the connector name 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. A channel or topic must be published to Salesforce before a subscription to the channel can be created. You can configure one of these sources 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. - **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. > [!NOTE] A channel or topic must be published to Salesforce before a subscription to the channel > can be created. ### Example of Configuring a Source For example, to configure **On New Object** as a source: 1. In the **Mule Palette** view, select **On New Object**. 2. Drag **On New Object** to the Studio canvas. 3. In the On New Object properties window, specify a value for the **Path** field. 4. Optionally change the value of the **Display Name** field. 5. Select an object type and optionally specify a UTC value in the **Since** field. If the server is in a different time zone, you must specify a value in the **Since** field. If you leave the field empty, the connector uses the local timestamp. 6. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the **On New Object** source in the app. 7. In the **TLS** tab, optionally specify the TLS information for the connector. 8. In the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ### Redelivery Policy To configure a redelivery policy for a source, set the **Redelivery** field in the source’s properties window to the maximum number of redelivery attempts allowed after an initial failure. You can specify an object store for this policy. If you don’t specify an object store, Mule creates a nonpersistent object store. The number of transactions used to interact with the object store varies based on the number of retries configured for the redelivery policy. For more information about configuring a redelivery policy, see [Redelivery Policy](https://docs.mulesoft.com/mule-runtime/latest/redelivery-policy). ## 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 Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the 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 the connector uses to access the target Salesforce system. 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](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). To configure a global element for Salesforce 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. In the **General** tab, select one of these authentication methods for your connection: - [Basic authentication](#basic) - [OAuth 2.0 authentication](#oauth) - [OAuth JWT authentication](#oauth-jwt) - [OAuth Client Credentials authentication](#oauth-client-credentials) - [OAuth SAML authentication](#oauth-saml) - [OAuth Username Password authentication](#oauth-username-password) 4. In the **Apex** tab, optionally configure [Apex Settings](#apexsets). 5. In the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 6. Click **Test Connection** to confirm that Mule can connect with the specified server. 7. Click **OK**. ### Authentication For all OAuth connections, you can specify an object store that stores each resource owner’s ID data. If you don’t specify an object store, Mule automatically provisions the default object store. The app interacts with the object store automatically when a new resource owner is authenticated, the access token is refreshed, or the access token is invalidated. All authentication types support mutual TLS. To use mutual TLS, you need a keystore file and a password for the file. See [Generate a Keystore File](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-config-topics#generate-keystore) for more information. In Studio, when you configure the connector’s authentication method, specify the path to the keystore file and the TLS password on the **Security** tab. To set up a mutual TLS certificate in your Salesforce environment, see [Set Up a Mutual Authentication Certificate](https://help.salesforce.com/s/articleView?language=en_US&id=security_keys_uploading_mutual_auth_cert.htm&type=5). #### Basic Authentication Basic authentication uses a username and password for authentication. Important fields in the **General** tab include the following:
FieldDescription

Username

Salesforce username.

Password

Corresponding password.

Security token

Corresponding security token.

Callback path

Path for the callback, for example, /callback.

Authorization URL

Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, https://login.salesforce.com/services/Soap/u/66.0.

#### OAuth 2.0 Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). OAuth 2.0 delegates user authentication to the service hosting the user account. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Consumer secret

Password for the keystore.

Listener config

Configuration for the listener, for example, `HTTP_Listener_config.

Callback path

Path for the callback, for example, /callback.

Authorize path

Path for authorization, for example, /authorize.

External call back url

Callback URL, for example, http://localhost:8085/callback.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth JWT Authentication OAuth JWT uses OAuth 2.0 with a JSON Web Token (JWT) request for user authentication. Important fields in the **General tab** include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Key store

Path to the keystore that signs data during authentication. See Generate a Keystore File.

Store password

Password for the keystore.

Password

Corresponding password.

Certificate Alias

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

Principal

Username of the Salesforce user.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth Client Credentials Authentication OAuth Client Credentials uses a client ID and client secret for authentication. Important fields in the **General tab** include the following:
FieldDescription

Client id

The OAuth client ID as registered with the service provider.

Client secret

The OAuth client secret that corresponds to the client ID.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth SAML Authentication > [!NOTE] OAuth SAML currently uses only Salesforce as an identity provider. Refer to > [Salesforce as a SAML Identity Provider](https://help.salesforce.com/s/articleView?id=xcloud.sso_sfdc_idp_saml_parent.htm&type=5) > to enable Salesforce as an identity provider. OAuth SAML uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Key store

Path to the keystore that signs data during authentication. See Generate a Keystore File.

Store password

Password for the keystore.

Password

Corresponding password.

Certificate Alias

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

Principal

Username of the Salesforce user.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth Username Password Authentication OAuth Username Password authentication uses OAuth 2.0 with a user and password for authentication. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Consumer secret

Consumer secret for the connector to access Salesforce.

Username

Salesforce username.

Password

Corresponding password.

Security token

Corresponding security token.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

### Apex Settings Salesforce Connector gets the names of the Apex classes and the associated methods that can be invoked when you connect to Salesforce. To configure Apex settings in Studio: 1. Click the **Apex** tab in the global element properties screen. 2. Enter the following information:
FieldDescription

Fetch All Apex SOAP Metadata

Fetches the metadata of all the Apex SOAP classes. Takes precedence over Apex Class Name settings.

Fetch All Apex REST Metadata

Fetches the metadata of all the Apex REST classes. Takes precedence over Apex Class Name settings.

Apex Class Names

List of Apex class names to use for limiting the set of classes you fetch and the methods that they expose. This setting can accelerate the fetch process if you don’t need to fetch many classes. Valid values:

  • None

    No classes are specified for DataSense to acquire.

  • From a message

    Enables you to specify the class name using an expression.

  • Create object manually

    Enables you to create a list of class names for DataSense to acquire. DataSense acquires only those classes and their associated methods.

## Configure Additional Connector Fields After you configure a global element for Salesforce Connector, configure the other required fields for the connector. The following example shows four operations of the many you can configure for Salesforce Connector, as well as the important fields for these operations:
OperationDescription

Create

Adds one or more new records to your organization’s data. Important fields include:

  • Type

    Salesforce object type

  • Records

    Function editor expression

Query

Executes a query against the specified object and returns data that matches the specified criteria. Important fields include:

  • Salesforce query

    Salesforce query to retrieve objects

  • Parameters

    Values for placeholders in the Salesforce query

Update

Updates one or more existing records in your organization’s data. Important fields include:

  • Type

    Salesforce object type

  • Records

    Function editor expression that produces a collection of Salesforce objects to update

Delete

Deletes one or more records from your organization’s data. Important fields include:

  • Records To Delete IDs

    Function editor expression that produces a collection of Salesforce objects to delete

## 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 output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log 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/.log`. ## Next Step After completing Studio setup, see [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.4/salesforce-connector-config-topics). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 11.5 --- # Using Anypoint Studio to Configure Salesforce Connector 11.5 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure a source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element) 6. [Configure the other connector fields](#configure-other-fields). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Salesforce Reference](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-reference). ## 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 Salesforce 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 `salesforce` in the search field. 3. Click the connector name 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. A channel or topic must be published to Salesforce before a subscription to the channel can be created. You can configure one of these sources 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. - **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. > [!NOTE] A channel or topic must be published to Salesforce before a subscription to the channel > can be created. ### Example of Configuring a Source For example, to configure **On New Object** as a source: 1. In the **Mule Palette** view, select **On New Object**. 2. Drag **On New Object** to the Studio canvas. 3. In the On New Object properties window, specify a value for the **Path** field. 4. Optionally change the value of the **Display Name** field. 5. Select an object type and optionally specify a UTC value in the **Since** field. If the server is in a different time zone, you must specify a value in the **Since** field. If you leave the field empty, the connector uses the local timestamp. 6. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the **On New Object** source in the app. 7. In the **TLS** tab, optionally specify the TLS information for the connector. 8. In the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ### Redelivery Policy To configure a redelivery policy for a source, set the **Redelivery** field in the source’s properties window to the maximum number of redelivery attempts allowed after an initial failure. You can specify an object store for this policy. If you don’t specify an object store, Mule creates a nonpersistent object store. The number of transactions used to interact with the object store varies based on the number of retries configured for the redelivery policy. For more information about configuring a redelivery policy, see [Redelivery Policy](https://docs.mulesoft.com/mule-runtime/latest/redelivery-policy). ## 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 Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the 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 the connector uses to access the target Salesforce system. 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](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). To configure a global element for Salesforce 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. In the **General** tab, select one of these authentication methods for your connection: - [Basic authentication](#basic) - [OAuth 2.0 authentication](#oauth) - [OAuth JWT authentication](#oauth-jwt) - [OAuth Client Credentials authentication](#oauth-client-credentials) - [OAuth SAML authentication](#oauth-saml) - [OAuth Username Password authentication](#oauth-username-password) 4. In the **Apex** tab, optionally configure [Apex Settings](#apexsets). 5. In the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 6. Click **Test Connection** to confirm that Mule can connect with the specified server. 7. Click **OK**. ### Authentication For all OAuth connections, you can specify an object store that stores each resource owner’s ID data. If you don’t specify an object store, Mule automatically provisions the default object store. The app interacts with the object store automatically when a new resource owner is authenticated, the access token is refreshed, or the access token is invalidated. All authentication types support mutual TLS. To use mutual TLS, you need a keystore file and a password for the file. See [Generate a Keystore File](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-config-topics#generate-keystore) for more information. In Studio, when you configure the connector’s authentication method, specify the path to the keystore file and the TLS password on the **Security** tab. To set up a mutual TLS certificate in your Salesforce environment, see [Set Up a Mutual Authentication Certificate](https://help.salesforce.com/s/articleView?language=en_US&id=security_keys_uploading_mutual_auth_cert.htm&type=5). #### Basic Authentication Basic authentication uses a username and password for authentication. Important fields in the **General** tab include the following:
FieldDescription

Username

Salesforce username.

Password

Corresponding password.

Security token

Corresponding security token.

Callback path

Path for the callback, for example, /callback.

Authorization URL

Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, https://login.salesforce.com/services/Soap/u/67.0.

#### OAuth 2.0 Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). OAuth 2.0 delegates user authentication to the service hosting the user account. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Consumer secret

Password for the keystore.

Listener config

Configuration for the listener, for example, `HTTP_Listener_config.

Callback path

Path for the callback, for example, /callback.

Authorize path

Path for authorization, for example, /authorize.

External call back url

Callback URL, for example, http://localhost:8085/callback.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth JWT Authentication OAuth JWT uses OAuth 2.0 with a JSON Web Token (JWT) request for user authentication. Important fields in the **General tab** include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Key store

Path to the keystore that signs data during authentication. See Generate a Keystore File.

Store password

Password for the keystore.

Password

Corresponding password.

Certificate Alias

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

Principal

Username of the Salesforce user.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth Client Credentials Authentication OAuth Client Credentials uses a client ID and client secret for authentication. Important fields in the **General tab** include the following:
FieldDescription

Client id

The OAuth client ID as registered with the service provider.

Client secret

The OAuth client secret that corresponds to the client ID.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth SAML Authentication > [!NOTE] OAuth SAML currently uses only Salesforce as an identity provider. Refer to > [Salesforce as a SAML Identity Provider](https://help.salesforce.com/s/articleView?id=xcloud.sso_sfdc_idp_saml_parent.htm&type=5) > to enable Salesforce as an identity provider. OAuth SAML uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Key store

Path to the keystore that signs data during authentication. See Generate a Keystore File.

Store password

Password for the keystore.

Password

Corresponding password.

Certificate Alias

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

Principal

Username of the Salesforce user.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth Username Password Authentication OAuth Username Password authentication uses OAuth 2.0 with a user and password for authentication. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Consumer secret

Consumer secret for the connector to access Salesforce.

Username

Salesforce username.

Password

Corresponding password.

Security token

Corresponding security token.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

### Apex Settings Salesforce Connector gets the names of the Apex classes and the associated methods that can be invoked when you connect to Salesforce. To configure Apex settings in Studio: 1. Click the **Apex** tab in the global element properties screen. 2. Enter the following information:
FieldDescription

Fetch All Apex SOAP Metadata

Fetches the metadata of all the Apex SOAP classes. Takes precedence over Apex Class Name settings.

Fetch All Apex REST Metadata

Fetches the metadata of all the Apex REST classes. Takes precedence over Apex Class Name settings.

Apex Class Names

List of Apex class names to use for limiting the set of classes you fetch and the methods that they expose. This setting can accelerate the fetch process if you don’t need to fetch many classes. Valid values:

  • None

    No classes are specified for DataSense to acquire.

  • From a message

    Enables you to specify the class name using an expression.

  • Create object manually

    Enables you to create a list of class names for DataSense to acquire. DataSense acquires only those classes and their associated methods.

## Configure Additional Connector Fields After you configure a global element for Salesforce Connector, configure the other required fields for the connector. The following example shows four operations of the many you can configure for Salesforce Connector, as well as the important fields for these operations:
OperationDescription

Create

Adds one or more new records to your organization’s data. Important fields include:

  • Type

    Salesforce object type

  • Records

    Function editor expression

Query

Executes a query against the specified object and returns data that matches the specified criteria. Important fields include:

  • Salesforce query

    Salesforce query to retrieve objects

  • Parameters

    Values for placeholders in the Salesforce query

Update

Updates one or more existing records in your organization’s data. Important fields include:

  • Type

    Salesforce object type

  • Records

    Function editor expression that produces a collection of Salesforce objects to update

Delete

Deletes one or more records from your organization’s data. Important fields include:

  • Records To Delete IDs

    Function editor expression that produces a collection of Salesforce objects to delete

## 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 output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log 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/.log`. ## Next Step After completing Studio setup, see [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/11.5/salesforce-connector-config-topics). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Connector version: 12.0 is-latest-version: true --- # Using Anypoint Studio to Configure Salesforce Connector 12.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure a source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element) 6. [Configure the other connector fields](#configure-other-fields). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Salesforce Reference](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-reference). ## 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 Salesforce 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 `salesforce` in the search field. 3. Click the connector name 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. A channel or topic must be published to Salesforce before a subscription to the channel can be created. You can configure one of these sources 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. - **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. > [!NOTE] A channel or topic must be published to Salesforce before a subscription to the channel > can be created. ### Example of Configuring a Source For example, to configure **On New Object** as a source: 1. In the **Mule Palette** view, select **On New Object**. 2. Drag **On New Object** to the Studio canvas. 3. In the On New Object properties window, specify a value for the **Path** field. 4. Optionally change the value of the **Display Name** field. 5. Select an object type and optionally specify a UTC value in the **Since** field. If the server is in a different time zone, you must specify a value in the **Since** field. If you leave the field empty, the connector uses the local timestamp. 6. Optionally specify a value in the **Query Time Buffer (Seconds)** field to subtract that number of seconds from the current time when querying for changes. This prevents data loss caused by records committed after the query timestamp but before the next poll. The value must be between `0` and `120` seconds and defaults to `0`. 7. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the **On New Object** source in the app. 8. In the **TLS** tab, optionally specify the TLS information for the connector. 9. In the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 10. Click **Test Connection** to confirm that Mule can connect with the specified server. 11. Click **OK**. ### Redelivery Policy To configure a redelivery policy for a source, set the **Redelivery** field in the source’s properties window to the maximum number of redelivery attempts allowed after an initial failure. You can specify an object store for this policy. If you don’t specify an object store, Mule creates a nonpersistent object store. The number of transactions used to interact with the object store varies based on the number of retries configured for the redelivery policy. For more information about configuring a redelivery policy, see [Redelivery Policy](https://docs.mulesoft.com/mule-runtime/latest/redelivery-policy). ## 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 Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the 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 the connector uses to access the target Salesforce system. 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](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). To configure a global element for Salesforce 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. In the **General** tab, select one of these authentication methods for your connection: - [Basic authentication](#basic) - [OAuth 2.0 authentication](#oauth) - [OAuth JWT authentication](#oauth-jwt) - [OAuth Client Credentials authentication](#oauth-client-credentials) - [OAuth SAML authentication](#oauth-saml) 4. In the **Apex** tab, optionally configure [Apex Settings](#apexsets). 5. In the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 6. Click **Test Connection** to confirm that Mule can connect with the specified server. 7. Click **OK**. ### Authentication For all OAuth connections, you can specify an object store that stores each resource owner’s ID data. If you don’t specify an object store, Mule automatically provisions the default object store. The app interacts with the object store automatically when a new resource owner is authenticated, the access token is refreshed, or the access token is invalidated. All authentication types support mutual TLS. To use mutual TLS, you need a keystore file and a password for the file. See [Generate a Keystore File](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-config-topics#generate-keystore) for more information. In Studio, when you configure the connector’s authentication method, specify the path to the keystore file and the TLS password on the **Security** tab. To set up a mutual TLS certificate in your Salesforce environment, see [Set Up a Mutual Authentication Certificate](https://help.salesforce.com/s/articleView?language=en_US&id=security_keys_uploading_mutual_auth_cert.htm&type=5). #### Basic Authentication Basic authentication uses a username and password for authentication. Important fields in the **General** tab include the following:
FieldDescription

Username

Salesforce username.

Password

Corresponding password.

Security token

Corresponding security token.

Callback path

Path for the callback, for example, /callback.

Authorization URL

Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, https://login.salesforce.com/services/Soap/u/67.0.

#### OAuth 2.0 Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). OAuth 2.0 delegates user authentication to the service hosting the user account. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Consumer secret

Password for the keystore.

Listener config

Configuration for the listener, for example, `HTTP_Listener_config.

Callback path

Path for the callback, for example, /callback.

Authorize path

Path for authorization, for example, /authorize.

External call back url

Callback URL, for example, http://localhost:8085/callback.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth JWT Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). OAuth JWT uses OAuth 2.0 with a JSON Web Token (JWT) request for user authentication. > [!NOTE] When configuring a Salesforce external client app for OAuth JWT authentication, disable > **Issue JSON Web Token (JWT)-based access tokens for named users** so that Salesforce returns an > opaque access token instead of a JWT-formatted access token. Important fields in the **General tab** include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Key store

Path to the keystore that signs data during authentication. See Generate a Keystore File.

Store password

Password for the keystore.

Password

Corresponding password.

Certificate Alias

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

Principal

Username of the Salesforce user.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth Client Credentials Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). OAuth Client Credentials uses a client ID and client secret for authentication. Important fields in the **General tab** include the following:
FieldDescription

Client id

The OAuth client ID as registered with the service provider.

Client secret

The OAuth client secret that corresponds to the client ID.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

#### OAuth SAML Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). > [!NOTE] OAuth SAML currently uses only Salesforce as an identity provider. Refer to > [Salesforce as a SAML Identity Provider](https://help.salesforce.com/s/articleView?id=xcloud.sso_sfdc_idp_saml_parent.htm&type=5) > to enable Salesforce as an identity provider. OAuth SAML uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token. Important fields in the **General** tab include the following:
FieldDescription

Consumer key

Consumer key for the Salesforce-connected app. For information about generating a consumer key, refer to the Salesforce documentation.

Key store

Path to the keystore that signs data during authentication. See Generate a Keystore File.

Store password

Password for the keystore.

Password

Corresponding password.

Certificate Alias

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

Principal

Username of the Salesforce user.

Important fields in the **Advanced** tab include the following:
FieldDescription

Api version

API version used. Defaults to the latest API version supported by the connector.

### Apex Settings Salesforce Connector gets the names of the Apex classes and the associated methods that can be invoked when you connect to Salesforce. To configure Apex settings in Studio: 1. Click the **Apex** tab in the global element properties screen. 2. Enter the following information:
FieldDescription

Fetch All Apex SOAP Metadata

Fetches the metadata of all the Apex SOAP classes. Takes precedence over Apex Class Name settings.

Fetch All Apex REST Metadata

Fetches the metadata of all the Apex REST classes. Takes precedence over Apex Class Name settings.

Apex Class Names

List of Apex class names to use for limiting the set of classes you fetch and the methods that they expose. This setting can accelerate the fetch process if you don’t need to fetch many classes. Valid values:

  • None

    No classes are specified for DataSense to acquire.

  • From a message

    Enables you to specify the class name using an expression.

  • Create object manually

    Enables you to create a list of class names for DataSense to acquire. DataSense acquires only those classes and their associated methods.

## Configure Additional Connector Fields After you configure a global element for Salesforce Connector, configure the other required fields for the connector. The following example shows four operations of the many you can configure for Salesforce Connector, as well as the important fields for these operations:
OperationDescription

Create

Adds one or more new records to your organization’s data. Important fields include:

  • Type

    Salesforce object type

  • Records

    Function editor expression

Query

Executes a query against the specified object and returns data that matches the specified criteria. Important fields include:

  • Salesforce query

    Salesforce query to retrieve objects

  • Parameters

    Values for placeholders in the Salesforce query

Update

Updates one or more existing records in your organization’s data. Important fields include:

  • Type

    Salesforce object type

  • Records

    Function editor expression that produces a collection of Salesforce objects to update

Delete

Deletes one or more records from your organization’s data. Important fields include:

  • Records To Delete IDs

    Function editor expression that produces a collection of Salesforce objects to delete

## 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 output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log 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/.log`. ## Next Step After completing Studio setup, see [Additional Configuration Information](https://docs.mulesoft.com/salesforce-connector/latest/salesforce-connector-config-topics). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com)