# mulesoft Salesforce Data Cloud Connector - Full Documentation --- product: Salesforce Data Cloud Connector version: 1.3 --- # Salesforce Data Cloud 1.3 - Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Configure Anypoint Connector for Salesforce Data Cloud (Salesforce Data Cloud Connector) to generate an OAuth 2.0 keystore file. ## Generate a Keystore File Salesforce Data Cloud Connector uses the Bouncy Castle cryptographic library to load the certificate from the keystore and sign the payload for the authentication requests. The Bouncy Castle 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, so do not use BKS-V1 keystore files, as documented in the [Bouncy Castle proposed solution](https://www.kb.cert.org/vuls/id/306792). By default, Salesforce Data Cloud Connector uses JKS or PKCS12 keystores. To generate a JKS keystore file: 1. Go to your Mule workspace and open the terminal or shell application for your operating system. 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. ## Next Step After you complete configuring the connector, you can try the [Examples](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/salesforce-data-cloud-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 Data Cloud Connector version: 1.3 --- # Salesforce Data Cloud Connector 1.3 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Data Cloud (Salesforce Data Cloud Connector) provides a quick and easy way to integrate with Salesforce Data Cloud API endpoints. You can automate data ingestion from third parties, query the Data Cloud Data Lake, search and query customer profile information and calculated insights, and consume data action events to enrich the 360-degree view of the customers in your Data Cloud instance. 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 information about compatibility and fixed issues, refer to the Salesforce Data Cloud Connector release notes. ## Before You Begin To use this connector, you must be familiar with: - [The Salesforce Data Cloud Ingestion API](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-started.html) - [Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Mule runtime engine](https://docs.mulesoft.com/mule-runtime/latest/) (Mule) - [Elements and global elements](https://docs.mulesoft.com/mule-runtime/latest/global-elements) in a Mule flow - [How to create a Mule app using Anypoint Studio](https://docs.mulesoft.com/mule-runtime/latest/mule-app-dev) Before creating an app, you must have: - [Set up the Ingestion API](#set-up-the-ingestion-api) - Credentials to access the Salesforce Data Cloud target resource - Anypoint Platform - Anypoint Studio version 7.11.x or later ## Set Up the Ingestion API To use Salesforce Data Cloud Connector, you must first set up the Ingestion API. For more information, refer to [Connect MuleSoft with Data Cloud](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/). After setting up the Ingestion API, refer to [Next Step](#next-step) to configure your connector. ## Common Use Cases For the Connector These are some common use cases for Salesforce Data Cloud Connector: - Stream data via insert and delete object endpoints of the Ingestion API Connector - Create a bulk job, upload job data, close or abort a job, get a job status, retrieve all bulk jobs, and delete a job as part of the Bulk Ingestion interaction pattern of the Ingestion API Connector - Query Data Cloud objects - Query Salesforce Data Cloud data lake across data model, lake, unified, and linked objects - Query calculated insights with selected dimensions, selected measures, and optional filters - Look up and search customer profile information - Create webhooks as data action targets for data actions in Data Cloud For examples, see [Salesforce Data Cloud Connector Examples](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/salesforce-data-cloud-connector-examples) use cases. ## Connection Types Salesforce Data Cloud connections use the following authentication types: - OAuth Client Credentials Uses OAuth 2.0 with a token endpoint for authentication - OAuth JWT Uses OAuth 2.0 with a JSON Web token (JWT) request for authentication - OAuth Username Password Uses OAuth 2.0 with a username and password for authentication For information about configuring authentication types, see [Using Anypoint Studio to Configure Salesforce Data Cloud Connector](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/salesforce-data-cloud-connector-studio). ## Next Step After you complete the prerequisites, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/salesforce-data-cloud-connector-studio). ## See Also - [Salesforce Data Cloud](https://help.salesforce.com/s/articleView?id=data.c360_a_customer360_lm.htm&type=5) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Data Cloud Connector Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/salesforce-data-cloud-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.3 --- # Salesforce Data Cloud Connector 1.3 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio: - If you manually code a Mule runtime engine (Mule) app in XML either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/sdc http://www.mulesoft.org/schema/mule/sdc/current/mule-sdc.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint 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 mule4-sdc-connector x.x.x mule-plugin ``` Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `salesforce data cloud`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/salesforce-data-cloud-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 Data Cloud Connector version: 1.3 --- # Salesforce Data Cloud Connector 1.3 Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following examples show how to integrate with the various Salesforce Data Cloud API endpoints with Salesforce Data Cloud Connector: - Streaming API Ingestion Flows include: - [Insert Data - Streaming API](#insert-data-streaming-api) Shows how to insert data via the streaming API to an object’s endpoint. - [Delete Data - Streaming API](#delete-data-streaming-api) Shows how to delete records via the streaming API for specific objects. - Bulk API Ingestion Flows include: - [Create Job - Bulk API](#create-job-bulk-api) Shows how to create a bulk job, which is needed for uploading data to Salesforce Data Cloud Ingestion API objects. - [Upload Job Data - Bulk API](#upload-job-data-bulk-api) Shows how to upload data for inserting to or deleting from a Salesforce Data Cloud Ingestion API object. - [Close Job - Bulk API](#close-job-bulk-api) Shows how to update the status of the specified job ID so that the job is closed and queued for processing. - [Abort Job - Bulk API](#abort-job-bulk-api) Shows how to update the status of the specified job ID so that the job is aborted and not queued for processing. - [Get Job - Bulk API](#get-job-bulk-api) Shows how to retrieve current status of the specified job ID. - [List Jobs - Bulk API](#list-jobs-bulk-api) Shows how to retrieve all bulk jobs. - [Delete Job - Bulk API](#delete-job-bulk-api) Shows how to delete or close the specified job ID, which deletes job data and metadata stored by Salesforce. - Query API Flows include: - [Query API](#query-api) Shows how to query the Salesforce Data Cloud data lake across data model, lake, unified, and linked objects. - [Query v2](#query-v2) Shows how to use the Query v2 API to make a query against the Data Cloud data lake. - [Query v2 - Get Next Batch](#query-v2-get-next-batch) Shows how to use the Query v2 Get Next Batch API to get the next batch of results. - Calculated Insights API Flows include: - [Insights - List Metadata API](#insights-list-metadata-api) Shows how to retrieve the metadata, including the dimensions and measures for all calculated insights. - [Insights - Get Metadata API](#insights-get-metadata-api) Shows how to retrieve the metadata, including the dimensions and measures for a calculated insight. - [Insights - Get Insights API](#insights-get-insights-api) Shows how to query the calculated insights. Users can slice, dice, and filter by selecting different dimensions, measures, and filters. - Profile API Flows include: - [Profile - List Metadata API](#profile-list-metadata-api) Shows how to retrieve the metadata for all data model objects. - [Profile - Get Metadata API](#profile-get-metadata-api) Shows how to retrieve the metadata for the requested data model object. - [Profile - Search Records API](#profile-search-records-api) Shows how to retrieve data model object records based on search filters. - [Profile - Search Records By ID API](#profile-search-records-by-id-api) Shows how to retrieve data model object records based on indexes and search filters. - [Profile - Search Records With Child Records API](#profile-search-records-with-child-records-api) Shows how to retrieve data model object records and child object records based on indexes and search filters. - [Profile - Search Records With Insight API](#profile-search-records-with-insight-api) Shows how to retrieve data model object records and a computed view based on indexes and search filters. - Data Action API Flows include: - [Data Action Webhook](#data-action-webhook) Shows how to run operations when a data action is triggered. ## Insert Data - Streaming API This Mule flow shows how to insert data via the streaming API to an object’s endpoint. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-insert-records.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the source and object name as the URI parameters. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Insert Objects** operation. - **Streaming Insert** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the source name, object name, and payload. - Calls the Salesforce API to insert the payload to that object’s endpoint. ![Salesforce Data Cloud Insert flow with Listener, Logger, Insert Objects, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/object-insert-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `POST` to `localhost:8081/{SOURCE_API_NAME}/{OBJECT_NAME}` with a JSON payload that matches your object’s schema, for example: ```json { "data": [ { "your_object_field_1": "value_1", "your_object_field_2": "value_2", "your_object_field_3": "value_3" } ] } ``` ## Query API This Mule flow shows how to query data from Data Cloud using a custom SOQL query. Refer to the [Salesforce SOQL docs](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the query in the payload. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Query** operation. - **Query** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the earlier SOQL query. - Calls the Salesforce API with the query and receives the result. ![Salesforce Data Cloud Query flow with Listener, Logger, Query, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/query-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `POST` to `localhost:8081/query` with SOQL query in the request body, for example: ```json { "sql": "SELECT ID FROM ACCOUNT LIMIT 1" } ``` ## Query v2 This Mule flow shows how to send an initial query. Use this flow before [Query v2 - Get Next Batch](#query-v2-get-next-batch). For more information about the Query v2 API, refer to the [Data Cloud Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-query-v2.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the query in the payload. - **Logger** Shows the HTTP request received from the **Listener**. - **Set Variable** Sets a variable called `sampleResults` to get a maximum sample of 10 results. Your paging calls are unaffected and this is to limit returned payloads to avoid having 40 MB large payloads on your testing calls. - **Query v2** Makes a query against the Data Cloud data lake. - **Flow Reference** Makes a reference to the [Query v2 - Get Next Batch](#query-v2-get-next-batch) flow. ![Salesforce Data Cloud Query v2 flow with Listener, Logger, Set Variable, Query v2, and Flow Reference](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/query-v2-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a request, for example: curl --location 'http://127.0.0.1:8081/queryv2' \\ --header 'Content-Type: application/json' \\ --data '{"sql": "SELECT assigned\_to\_uid\_\_c, campaign\_name\_\_c, cdp\_sys\_PartitionDate\_\_c, coupon\_code\_\_c, currency\_\_c, DataSource\_\_c, DataSourceObject\_\_c, expiry\_date\_\_c, sent\_\_c, value\_\_c FROM MunitQueryV2Test\_coupons\_C7876AA7\_\_dll "}' This example request returns this example response, in which you can use `nextBatchId` to get the next set of results if any are present in the [Query v2 - Get Next Batch](#query-v2-get-next-batch): { "data": \[ \[ "TorBsKqi", "kvoEyIhx", "2022-08-22 00:00:00.000 UTC", "pxMEsTAR", "GJWzpgut", "MunitQueryV2Test\_b1ed190e\_fd18\_49ce\_8813\_f2f4ad59df50", "MunitQueryV2Test\_coupons\_C7876AA7", "2022-08-22 18:28:58.905 UTC", "RkXmYcdH", "87.000000000000000000" \], \[...\] \], "startTime": "2023-03-30T15:51:44.33103Z", "endTime": "2023-03-30T15:51:46.065576Z", "rowCount": 63803, "queryId": "20230330\_155144\_13391\_5rx4m", "nextBatchId": "1449c1d1-2bf2-471d-824f-62c8f18c5c26", "done": false, "metadata": { "value\_\_c": { "type": "DECIMAL", "placeInOrder": 9, "typeCode": 3 }, "sent\_\_c": { "type": "VARCHAR", "placeInOrder": 8, "typeCode": 12 }, "assigned\_to\_uid\_\_c": { "type": "VARCHAR", "placeInOrder": 0, "typeCode": 12 }, "currency\_\_c": { "type": "VARCHAR", "placeInOrder": 4, "typeCode": 12 }, "DataSource\_\_c": { "type": "VARCHAR", "placeInOrder": 5, "typeCode": 12 }, "campaign\_name\_\_c": { "type": "VARCHAR", "placeInOrder": 1, "typeCode": 12 }, "DataSourceObject\_\_c": { "type": "VARCHAR", "placeInOrder": 6, "typeCode": 12 }, "coupon\_code\_\_c": { "type": "VARCHAR", "placeInOrder": 3, "typeCode": 12 }, "expiry\_date\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 7, "typeCode": 2014 }, "cdp\_sys\_PartitionDate\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 2, "typeCode": 2014 } } } ## Query v2 - Get Next Batch This Mule flow shows how to page through the results using the `nextBatchId` forward only cursor for Salesforce Data Cloud. Use this flow after [Query v2](#query-v2). For more information about the Query v2 Get Next Batch API, refer to the [Data Cloud Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-get-query-v2.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the query in the payload. - **Logger** Shows the HTTP request received from the **Listener**. - **Set Variable** Sets a variable called `sampleResults` to get a maximum sample of 10 results. Your paging calls are unaffected and this is to limit returned payloads to avoid having 40 MB large payloads on your testing calls. - **Query v2 - Get Next Batch** Uses a forward cursor to get more results from the [Query v2](#query-v2) and [Query v2 - Get Next Batch](#query-v2-get-next-batch) flows using `nextBatchId`. - **Flow Reference** Makes a reference to the [Query v2](#query-v2) flow. ![Salesforce Data Cloud Query v2 Get Next Batch flow with Listener, Logger, Set Variable, Query v2 Get Next Batch, and Flow Reference](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/query-v2-get-next-batch.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a request, for example: curl --location 'http://127.0.0.1:8081/queryv2?nextBatchId=3e2f0036-f75b-4ee9-a29b-35d8f914e2f1' This example request returns this example response: { "data": \[ \[ "TorBsKqi", "kvoEyIhx", "2022-08-22 00:00:00.000 UTC", "pxMEsTAR", "GJWzpgut", "MunitQueryV2Test\_b1ed190e\_fd18\_49ce\_8813\_f2f4ad59df50", "MunitQueryV2Test\_coupons\_C7876AA7", "2022-08-22 18:28:58.905 UTC", "RkXmYcdH", "87.000000000000000000" \], \[...\] \], "startTime": "2023-03-30T15:51:44.33103Z", "endTime": "2023-03-30T15:51:46.065576Z", "rowCount": 63803, "queryId": "20230330\_155144\_13391\_5rx4m", "nextBatchId": "1449c1d1-2bf2-471d-824f-62c8f18c5c26", "done": false, "metadata": { "value\_\_c": { "type": "DECIMAL", "placeInOrder": 9, "typeCode": 3 }, "sent\_\_c": { "type": "VARCHAR", "placeInOrder": 8, "typeCode": 12 }, "assigned\_to\_uid\_\_c": { "type": "VARCHAR", "placeInOrder": 0, "typeCode": 12 }, "currency\_\_c": { "type": "VARCHAR", "placeInOrder": 4, "typeCode": 12 }, "DataSource\_\_c": { "type": "VARCHAR", "placeInOrder": 5, "typeCode": 12 }, "campaign\_name\_\_c": { "type": "VARCHAR", "placeInOrder": 1, "typeCode": 12 }, "DataSourceObject\_\_c": { "type": "VARCHAR", "placeInOrder": 6, "typeCode": 12 }, "coupon\_code\_\_c": { "type": "VARCHAR", "placeInOrder": 3, "typeCode": 12 }, "expiry\_date\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 7, "typeCode": 2014 }, "cdp\_sys\_PartitionDate\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 2, "typeCode": 2014 } } } ## Delete Data - Streaming API This Mule flow shows how to delete data via the streaming API using an object’s endpoint. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-delete-records.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP DELETE requests with the source api and object name as URI parameters and record IDs as query parameters. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Streaming Delete** operation. - **Streaming Delete** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the source api name, object name, and record IDs. - Calls the Salesforce API to delete the records from the query parameters using that object’s endpoint. ![Salesforce Data Cloud Delete flow with Listener, Logger, Delete Objects, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/delete-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `DELETE` to `localhost:8081/delete/{SOURCE_API_NAME}/{OBJECT_NAME}?ids={RECORD_ID1},{RECORD_ID2}`, for example: `localhost:8081/delete/My_SourceApi/My_Object?ids=1,2,3` ## Create Job - Bulk API This Mule flow shows how to create a bulk job, which uploads data to a Salesforce Data Cloud Ingestion API object. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-create-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the source api and object name as URI parameters and record IDs as query parameters. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Create Job** operation. - Create Job: - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the source api name, object name, and job operation. You can find the job operations in the [Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/salesforce-data-cloud-connector-reference) page. - Calls the Salesforce API to create the job and returns the response. ![Salesforce Data Cloud Create Job flow with Listener, Create Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/create-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `POST` to `localhost:8081/jobs/create/{SOURCE_API_NAME}/{OBJECT_NAME}/{OPERATION}`. ## Upload Job Data - Bulk API This Mule flow shows how to upload data for inserting to or deleting from a Salesforce Data Cloud Ingestion API object specified by the job ID. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-upload-job-data.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the job ID in the URI. - **CSV Reader** Reads data from the CSV that is configured in the absolute file path. - **Set Payload** Updates the payload with the CSV data for **Upload Job Data**. - **Upload Job Data** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID from the HTTP request and CSV data that is now in the payload. - Uploads data from the CSV to the Salesforce Data Cloud Ingestion API object, and eventually returns an HTTP response. - **Logger** Shows the HTTP result from the **Upload Job Data** operation. ![Salesforce Data Cloud Upload Job flow with Listener, Read, Set Payload, Upload Job Data, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/upload-job-data-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Enter a valid absolute file path to a CSV in the CSV Reader’s **File Path** attribute. 3. Save the project. 4. [Create a job](#create-job-bulk-api) and copy its job ID. 5. Test the flow by sending a `POST` to `localhost:8081/jobs/upload/{JOB_ID}` using the job ID you copied earlier. ## Close Job - Bulk API This Mule flow shows how to update the status of the specified job ID so that the job is closed. After a job is closed, it is queued for processing [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-close-or-abort-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the job ID as a URI parameter. - **Logger** Shows the HTTP response from the **Close Job** operation. - **Close Job** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the specified job ID. - Calls the Salesforce API with the `UploadComplete` state, which completes that job and subsequently receives an HTTP response. ![Salesforce Data Cloud Close Job flow with Listener, Close Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/close-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Create a job and copy the resulting job ID. 4. Test the flow by sending a `GET` to `localhost:8081/jobs/close/{JOB_ID}` with the job ID you copied earlier. ## Abort Job - Bulk API This Mule flow shows how to update the status of the specified job ID so that the job is aborted. After a job is aborted, it will not be queued for processing [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-close-or-abort-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the job ID as a URI parameter. - **Logger** Shows the HTTP response from the **Abort Job** operation. - **Abort Job**: - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID that was used as the URI parameter. - Calls the Salesforce API with the aborted state, aborts that job, and then receives an HTTP response. ![Salesforce Data Cloud Abort Job flow with Listener, Abort Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/abort-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api) and copy the resulting job ID. 4. Test the flow by sending a `GET` to `localhost:8081/jobs/abort/{JOB_ID}` with the job ID that you previously copied. ## Get Job - Bulk API This Mule flow shows how to retrieve the current status of the specified job ID. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-job-info.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the job ID included in the URI parameters. - **Logger** Shows the HTTP response from the **Get Job** operation. - **Get Job** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID from the URI parameters. - Calls the Salesforce API and returns the job status. ![Salesforce Data Cloud Get Job flow with Listener, Get Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/get-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api) and copy the resulting job ID. 4. Test the flow by sending a `GET` to `localhost:8081/jobs/get/{JOB_ID}`, using the job ID you copied earlier. ## List Jobs - Bulk API This Mule flow shows how to retrieve all bulk jobs. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-all-jobs.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with all jobs included in the URI parameters. - **Logger** Shows the HTTP response from the **List Jobs** operation. - **List Jobs** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives all jobs from the URI parameters. - Calls the Salesforce API and returns the job status. ![Salesforce Data Cloud List Jobs flow with Listener, List Jobs, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/list-jobs-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api). 4. Test the flow by sending a `GET` to `localhost:8081/jobs/get/`. ## Delete Job - Bulk API This Mule flow shows how to delete or close the specified job ID, which deletes job data and metadata that is stored by Salesforce. In order to delete a job, a job must have a state of `UploadComplete`, `JobComplete`, `Aborted`, or `Failed`. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-delete-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP DELETE requests with the job ID included in the URI parameters. - **Logger** Shows the HTTP response from the **Delete Job** operation. - **Delete Job** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID used in the URI parameters. - Calls the Salesforce API and deletes the job. ![Salesforce Data Cloud Delete Job flow with Listener, Delete Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/delete-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api) and copy the resulting job ID. 4. Use the job you copied to close the job (see [Close Job - Bulk API](#close-job-bulk-api) flow). 5. Test the flow by sending a `DELETE` to `localhost:8081/jobs/delete/{JOB_ID}`, using the job ID that you copied earlier. ## Insights - List Metadata API This Mule flow shows how to get the metadata, including the dimensions and filters for all calculated insights. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests. - **Insights - List Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Calls the Salesforce Data Cloud API to return the metadata for all calculated insights. ![Salesforce Data Cloud Insights List Metadata flow with Listener and Insights List Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/insights-list-metadata.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/insight/metadata`. ## Insights - Get Metadata API This Mule flow shows how to retrieve the metadata, including the dimensions and filters for a calculated insight. Refer to the [Salesforce Data Cloud API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-insights-meta-ci-name.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the calculated insight name as the required URI parameter. - **Insights - Get Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the calculated insight name. - Calls the Salesforce Data Cloud API to return the metadata for the requested calculated insight. ![Salesforce Data Cloud Insights Get Metadata flow with Listener and Insights Get Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/insights-get-metadata.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/insight/metadata/{CALCULATED_INSIGHT_NAME}`. ## Insights - Get Insights API This Mule flow shows how to query the calculated insights. Users can slice, dice, and filter by selecting different dimensions, measures, and filters. Refer to the [Salesforce Data Cloud API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-insights-ci-ci-name.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the calculated insight name as the required URI parameter and a combination of any optional query parameters. - **Insights - Get Insights** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the calculated insight name and any other optional URI parameters. - Calls the Salesforce Data Cloud API to return the records of the requested calculated insight that match the query criteria. ![Salesforce Data Cloud Insights Get Insights flow with Listener and Insights Get Insights](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/insights-get-insights.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/insight/calculated-insights/{CALCULATED_INSIGHT_NAME}`. ## Profile - List Metadata API This Mule flow shows how to retrieve the list of data model objects and their fields and category. Refer to the [Salesforce Data Cloud API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-meta.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests. - **Profile - List Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Calls the Salesforce Data Cloud API to return the list of data model objects and their fields and category. ![Salesforce Data Cloud Profile List Metadata flow with Listener and Profile List Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/profile-list-metadata.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/metadata`. ## Profile - Get Metadata API This Mule flow shows how to retrieve the metadata for a data model object. Refer to the [Salesforce Data Cloud API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-meta-dmname.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name as the required URI parameter. - **Profile - Get Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name. - Calls the Salesforce Data Cloud API to return the metadata for the requested data model object. ![Salesforce Data Cloud Profile Get Metadata flow with Listener and Profile Get Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/profile-get-metadata.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/metadata/{DATA_MODEL_NAME}`. ## Profile - Search Records API This Mule flow shows how to retrieve data model object records based on search filters. Refer to the [Salesforce Data Cloud API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name as the required URI parameter, fields as the required query parameter, and a combination of any other query parameters. - **Profile - Search Records** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, fields and any optional query parameters. - Calls the Salesforce Data Cloud API to return the data model object records based on search filters. ![Salesforce Data Cloud Profile Search Records flow with Listener and Profile Search Records](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/profile-search-records.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}?filters={FILTERS}`. ## Profile - Search Records By ID API This Mule flow shows how to retrieve data model object records based on search indexes and filters. Refer to the [Salesforce Data Cloud API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name and ID as the required URI parameters, and a combination of any optional query parameters. - **Profile - Search Records By Id** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, ID, and any optional query parameters. - Calls the Salesforce Data Cloud API to return the data model object records based on search indexes and filters. ![Salesforce Data Cloud Profile Search Records By Id flow with Listener and Profile Search Records By Id](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/profile-search-records-by-id.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}/{Id}`. ## Profile - Search Records With Child Records API This Mule flow shows how to retrieve data model object records along with child data model object records based on indexes and search filters. Refer to the [Salesforce Data Cloud API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id-child-dmname.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name, child data model name, and ID as the required URI parameters, and a combination of any optional query parameters. - **Profile - Search Records With Child Records** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, child data model name, ID, and any optional query parameters. - Calls the Salesforce Data Cloud API to return the data model object records along with child data model object records based on indexes and search filters. ![Salesforce Data Cloud Profile Search Records With Child Records flow with Listener and Profile Search Records With Child Records](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/profile-search-records-with-child-records.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}/{Id}/{CHILD_DATA_MODEL_NAME}`. ## Profile - Search Records With Insight API This Mule flow shows how to retrieve data model object records and a computed view based on indexes and search filters. Refer to the [Salesforce Data Cloud API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id-ci-ci-name.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name, ID, and calculated insight name as the required URI parameters, and a combination of any optional query parameters. - **Profile - Search Records With Insight** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, ID, calculated insight name, and any optional query parameters. - Calls the Salesforce Data Cloud API to return the data model object records and a computed view based on indexes and search filters. ![Salesforce Data Cloud Profile Search Records With Insight flow with Listener and Profile Search Records With Insight](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/profile-search-records-with-insight.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}/{Id}/calculated-insights/{CALCULATED_INSIGHT_NAME}`. ## Data Action Webhook This Mule flow shows how to create a webhook that logs its payload when triggered by a Data Action. Refer to the [Salesforce Data Action docs](https://help.salesforce.com/s/articleView?id=data.c360_a_data_actions.htm&type=5). This example uses the following operations: - **Data Action Webhook** Creates a webhook as the target of a Salesforce Data Cloud Data Action. - **Logger** Shows the payload sent to the Data Action Webhook. ![Salesforce Data Cloud Data Action Webhook flow with Data Cloud Data Action Webhook and Logger Log Payload](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/data-action-webhook.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 ``` ### Steps for Running This Example 1. [Create a Streaming Insight](https://help.salesforce.com/s/articleView?id=data.c360_a_create_streaming_insight.htm&type=5). 2. [Create a Data Action Target](https://help.salesforce.com/s/articleView?id=data.c360_a_data_actions.htm&type=5) with an Action Target Type of `Webhook`. 3. [Create a Data Action](https://help.salesforce.com/s/articleView?id=data.c360_a_data_actions.htm&type=5) that uses the Data Action Target and runs on a condition against your streaming Calculated Insight. 4. Save the Mule project. 5. [Deploy your app to CloudHub.](https://docs.mulesoft.com/cloudhub/deploying-to-cloudhub) 6. Point the data action target to your application’s URL. Your application URL looks like this: `[https://{{app-name}}.{{region}}.cloudhub.io/webhook](https://{{app-name}}.{{region}}.cloudhub.io/webhook)`. 7. Trigger the data action’s condition to test the flow, and observe the logged payload. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.3 --- # Salesforce Data Cloud Connector 1.3 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Data Cloud (Salesforce Data Cloud Connector) provides Mule users with a quick and easy way to integrate with Salesforce Data Cloud API endpoints. Users can automate data ingestion from third parties, query the Data Cloud Data Lake, search and query customer profile information and calculated insights, and consume data action events to enrich the 360-degree view of their customers in their Data Cloud instance. ## Configurations --- ### SDC Config #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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

x

Connection

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Configures an expiration policy for the configuration.

#### Connection Types ##### OAuth Client Credentials Custom connection provider for the OAuth Client Credentials flow. ###### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Array of Default Header.

Headers automatically added to every outbound request.

Query Parameters

Query parameters automatically added to every outbound request.

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

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

Token endpoint

String

URL pointing to the server responsible for providing the authentication token.

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

Data Space

String

Filters results from this data space only.

default

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

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

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

##### OAuth JWT Custom connection provider for the OAuth JWT flow. ###### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Array of Default Header.

Headers automatically added to every outbound request.

Query Parameters

Query parameters automatically added to every outbound request.

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

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.

x

Subject

String

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

x

Audience url

String

Identifies the authorization server as an intended audience.

x

Data Space

String

Filters results from this data space only.

default

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

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

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

##### OAuth Username Password Custom connection provider for the username and password flow. ###### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Array of Default Header.

Headers automatically added to every outbound request.

Query Parameters

Query parameters automatically added to every outbound request.

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

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

Audience url

String

Identifies the authorization server as an intended audience.

x

Data Space

String

Filters results from this data space only.

default

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

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

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

### Data Action Webhook Config Configuration element for a Webhook Source. #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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

x

Connection

Connection types for this configuration.

x

Base Path

String

Base path to use for all requests that reference this configuration.

Name

String

ID of this element used for reference in other components

x

#### Connection Types ##### Listener ###### Parameters
NameTypeDescriptionDefault ValueRequired

TLS_Config

Reference to a TLS configuration element. Enables HTTPS for this configuration.

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. When using HTTPS, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, the user must configure the keystore in the tls:context child element of this listener configuration.

HTTP

Host

String

Host in which the requests are sent.

x

Port

Number

Port in which the requests are received.

x

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Connection Idle Timeout

Number

Number of milliseconds that a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled. The listener default timeout is bigger than our requester default timeout to avoid the Remotely closed exception when sending a request to an existing connection before the timeout occurs.

40000

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

## Associated Operations - [Bulk - Create Job](#CreateBulkJob) - [Bulk - Delete Job](#DeleteBulkJob) - [Streaming - Delete Objects](#DeleteObjects) - [Insights - List Metadata](#GetAllCalculatedInsightMetadata) - [Bulk - Get Job](#GetBulkJob) - [Bulk - List Jobs](#GetBulkJobs) - [Insights - Get Metadata](#GetCalculatedInsightMetadata) - [Insights - Get Insights](#GetCalculatedInsightWithFiltersFieldsAndLimit) - [Profile - Search Records With Insight](#GetComputedViewForProfile) - [Profile - Get Metadata](#GetMeta) - [Profile - List Metadata](#GetMetaByCategory) - [Query v2 - Get Next Batch](#GetNextBatchAnsiSqlV2) - [Profile - Search Records By Id](#GetParent) - [Profile - Search Records With Child Records](#GetParentAndChild) - [Profile - Search Records](#GetParentWithFilters) - [Streaming - Insert Objects](#InsertObjects) - [Query](#Query) - [Query v2](#QueryAnsiSqlV2) - [Bulk - Close / Abort Job](#UpdateBulkOperationJob) - [Bulk - Upload Job Data](#UploadDataBulkJob) ## Associated Sources - [Data Action Webhook](#WebhookSource) ## Operations ## Bulk - Create Job `` Creates a job that represents the bulk operation for sending data to Salesforce Data Cloud for asynchronous processing. This operation makes an HTTP POST request to the /ingest/jobs endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source API name

String

Name of the ingestion source API to work with.

x

Object name

String

Name of object to work with.

x

Operation

Enumeration, one of:

  • delete

  • upsert

Operation to execute.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s 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

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Delete Job `` Deletes the job for the specified job ID. This operation makes an HTTP DELETE request to the /ingest/jobs/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID returned in the response body from the Create Job request.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Streaming - Delete Objects `` Deletes one or more records from Salesforce Data Cloud. This operation makes an HTTP DELETE request to the /ingest/sources/{source-name}/{object-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source API name

String

Ingest source API name.

x

Object name

String

Name of the collection to delete data from.

x

IDs

Array of String

Comma-separated list of IDs to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s 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

String

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Insights - List Metadata `` The metadata includes the dimension and measure that are part of the calculated insight. This operation makes an HTTP GET request to the /insight/metadata endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Get Job `` Retrieves the job details for the specified job ID. This operation makes an HTTP GET request to the ingest/jobs/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID returned in the response body from the Create Job request.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s 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

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - List Jobs `` Retrieves all bulk jobs. This operation makes an HTTP GET request to the /ingest/jobs endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s 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

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Insights - Get Metadata `` The metadata includes the dimension and measure that are part of the calculated insight. This operation makes an HTTP GET request to the /insight/metadata/{ci-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

ci_name

String

Calculated insight name, for example, IndividualChildrenCount__cio.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Insights - Get Insights `` Use this API to query the calculated insights. Users can slice, dice, and filter by selecting different dimensions, measures, and filters. This operation makes an HTTP GET request to the /insight/calculated-insights/{ci-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

ci_name

String

Calculated insight name.

x

dimensions

String

Comma-separated list of dimensions to project. By default, this parameter includes all of the available dimensions.

measures

String

Comma-separated list of measures to project. By default, this parameter includes all of the available measures.

limit

Number

Number of items to return. The maximum number of items to return is 4999.

4999

offset

Number

Number of rows to skip before starting to return.

filters

String

This parameter is added to a select query to select only results of a specific type.

orderby

String

Comma-separated values to sort the result set in ascending or descending order.

timeGranularity

Enumeration, one of:

  • HOUR

  • DAY

  • MONTH

  • QUARTER

  • YEAR

User-specified granularity if ci has one or more time dimensions available.

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.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records With Insight `` Returns data model objects and a computed view based on indexes and search filters. This operation makes an HTTP GET request to the /profile/{dataModelName}/{id}/calculated-insights/{ci\_name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

id

String

Value of an indexed column.

x

ci_name

String

Calculated insight name.

x

searchKey

String

Index name if an object’s ID is different from the primary key.

dimensions

String

Comma-separated name of the dimensions to be a part of the result from the computed view. By default, this parameter includes all the dimensions.

measures

String

Comma-separated name of the measures to be a part of the result from the computed view. By default, this parameter includes all the measures.

limit

Number

Number of items to return.

filters

String

Filters are applied only on the parent object.

offset

Number

Number of rows to skip before starting to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order.

timeGranularity

Enumeration, one of:

  • HOUR

  • DAY

  • MONTH

  • QUARTER

  • YEAR

User-specified granularity if ci has one or more time dimensions available.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Get Metadata `` Returns the metadata for the data model object. The metadata includes the list of fields, data types, and indexes available for lookup. This operation makes an HTTP GET request to the /profile/metadata/{dataModelName} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s 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

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - List Metadata `` Returns the list of data model objects, their fields, and category. This operation makes an HTTP GET request to the /profile/metadata endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v2 - Get Next Batch `` Returns the next batch of data from the initial POST request. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Next Batch Id

String

Get next batch of data using batchId.

x

Enable arrow stream

Enumeration is one of:

  • TRUE

  • FALSE

Determines whether to get the response data in arrow stream or JSON format. A value of true returns the data in arrow stream format.

FALSE

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.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records By Id `` Returns data model objects based on search indexes and filters. Use this API call to retrieve the object record based on the primary key or secondary keys. Returns an empty list when records are not found. This operation makes an HTTP GET request to the /profile/{dataModelName}/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

Id

String

Value of the primary or secondary key field. Defaults to the primary key when not specified.

x

searchKey

String

Name of the key field, if a field other than the primary key is used.

fields

String

Distinct comma-separated name of fields to include in the result. Not specifying this parameter returns an arbitrary set of fields.

filters

String

Set of comma-separated equality expressions, within square brackets.

limit

Number

Numbers of records to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order. This field is available in API version 52.0 and later.

offset

Number

Number of rows to skip before starting to return. This field is available in API version 52.0 and later.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records With Child Records `` Returns data model objects and child objects based on indexes and search filters. This operation makes an HTTP GET request to the /profile/{dataModelName}/{id}/{childDataModelName} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

id

String

Value of an indexed column.

x

childDataModelName

String

Child data model object API name.

x

searchKey

String

Index name if an object’s ID is different from the primary key.

fields

String

Comma-separated name of the fields of the result from the child entity. If unspecified, the first ten alphabetically-sorted fields are given.

limit

Number

Numbers of items to return.

filters

String

Filters are applied only on the parent object.

offset

Number

Number of rows to skip before starting to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records `` Returns data model objects based on search filters. Use this API call to retrieve the object records after applying the selected filters. This operation makes an HTTP GET request to the /profile/{dataModelName} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

filters

String

Set of comma-separated equality expressions, in square brackets.

x

fields

String

Distinct comma-separated name of fields to include in the result. If unspecified, this parameter returns an arbitrary set of fields.

limit

Number

Numbers of records to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order. This field is available in API version 52.0 and later.

offset

Number

Number of rows to skip before starting to return. This field is available in API version 52.0 and later.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Streaming - Insert Objects `` Creates new records or updates existing records in Salesforce Data Cloud. This operation makes an HTTP POST request to the /ingest/connectors/{connector-name}/{object-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source API name

String

Ingest source API name.

x

Object name

String

Name of the collection to load data into.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query `` Executes a query against the specified object and returns data that matches the specified criteria. This operation makes an HTTP POST request to the /query endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v2 `` Query V2 supports SQL queries in ANSI standard and returns results as an array of records. The expected input when calling this API is free-form SQL. The input objects include data stream, profile and engagement data model objects, and unified data model objects. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Enable arrow stream

Enumeration, one of:

  • TRUE

  • FALSE

Determines whether to get the response data in arrow stream or JSON format. A value of true returns the data in arrow stream format.

FALSE

Body

Any

#[payload]

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.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Close / Abort Job `` Closes or aborts a job given its ID. This operation makes an HTTP PATCH request to the /ingest/jobs/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID returned in the response body from the Create Job request.

x

State

Enumeration, one of:

  • Aborted

  • UploadComplete

New state for the job.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Upload Job Data `` Uploads data for a job using CSV data you provide. This operation makes an HTTP PUT request to the /ingest/jobs/{id}/batches endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

id

String

Job ID returned in the response body from the Create Job request.

x

Body

String

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Sources ## Data Action Webhook `` Listener for Salesforce Data Cloud Data Action Webhook. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Path

String

Relative path from MuleSoft Salesforce Data Cloud Data Action Webhook configuration.

/

Signing Key

String

Secret key copied from Salesforce Data Cloud Data Action Target.

x

Signing Algorithm

Enumeration, one of:

  • HmacSHA256

Signing algorithm copied from Salesforce Data Cloud Data Action Target.

x

Output Mime Type

String

MIME type of the payload that the operation outputs.

On Capacity Overload

Enumeration, one of:

  • FAIL

  • DROP

Strategy applied by the runtime when the flow receives more messages than it has the capacity to handle.

FAIL

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Redelivery Policy

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

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

String

### For Configurations - [Data Action Webhook Config](#SdcWebhookConfig) ## Types ### Default Header Headers automatically added to every outbound request.
FieldTypeDescriptionDefault ValueRequired

Key

String

Key for this type.

x

Value

String

Value for this type.

x

### Default Query Param Query parameters automatically added to every outbound request.
FieldTypeDescriptionDefault ValueRequired

Key

String

Key for this type.

x

Value

String

Value for this type.

x

### Proxy Configures the settings used to connect through a proxy.
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.

Non Proxy Hosts

String

### 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 how to validate certificates.

### 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, if possible.

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.

### 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, if possible.

Type

String

Type of store used.

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.

### 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.

### 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.

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

Path

String

Path to the CRL file.

### 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.

### 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 operation source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often the Mule app attempts to reconnect to the remote service or API, in milliseconds.

Blocking

Boolean

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

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

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it is considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

### HTTP Response Attributes
FieldTypeDescriptionDefault ValueRequired

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

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

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

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

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero 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.

### 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.

### Error Mapping In each operation of your Mule flow, you can map the possible error types to a custom error type of your choosing.
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

### 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 how to identify a redelivered message and how to find out when the message was redelivered.
FieldTypeDescriptionDefault ValueRequired

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

## See Also - [Salesforce Data Cloud Connector Overview](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.4 --- # Salesforce Data Cloud Connector 1.4 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Data Cloud (Salesforce Data Cloud Connector) provides a quick and easy way to integrate with Salesforce Data 360 (formerly Salesforce Data Cloud) API endpoints. You can automate data ingestion from third parties, query the Data 360 Data Lake, search and query customer profile information and calculated insights, and consume data action events to enrich the 360-degree view of the customers in your Data 360 instance. 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 information about compatibility and fixed issues, refer to the Salesforce Data Cloud Connector release notes. ## Before You Begin To use this connector, you must be familiar with: - [The Salesforce Data 360 Ingestion API](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-started.html) - [Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Mule runtime engine](https://docs.mulesoft.com/mule-runtime/latest/) (Mule) - [Elements and global elements](https://docs.mulesoft.com/mule-runtime/latest/global-elements) in a Mule flow - [How to create a Mule app using Anypoint Studio](https://docs.mulesoft.com/mule-runtime/latest/mule-app-dev) Before creating an app, you must have: - [Set up the Ingestion API](#set-up-the-ingestion-api) - Credentials to access the Salesforce Data 360 target resource - Anypoint Platform - Anypoint Studio version 7.11.x or later ## Set Up the Ingestion API To use Salesforce Data Cloud Connector, you must first set up the Ingestion API. For more information, refer to [Connect MuleSoft with Data 360](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/). After setting up the Ingestion API, refer to [Next Step](#next-step) to configure your connector. ## Common Use Cases For the Connector These are some common use cases for Salesforce Data Cloud Connector: - Stream data via insert and delete object endpoints of the Ingestion API Connector - Create a bulk job, upload job data, close or abort a job, get a job status, retrieve all bulk jobs, and delete a job as part of the Bulk Ingestion interaction pattern of the Ingestion API Connector - Query Data 360 objects - Query Salesforce Data 360 data lake across data model, lake, unified, and linked objects - Query calculated insights with selected dimensions, selected measures, and optional filters - Look up and search customer profile information - Create webhooks as data action targets for data actions in Data 360 For examples, see [Salesforce Data Cloud Connector Examples](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/salesforce-data-cloud-connector-examples) use cases. ## Connection Types Salesforce Data Cloud Connector uses these authentication types: - OAuth Client Credentials Uses OAuth 2.0 with a token endpoint for authentication - OAuth JWT Uses OAuth 2.0 with a JSON Web token (JWT) request for authentication - OAuth Username Password Uses OAuth 2.0 with a username and password for authentication For information about configuring authentication types, see [Using Anypoint Studio to Configure Salesforce Data Cloud Connector](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/salesforce-data-cloud-connector-studio). ## Next Step After you complete the prerequisites, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/salesforce-data-cloud-connector-studio). ## See Also - [Salesforce Data 360](https://help.salesforce.com/s/articleView?id=data.c360_a_customer360_lm.htm&type=5) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Data Cloud Connector Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/salesforce-data-cloud-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.4 --- # Salesforce Data Cloud Connector 1.4 - Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Configure Anypoint Connector for Salesforce Data Cloud (Salesforce Data Cloud Connector) to generate an OAuth 2.0 keystore file. ## Generate a Keystore File Salesforce Data Cloud Connector uses the Bouncy Castle cryptographic library to load the certificate from the keystore and sign the payload for the authentication requests. The Bouncy Castle 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, so do not use BKS-V1 keystore files, as documented in the [Bouncy Castle proposed solution](https://www.kb.cert.org/vuls/id/306792). By default, Salesforce Data Cloud Connector uses JKS or PKCS12 keystores. To generate a JKS keystore file: 1. Go to your Mule workspace and open the terminal or shell application for your operating system. 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. ## Next Step After you complete configuring the connector, you can try the [Examples](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/salesforce-data-cloud-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 Data Cloud Connector version: 1.4 --- # Salesforce Data Cloud Connector 1.4 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio: - If you manually code a Mule runtime engine (Mule) app in XML either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/sdc http://www.mulesoft.org/schema/mule/sdc/current/mule-sdc.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint 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 mule4-sdc-connector x.x.x mule-plugin ``` Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `salesforce data cloud`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/salesforce-data-cloud-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 Data Cloud Connector version: 1.4 --- # Salesforce Data Cloud Connector 1.4 Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following examples show how to integrate with the various Salesforce Data 360 API endpoints with Salesforce Data Cloud Connector: - Streaming API Ingestion Flows include: - [Insert Data - Streaming API](#insert-data-streaming-api) Shows how to insert data via the streaming API to an object’s endpoint. - [Delete Data - Streaming API](#delete-data-streaming-api) Shows how to delete records via the streaming API for specific objects. - Bulk API Ingestion Flows include: - [Create Job - Bulk API](#create-job-bulk-api) Shows how to create a bulk job, which is needed for uploading data to Salesforce Data 360 Ingestion API objects. - [Upload Job Data - Bulk API](#upload-job-data-bulk-api) Shows how to upload data for inserting to or deleting from a Salesforce Data 360 Ingestion API object. - [Close Job - Bulk API](#close-job-bulk-api) Shows how to update the status of the specified job ID so that the job is closed and queued for processing. - [Abort Job - Bulk API](#abort-job-bulk-api) Shows how to update the status of the specified job ID so that the job is aborted and not queued for processing. - [Get Job - Bulk API](#get-job-bulk-api) Shows how to retrieve current status of the specified job ID. - [List Jobs - Bulk API](#list-jobs-bulk-api) Shows how to retrieve all bulk jobs. - [Delete Job - Bulk API](#delete-job-bulk-api) Shows how to delete or close the specified job ID, which deletes job data and metadata stored by Salesforce. - Query API Flows include: - [Query API](#query-api) Shows how to query the Salesforce Data 360 data lake across data model, lake, unified, and linked objects. - [Query v2](#query-v2) Shows how to use the Query v2 API to make a query against the Data 360 data lake. - [Query v2 - Get Next Batch](#query-v2-get-next-batch) Shows how to use the Query v2 Get Next Batch API to get the next batch of results. - Calculated Insights API Flows include: - [Insights - List Metadata API](#insights-list-metadata-api) Shows how to retrieve the metadata, including the dimensions and measures for all calculated insights. - [Insights - Get Metadata API](#insights-get-metadata-api) Shows how to retrieve the metadata, including the dimensions and measures for a calculated insight. - [Insights - Get Insights API](#insights-get-insights-api) Shows how to query the calculated insights. Users can slice, dice, and filter by selecting different dimensions, measures, and filters. - Profile API Flows include: - [Profile - List Metadata API](#profile-list-metadata-api) Shows how to retrieve the metadata for all data model objects. - [Profile - Get Metadata API](#profile-get-metadata-api) Shows how to retrieve the metadata for the requested data model object. - [Profile - Search Records API](#profile-search-records-api) Shows how to retrieve data model object records based on search filters. - [Profile - Search Records By ID API](#profile-search-records-by-id-api) Shows how to retrieve data model object records based on indexes and search filters. - [Profile - Search Records With Child Records API](#profile-search-records-with-child-records-api) Shows how to retrieve data model object records and child object records based on indexes and search filters. - [Profile - Search Records With Insight API](#profile-search-records-with-insight-api) Shows how to retrieve data model object records and a computed view based on indexes and search filters. - Data Action API Flows include: - [Data Action Webhook](#data-action-webhook) Shows how to run operations when a data action is triggered. ## Insert Data - Streaming API This Mule flow shows how to insert data via the streaming API to an object’s endpoint. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-insert-records.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the source and object name as the URI parameters. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Insert Objects** operation. - **Streaming Insert** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the source name, object name, and payload. - Calls the Salesforce API to insert the payload to that object’s endpoint. ![Salesforce Data Cloud Connector Insert flow with Listener, Logger, Insert Objects, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/object-insert-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `POST` to `localhost:8081/{SOURCE_API_NAME}/{OBJECT_NAME}` with a JSON payload that matches your object’s schema, for example: ```json { "data": [ { "your_object_field_1": "value_1", "your_object_field_2": "value_2", "your_object_field_3": "value_3" } ] } ``` ## Query API This Mule flow shows how to query data from Data 360 using a custom SOQL query. Refer to the [Salesforce SOQL docs](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the query in the payload. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Query** operation. - **Query** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the earlier SOQL query. - Calls the Salesforce API with the query and receives the result. ![Salesforce Data Cloud Connector Query flow with Listener, Logger, Query, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/query-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `POST` to `localhost:8081/query` with SOQL query in the request body, for example: ```json { "sql": "SELECT ID FROM ACCOUNT LIMIT 1" } ``` ## Query v2 This Mule flow shows how to send an initial query. Use this flow before [Query v2 - Get Next Batch](#query-v2-get-next-batch). For more information about the Query v2 API, refer to the [Data 360 Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-query-v2.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the query in the payload. - **Logger** Shows the HTTP request received from the **Listener**. - **Set Variable** Sets a variable called `sampleResults` to get a maximum sample of 10 results. Your paging calls are unaffected and this is to limit returned payloads to avoid having 40 MB large payloads on your testing calls. - **Query v2** Makes a query against the Data 360 data lake. - **Flow Reference** Makes a reference to the [Query v2 - Get Next Batch](#query-v2-get-next-batch) flow. ![Salesforce Data Cloud Connector Query v2 flow with Listener, Logger, Set Variable, Query v2, and Flow Reference](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/query-v2-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a request, for example: curl --location 'http://127.0.0.1:8081/queryv2' \\ --header 'Content-Type: application/json' \\ --data '{"sql": "SELECT assigned\_to\_uid\_\_c, campaign\_name\_\_c, cdp\_sys\_PartitionDate\_\_c, coupon\_code\_\_c, currency\_\_c, DataSource\_\_c, DataSourceObject\_\_c, expiry\_date\_\_c, sent\_\_c, value\_\_c FROM MunitQueryV2Test\_coupons\_C7876AA7\_\_dll "}' This example request returns this example response, in which you can use `nextBatchId` to get the next set of results if any are present in the [Query v2 - Get Next Batch](#query-v2-get-next-batch): { "data": \[ \[ "TorBsKqi", "kvoEyIhx", "2022-08-22 00:00:00.000 UTC", "pxMEsTAR", "GJWzpgut", "MunitQueryV2Test\_b1ed190e\_fd18\_49ce\_8813\_f2f4ad59df50", "MunitQueryV2Test\_coupons\_C7876AA7", "2022-08-22 18:28:58.905 UTC", "RkXmYcdH", "87.000000000000000000" \], \[...\] \], "startTime": "2023-03-30T15:51:44.33103Z", "endTime": "2023-03-30T15:51:46.065576Z", "rowCount": 63803, "queryId": "20230330\_155144\_13391\_5rx4m", "nextBatchId": "1449c1d1-2bf2-471d-824f-62c8f18c5c26", "done": false, "metadata": { "value\_\_c": { "type": "DECIMAL", "placeInOrder": 9, "typeCode": 3 }, "sent\_\_c": { "type": "VARCHAR", "placeInOrder": 8, "typeCode": 12 }, "assigned\_to\_uid\_\_c": { "type": "VARCHAR", "placeInOrder": 0, "typeCode": 12 }, "currency\_\_c": { "type": "VARCHAR", "placeInOrder": 4, "typeCode": 12 }, "DataSource\_\_c": { "type": "VARCHAR", "placeInOrder": 5, "typeCode": 12 }, "campaign\_name\_\_c": { "type": "VARCHAR", "placeInOrder": 1, "typeCode": 12 }, "DataSourceObject\_\_c": { "type": "VARCHAR", "placeInOrder": 6, "typeCode": 12 }, "coupon\_code\_\_c": { "type": "VARCHAR", "placeInOrder": 3, "typeCode": 12 }, "expiry\_date\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 7, "typeCode": 2014 }, "cdp\_sys\_PartitionDate\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 2, "typeCode": 2014 } } } ## Query v2 - Get Next Batch This Mule flow shows how to page through the results using the `nextBatchId` forward only cursor for Salesforce Data 360. Use this flow after [Query v2](#query-v2). For more information about the Query v2 Get Next Batch API, refer to the [Data 360 Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-get-query-v2.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the query in the payload. - **Logger** Shows the HTTP request received from the **Listener**. - **Set Variable** Sets a variable called `sampleResults` to get a maximum sample of 10 results. Your paging calls are unaffected and this is to limit returned payloads to avoid having 40 MB large payloads on your testing calls. - **Query v2 - Get Next Batch** Uses a forward cursor to get more results from the [Query v2](#query-v2) and [Query v2 - Get Next Batch](#query-v2-get-next-batch) flows using `nextBatchId`. - **Flow Reference** Makes a reference to the [Query v2](#query-v2) flow. ![Salesforce Data Cloud Connector Query v2 Get Next Batch flow with Listener, Logger, Set Variable, Query v2 Get Next Batch, and Flow Reference](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/query-v2-get-next-batch.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a request, for example: curl --location 'http://127.0.0.1:8081/queryv2?nextBatchId=3e2f0036-f75b-4ee9-a29b-35d8f914e2f1' This example request returns this example response: { "data": \[ \[ "TorBsKqi", "kvoEyIhx", "2022-08-22 00:00:00.000 UTC", "pxMEsTAR", "GJWzpgut", "MunitQueryV2Test\_b1ed190e\_fd18\_49ce\_8813\_f2f4ad59df50", "MunitQueryV2Test\_coupons\_C7876AA7", "2022-08-22 18:28:58.905 UTC", "RkXmYcdH", "87.000000000000000000" \], \[...\] \], "startTime": "2023-03-30T15:51:44.33103Z", "endTime": "2023-03-30T15:51:46.065576Z", "rowCount": 63803, "queryId": "20230330\_155144\_13391\_5rx4m", "nextBatchId": "1449c1d1-2bf2-471d-824f-62c8f18c5c26", "done": false, "metadata": { "value\_\_c": { "type": "DECIMAL", "placeInOrder": 9, "typeCode": 3 }, "sent\_\_c": { "type": "VARCHAR", "placeInOrder": 8, "typeCode": 12 }, "assigned\_to\_uid\_\_c": { "type": "VARCHAR", "placeInOrder": 0, "typeCode": 12 }, "currency\_\_c": { "type": "VARCHAR", "placeInOrder": 4, "typeCode": 12 }, "DataSource\_\_c": { "type": "VARCHAR", "placeInOrder": 5, "typeCode": 12 }, "campaign\_name\_\_c": { "type": "VARCHAR", "placeInOrder": 1, "typeCode": 12 }, "DataSourceObject\_\_c": { "type": "VARCHAR", "placeInOrder": 6, "typeCode": 12 }, "coupon\_code\_\_c": { "type": "VARCHAR", "placeInOrder": 3, "typeCode": 12 }, "expiry\_date\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 7, "typeCode": 2014 }, "cdp\_sys\_PartitionDate\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 2, "typeCode": 2014 } } } ## Delete Data - Streaming API This Mule flow shows how to delete data via the streaming API using an object’s endpoint. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-delete-records.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP DELETE requests with the source api and object name as URI parameters and record IDs as query parameters. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Streaming Delete** operation. - **Streaming Delete** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the source api name, object name, and record IDs. - Calls the Salesforce API to delete the records from the query parameters using that object’s endpoint. ![Salesforce Data Cloud Connector Delete flow with Listener, Logger, Delete Objects, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/delete-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `DELETE` to `localhost:8081/delete/{SOURCE_API_NAME}/{OBJECT_NAME}?ids={RECORD_ID1},{RECORD_ID2}`, for example: `localhost:8081/delete/My_SourceApi/My_Object?ids=1,2,3` ## Create Job - Bulk API This Mule flow shows how to create a bulk job, which uploads data to a Salesforce Data 360 Ingestion API object. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-create-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the source api and object name as URI parameters and record IDs as query parameters. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Create Job** operation. - Create Job: - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the source api name, object name, and job operation. You can find the job operations in the [Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/salesforce-data-cloud-connector-reference) page. - Calls the Salesforce API to create the job and returns the response. ![Salesforce Data Cloud Connector Create Job flow with Listener, Create Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/create-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `POST` to `localhost:8081/jobs/create/{SOURCE_API_NAME}/{OBJECT_NAME}/{OPERATION}`. ## Upload Job Data - Bulk API This Mule flow shows how to upload data for inserting to or deleting from a Salesforce Data 360 Ingestion API object specified by the job ID. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-upload-job-data.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the job ID in the URI. - **CSV Reader** Reads data from the CSV that is configured in the absolute file path. - **Set Payload** Updates the payload with the CSV data for **Upload Job Data**. - **Upload Job Data** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID from the HTTP request and CSV data that is now in the payload. - Uploads data from the CSV to the Salesforce Data 360 Ingestion API object, and eventually returns an HTTP response. - **Logger** Shows the HTTP result from the **Upload Job Data** operation. ![Salesforce Data Cloud Connector Upload Job flow with Listener, Read, Set Payload, Upload Job Data, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/upload-job-data-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Enter a valid absolute file path to a CSV in the CSV Reader’s **File Path** attribute. 3. Save the project. 4. [Create a job](#create-job-bulk-api) and copy its job ID. 5. Test the flow by sending a `POST` to `localhost:8081/jobs/upload/{JOB_ID}` using the job ID you copied earlier. ## Close Job - Bulk API This Mule flow shows how to update the status of the specified job ID so that the job is closed. After a job is closed, it is queued for processing [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-close-or-abort-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the job ID as a URI parameter. - **Logger** Shows the HTTP response from the **Close Job** operation. - **Close Job** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the specified job ID. - Calls the Salesforce API with the `UploadComplete` state, which completes that job and subsequently receives an HTTP response. ![Salesforce Data Cloud Connector Close Job flow with Listener, Close Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/close-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Create a job and copy the resulting job ID. 4. Test the flow by sending a `GET` to `localhost:8081/jobs/close/{JOB_ID}` with the job ID you copied earlier. ## Abort Job - Bulk API This Mule flow shows how to update the status of the specified job ID so that the job is aborted. After a job is aborted, it will not be queued for processing [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-close-or-abort-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the job ID as a URI parameter. - **Logger** Shows the HTTP response from the **Abort Job** operation. - **Abort Job**: - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID that was used as the URI parameter. - Calls the Salesforce API with the aborted state, aborts that job, and then receives an HTTP response. ![Salesforce Data Cloud Connector Abort Job flow with Listener, Abort Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/abort-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api) and copy the resulting job ID. 4. Test the flow by sending a `GET` to `localhost:8081/jobs/abort/{JOB_ID}` with the job ID that you previously copied. ## Get Job - Bulk API This Mule flow shows how to retrieve the current status of the specified job ID. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-job-info.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the job ID included in the URI parameters. - **Logger** Shows the HTTP response from the **Get Job** operation. - **Get Job** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID from the URI parameters. - Calls the Salesforce API and returns the job status. ![Salesforce Data Cloud Connector Get Job flow with Listener, Get Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/get-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api) and copy the resulting job ID. 4. Test the flow by sending a `GET` to `localhost:8081/jobs/get/{JOB_ID}`, using the job ID you copied earlier. ## List Jobs - Bulk API This Mule flow shows how to retrieve all bulk jobs. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-all-jobs.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with all jobs included in the URI parameters. - **Logger** Shows the HTTP response from the **List Jobs** operation. - **List Jobs** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives all jobs from the URI parameters. - Calls the Salesforce API and returns the job status. ![Salesforce Data Cloud Connector List Jobs flow with Listener, List Jobs, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/list-jobs-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api). 4. Test the flow by sending a `GET` to `localhost:8081/jobs/get/`. ## Delete Job - Bulk API This Mule flow shows how to delete or close the specified job ID, which deletes job data and metadata that is stored by Salesforce. In order to delete a job, a job must have a state of `UploadComplete`, `JobComplete`, `Aborted`, or `Failed`. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-delete-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP DELETE requests with the job ID included in the URI parameters. - **Logger** Shows the HTTP response from the **Delete Job** operation. - **Delete Job** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID used in the URI parameters. - Calls the Salesforce API and deletes the job. ![Salesforce Data Cloud Connector Delete Job flow with Listener, Delete Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/delete-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api) and copy the resulting job ID. 4. Use the job you copied to close the job (see [Close Job - Bulk API](#close-job-bulk-api) flow). 5. Test the flow by sending a `DELETE` to `localhost:8081/jobs/delete/{JOB_ID}`, using the job ID that you copied earlier. ## Insights - List Metadata API This Mule flow shows how to get the metadata, including the dimensions and filters for all calculated insights. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests. - **Insights - List Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Calls the Salesforce Data 360 API to return the metadata for all calculated insights. ![Salesforce Data Cloud Connector Insights List Metadata flow with Listener and Insights List Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/insights-list-metadata.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/insight/metadata`. ## Insights - Get Metadata API This Mule flow shows how to retrieve the metadata, including the dimensions and filters for a calculated insight. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-insights-meta-ci-name.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the calculated insight name as the required URI parameter. - **Insights - Get Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the calculated insight name. - Calls the Salesforce Data 360 API to return the metadata for the requested calculated insight. ![Salesforce Data Cloud Connector Insights Get Metadata flow with Listener and Insights Get Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/insights-get-metadata.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/insight/metadata/{CALCULATED_INSIGHT_NAME}`. ## Insights - Get Insights API This Mule flow shows how to query the calculated insights. Users can slice, dice, and filter by selecting different dimensions, measures, and filters. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-insights-ci-ci-name.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the calculated insight name as the required URI parameter and a combination of any optional query parameters. - **Insights - Get Insights** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the calculated insight name and any other optional URI parameters. - Calls the Salesforce Data 360 API to return the records of the requested calculated insight that match the query criteria. ![Salesforce Data Cloud Connector Insights Get Insights flow with Listener and Insights Get Insights](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/insights-get-insights.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/insight/calculated-insights/{CALCULATED_INSIGHT_NAME}`. ## Profile - List Metadata API This Mule flow shows how to retrieve the list of data model objects and their fields and category. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-meta.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests. - **Profile - List Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Calls the Salesforce Data 360 API to return the list of data model objects and their fields and category. ![Salesforce Data Cloud Connector Profile List Metadata flow with Listener and Profile List Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/profile-list-metadata.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/metadata`. ## Profile - Get Metadata API This Mule flow shows how to retrieve the metadata for a data model object. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-meta-dmname.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name as the required URI parameter. - **Profile - Get Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name. - Calls the Salesforce Data 360 API to return the metadata for the requested data model object. ![Salesforce Data Cloud Connector Profile Get Metadata flow with Listener and Profile Get Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/profile-get-metadata.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/metadata/{DATA_MODEL_NAME}`. ## Profile - Search Records API This Mule flow shows how to retrieve data model object records based on search filters. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name as the required URI parameter, fields as the required query parameter, and a combination of any other query parameters. - **Profile - Search Records** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, fields and any optional query parameters. - Calls the Salesforce Data 360 API to return the data model object records based on search filters. ![Salesforce Data Cloud Connector Profile Search Records flow with Listener and Profile Search Records](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/profile-search-records.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}?filters={FILTERS}`. ## Profile - Search Records By ID API This Mule flow shows how to retrieve data model object records based on search indexes and filters. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name and ID as the required URI parameters, and a combination of any optional query parameters. - **Profile - Search Records By Id** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, ID, and any optional query parameters. - Calls the Salesforce Data 360 API to return the data model object records based on search indexes and filters. ![Salesforce Data Cloud Connector Profile Search Records By Id flow with Listener and Profile Search Records By Id](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/profile-search-records-by-id.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}/{Id}`. ## Profile - Search Records With Child Records API This Mule flow shows how to retrieve data model object records along with child data model object records based on indexes and search filters. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id-child-dmname.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name, child data model name, and ID as the required URI parameters, and a combination of any optional query parameters. - **Profile - Search Records With Child Records** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, child data model name, ID, and any optional query parameters. - Calls the Salesforce Data 360 API to return the data model object records along with child data model object records based on indexes and search filters. ![Salesforce Data Cloud Connector Profile Search Records With Child Records flow with Listener and Profile Search Records With Child Records](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/profile-search-records-with-child-records.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}/{Id}/{CHILD_DATA_MODEL_NAME}`. ## Profile - Search Records With Insight API This Mule flow shows how to retrieve data model object records and a computed view based on indexes and search filters. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id-ci-ci-name.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name, ID, and calculated insight name as the required URI parameters, and a combination of any optional query parameters. - **Profile - Search Records With Insight** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, ID, calculated insight name, and any optional query parameters. - Calls the Salesforce Data 360 API to return the data model object records and a computed view based on indexes and search filters. ![Salesforce Data Cloud Connector Profile Search Records With Insight flow with Listener and Profile Search Records With Insight](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/profile-search-records-with-insight.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}/{Id}/calculated-insights/{CALCULATED_INSIGHT_NAME}`. ## Data Action Webhook This Mule flow shows how to create a webhook that logs its payload when triggered by a Data Action. Refer to the [Salesforce Data Action docs](https://help.salesforce.com/s/articleView?id=data.c360_a_data_actions.htm&type=5). This example uses the following operations: - **Data Action Webhook** Creates a webhook as the target of a Salesforce Data 360 Data Action. - **Logger** Shows the payload sent to the Data Action Webhook. ![Salesforce Data Cloud Connector Data Action Webhook flow with Data Cloud Connector Data Action Webhook and Logger Log Payload](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/data-action-webhook.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 ``` ### Steps for Running This Example 1. [Create a Streaming Insight](https://help.salesforce.com/s/articleView?id=data.c360_a_create_streaming_insight.htm&type=5). 2. [Create a Data Action Target](https://help.salesforce.com/s/articleView?id=data.c360_a_data_actions.htm&type=5) with an Action Target Type of `Webhook`. 3. [Create a Data Action](https://help.salesforce.com/s/articleView?id=data.c360_a_data_actions.htm&type=5) that uses the Data Action Target and runs on a condition against your streaming Calculated Insight. 4. Save the Mule project. 5. [Deploy your app to CloudHub.](https://docs.mulesoft.com/cloudhub/deploying-to-cloudhub) 6. Point the data action target to your application’s URL. Your application URL looks like this: `[https://{{app-name}}.{{region}}.cloudhub.io/webhook](https://{{app-name}}.{{region}}.cloudhub.io/webhook)`. 7. Trigger the data action’s condition to test the flow, and observe the logged payload. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.4 --- # Salesforce Data Cloud Connector 1.4 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Data Cloud (Salesforce Data Cloud Connector) provides Mule users with a quick and easy way to integrate with Salesforce Data 360 API endpoints. Users can automate data ingestion from third parties, query the Data 360 Data Lake, search and query customer profile information and calculated insights, and consume data action events to enrich the 360-degree view of their customers in their Data 360 instance. ## Configurations --- ### SDC Config #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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

x

Connection

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Configures an expiration policy for the configuration.

#### Connection Types ##### OAuth Client Credentials Custom connection provider for the OAuth Client Credentials flow. ###### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Array of Default Header.

Headers automatically added to every outbound request.

Query Parameters

Query parameters automatically added to every outbound request.

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

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

Token endpoint

String

URL pointing to the server responsible for providing the authentication token.

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

Data Space

String

Filters results from this data space only.

default

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

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

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

##### OAuth JWT Custom connection provider for the OAuth JWT flow. ###### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Array of Default Header.

Headers automatically added to every outbound request.

Query Parameters

Query parameters automatically added to every outbound request.

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

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.

x

Subject

String

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

x

Audience url

String

Identifies the authorization server as an intended audience.

x

Data Space

String

Filters results from this data space only.

default

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

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

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

##### OAuth Username Password Custom connection provider for the username and password flow. ###### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Array of Default Header.

Headers automatically added to every outbound request.

Query Parameters

Query parameters automatically added to every outbound request.

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

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

Audience url

String

Identifies the authorization server as an intended audience.

x

Data Space

String

Filters results from this data space only.

default

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

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

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

### Data Action Webhook Config Configuration element for a Webhook Source. #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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

x

Connection

Connection types for this configuration.

x

Base Path

String

Base path to use for all requests that reference this configuration.

Name

String

ID of this element used for reference in other components

x

#### Connection Types ##### Listener ###### Parameters
NameTypeDescriptionDefault ValueRequired

TLS_Config

Reference to a TLS configuration element. Enables HTTPS for this configuration.

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. When using HTTPS, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, the user must configure the keystore in the tls:context child element of this listener configuration.

HTTP

Host

String

Host in which the requests are sent.

x

Port

Number

Port in which the requests are received.

x

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Connection Idle Timeout

Number

Number of milliseconds that a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled. The listener default timeout is bigger than our requester default timeout to avoid the Remotely closed exception when sending a request to an existing connection before the timeout occurs.

40000

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

## Associated Operations - [Bulk - Create Job](#CreateBulkJob) - [Bulk - Delete Job](#DeleteBulkJob) - [Streaming - Delete Objects](#DeleteObjects) - [Insights - List Metadata](#GetAllCalculatedInsightMetadata) - [Bulk - Get Job](#GetBulkJob) - [Bulk - List Jobs](#GetBulkJobs) - [Insights - Get Metadata](#GetCalculatedInsightMetadata) - [Insights - Get Insights](#GetCalculatedInsightWithFiltersFieldsAndLimit) - [Profile - Search Records With Insight](#GetComputedViewForProfile) - [Profile - Get Metadata](#GetMeta) - [Profile - List Metadata](#GetMetaByCategory) - [Query v2 - Get Next Batch](#GetNextBatchAnsiSqlV2) - [Profile - Search Records By Id](#GetParent) - [Profile - Search Records With Child Records](#GetParentAndChild) - [Profile - Search Records](#GetParentWithFilters) - [Streaming - Insert Objects](#InsertObjects) - [Query](#Query) - [Query v2](#QueryAnsiSqlV2) - [Bulk - Close / Abort Job](#UpdateBulkOperationJob) - [Bulk - Upload Job Data](#UploadDataBulkJob) ## Associated Sources - [Data Action Webhook](#WebhookSource) ## Operations ## Bulk - Create Job `` Creates a job that represents the bulk operation for sending data to Salesforce Data 360 for asynchronous processing. This operation makes an HTTP POST request to the /ingest/jobs endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source API name

String

Name of the ingestion source API to work with.

x

Object name

String

Name of object to work with.

x

Operation

Enumeration, one of:

  • delete

  • upsert

Operation to execute.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s 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

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Delete Job `` Deletes the job for the specified job ID. This operation makes an HTTP DELETE request to the /ingest/jobs/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID returned in the response body from the Create Job request.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Streaming - Delete Objects `` Deletes one or more records from Salesforce Data 360. This operation makes an HTTP DELETE request to the /ingest/sources/{source-name}/{object-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source API name

String

Ingest source API name.

x

Object name

String

Name of the collection to delete data from.

x

IDs

Array of String

Comma-separated list of IDs to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s 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

String

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Insights - List Metadata `` The metadata includes the dimension and measure that are part of the calculated insight. This operation makes an HTTP GET request to the /insight/metadata endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Get Job `` Retrieves the job details for the specified job ID. This operation makes an HTTP GET request to the ingest/jobs/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID returned in the response body from the Create Job request.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s 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

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - List Jobs `` Retrieves all bulk jobs. This operation makes an HTTP GET request to the /ingest/jobs endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s 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

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Insights - Get Metadata `` The metadata includes the dimension and measure that are part of the calculated insight. This operation makes an HTTP GET request to the /insight/metadata/{ci-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

ci_name

String

Calculated insight name, for example, IndividualChildrenCount__cio.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Insights - Get Insights `` Use this API to query the calculated insights. Users can slice, dice, and filter by selecting different dimensions, measures, and filters. This operation makes an HTTP GET request to the /insight/calculated-insights/{ci-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

ci_name

String

Calculated insight name.

x

dimensions

String

Comma-separated list of dimensions to project. By default, this parameter includes all of the available dimensions.

measures

String

Comma-separated list of measures to project. By default, this parameter includes all of the available measures.

limit

Number

Number of items to return. The maximum number of items to return is 4999.

4999

offset

Number

Number of rows to skip before starting to return.

filters

String

This parameter is added to a select query to select only results of a specific type.

orderby

String

Comma-separated values to sort the result set in ascending or descending order.

timeGranularity

Enumeration, one of:

  • HOUR

  • DAY

  • MONTH

  • QUARTER

  • YEAR

User-specified granularity if ci has one or more time dimensions available.

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.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records With Insight `` Returns data model objects and a computed view based on indexes and search filters. This operation makes an HTTP GET request to the /profile/{dataModelName}/{id}/calculated-insights/{ci\_name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

id

String

Value of an indexed column.

x

ci_name

String

Calculated insight name.

x

searchKey

String

Index name if an object’s ID is different from the primary key.

dimensions

String

Comma-separated name of the dimensions to be a part of the result from the computed view. By default, this parameter includes all the dimensions.

measures

String

Comma-separated name of the measures to be a part of the result from the computed view. By default, this parameter includes all the measures.

limit

Number

Number of items to return.

filters

String

Filters are applied only on the parent object.

offset

Number

Number of rows to skip before starting to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order.

timeGranularity

Enumeration, one of:

  • HOUR

  • DAY

  • MONTH

  • QUARTER

  • YEAR

User-specified granularity if ci has one or more time dimensions available.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Get Metadata `` Returns the metadata for the data model object. The metadata includes the list of fields, data types, and indexes available for lookup. This operation makes an HTTP GET request to the /profile/metadata/{dataModelName} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s 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

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - List Metadata `` Returns the list of data model objects, their fields, and category. This operation makes an HTTP GET request to the /profile/metadata endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v2 - Get Next Batch `` Returns the next batch of data from the initial POST request. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Next Batch Id

String

Get next batch of data using batchId.

x

Enable arrow stream

Enumeration is one of:

  • TRUE

  • FALSE

Determines whether to get the response data in arrow stream or JSON format. A value of true returns the data in arrow stream format.

FALSE

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.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records By Id `` Returns data model objects based on search indexes and filters. Use this API call to retrieve the object record based on the primary key or secondary keys. Returns an empty list when records are not found. This operation makes an HTTP GET request to the /profile/{dataModelName}/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

Id

String

Value of the primary or secondary key field. Defaults to the primary key when not specified.

x

searchKey

String

Name of the key field, if a field other than the primary key is used.

fields

String

Distinct comma-separated name of fields to include in the result. Not specifying this parameter returns an arbitrary set of fields.

filters

String

Set of comma-separated equality expressions, within square brackets.

limit

Number

Numbers of records to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order. This field is available in API version 52.0 and later.

offset

Number

Number of rows to skip before starting to return. This field is available in API version 52.0 and later.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records With Child Records `` Returns data model objects and child objects based on indexes and search filters. This operation makes an HTTP GET request to the /profile/{dataModelName}/{id}/{childDataModelName} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

id

String

Value of an indexed column.

x

childDataModelName

String

Child data model object API name.

x

searchKey

String

Index name if an object’s ID is different from the primary key.

fields

String

Comma-separated name of the fields of the result from the child entity. If unspecified, the first ten alphabetically-sorted fields are given.

limit

Number

Numbers of items to return.

filters

String

Filters are applied only on the parent object.

offset

Number

Number of rows to skip before starting to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records `` Returns data model objects based on search filters. Use this API call to retrieve the object records after applying the selected filters. This operation makes an HTTP GET request to the /profile/{dataModelName} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

filters

String

Set of comma-separated equality expressions, in square brackets.

x

fields

String

Distinct comma-separated name of fields to include in the result. If unspecified, this parameter returns an arbitrary set of fields.

limit

Number

Numbers of records to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order. This field is available in API version 52.0 and later.

offset

Number

Number of rows to skip before starting to return. This field is available in API version 52.0 and later.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Streaming - Insert Objects `` Creates new records or updates existing records in Salesforce Data 360. This operation makes an HTTP POST request to the /ingest/connectors/{connector-name}/{object-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source API name

String

Ingest source API name.

x

Object name

String

Name of the collection to load data into.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query `` Executes a query against the specified object and returns data that matches the specified criteria. This operation makes an HTTP POST request to the /query endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v2 `` Query V2 supports SQL queries in ANSI standard and returns results as an array of records. The expected input when calling this API is free-form SQL. The input objects include data stream, profile and engagement data model objects, and unified data model objects. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Enable arrow stream

Enumeration, one of:

  • TRUE

  • FALSE

Determines whether to get the response data in arrow stream or JSON format. A value of true returns the data in arrow stream format.

FALSE

Body

Any

#[payload]

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.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Close / Abort Job `` Closes or aborts a job given its ID. This operation makes an HTTP PATCH request to the /ingest/jobs/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID returned in the response body from the Create Job request.

x

State

Enumeration, one of:

  • Aborted

  • UploadComplete

New state for the job.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Upload Job Data `` Uploads data for a job using CSV data you provide. This operation makes an HTTP PUT request to the /ingest/jobs/{id}/batches endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

id

String

Job ID returned in the response body from the Create Job request.

x

Body

String

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Sources ## Data Action Webhook `` Listener for Salesforce Data 360 Data Action Webhook. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Path

String

Relative path from MuleSoft Salesforce Data 360 Data Action Webhook configuration.

/

Signing Key

String

Secret key copied from Salesforce Data 360 Data Action Target.

x

Signing Algorithm

Enumeration, one of:

  • HmacSHA256

Signing algorithm copied from Salesforce Data 360 Data Action Target.

x

Output Mime Type

String

MIME type of the payload that the operation outputs.

On Capacity Overload

Enumeration, one of:

  • FAIL

  • DROP

Strategy applied by the runtime when the flow receives more messages than it has the capacity to handle.

FAIL

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Redelivery Policy

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

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

String

### For Configurations - [Data Action Webhook Config](#SdcWebhookConfig) ## Types ### Default Header Headers automatically added to every outbound request.
FieldTypeDescriptionDefault ValueRequired

Key

String

Key for this type.

x

Value

String

Value for this type.

x

### Default Query Param Query parameters automatically added to every outbound request.
FieldTypeDescriptionDefault ValueRequired

Key

String

Key for this type.

x

Value

String

Value for this type.

x

### Proxy Configures the settings used to connect through a proxy.
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.

Non Proxy Hosts

String

### 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 how to validate certificates.

### 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, if possible.

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.

### 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, if possible.

Type

String

Type of store used.

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.

### 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.

### 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.

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

Path

String

Path to the CRL file.

### 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.

### 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 operation source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often the Mule app attempts to reconnect to the remote service or API, in milliseconds.

Blocking

Boolean

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

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

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it is considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

### HTTP Response Attributes
FieldTypeDescriptionDefault ValueRequired

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

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

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

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

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero 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.

### 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.

### Error Mapping In each operation of your Mule flow, you can map the possible error types to a custom error type of your choosing.
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

### 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 how to identify a redelivered message and how to find out when the message was redelivered.
FieldTypeDescriptionDefault ValueRequired

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

## See Also - [Salesforce Data Cloud Connector Overview](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.5 is-latest-version: true --- # Salesforce Data Cloud Connector 1.5 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Data Cloud (Salesforce Data Cloud Connector) provides a quick and easy way to integrate with Salesforce Data 360 (formerly Salesforce Data Cloud) API endpoints. You can automate data ingestion from third parties, query the Data 360 Data Lake, search and query customer profile information and calculated insights, and consume data action events to enrich the 360-degree view of the customers in your Data 360 instance. 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 information about compatibility and fixed issues, refer to the Salesforce Data Cloud Connector release notes. ## Before You Begin To use this connector, you must be familiar with: - [The Salesforce Data 360 Ingestion API](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-started.html) - [Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Mule runtime engine](https://docs.mulesoft.com/mule-runtime/latest/) (Mule) - [Elements and global elements](https://docs.mulesoft.com/mule-runtime/latest/global-elements) in a Mule flow - [How to create a Mule app using Anypoint Studio](https://docs.mulesoft.com/mule-runtime/latest/mule-app-dev) Before creating an app, you must have: - [Set up the Ingestion API](#set-up-the-ingestion-api) - Credentials to access the Salesforce Data 360 target resource - Anypoint Platform - Anypoint Studio version 7.11.x or later ## Set Up the Ingestion API To use Salesforce Data Cloud Connector, you must first set up the Ingestion API. For more information, refer to [Connect MuleSoft with Data 360](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/). After setting up the Ingestion API, refer to [Next Step](#next-step) to configure your connector. ## Common Use Cases For the Connector These are some common use cases for Salesforce Data Cloud Connector: - Stream data via insert and delete object endpoints of the Ingestion API Connector - Create a bulk job, upload job data, close or abort a job, get a job status, retrieve all bulk jobs, and delete a job as part of the Bulk Ingestion interaction pattern of the Ingestion API Connector - Query Data 360 objects - Query Salesforce Data 360 data lake across data model, lake, unified, and linked objects - Query calculated insights with selected dimensions, selected measures, and optional filters - Look up and search customer profile information - Create webhooks as data action targets for data actions in Data 360 For examples, see [Salesforce Data Cloud Connector Examples](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/salesforce-data-cloud-connector-examples) use cases. ## Connection Types Salesforce Data Cloud Connector uses these authentication types: - OAuth Client Credentials Uses OAuth 2.0 with a token endpoint for authentication - OAuth JWT Uses OAuth 2.0 with a JSON Web token (JWT) request for authentication - OAuth Username Password Uses OAuth 2.0 with a username and password for authentication For information about configuring authentication types, see [Using Anypoint Studio to Configure Salesforce Data Cloud Connector](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/salesforce-data-cloud-connector-studio). ## Next Step After you complete the prerequisites, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/salesforce-data-cloud-connector-studio). ## See Also - [Salesforce Data 360](https://help.salesforce.com/s/articleView?id=data.c360_a_customer360_lm.htm&type=5) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Data Cloud Connector Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/salesforce-data-cloud-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.5 is-latest-version: true --- # Salesforce Data Cloud Connector 1.5 - Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Configure Anypoint Connector for Salesforce Data Cloud (Salesforce Data Cloud Connector) to generate an OAuth 2.0 keystore file. ## Generate a Keystore File Salesforce Data Cloud Connector uses the Bouncy Castle cryptographic library to load the certificate from the keystore and sign the payload for the authentication requests. The Bouncy Castle 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, so do not use BKS-V1 keystore files, as documented in the [Bouncy Castle proposed solution](https://www.kb.cert.org/vuls/id/306792). By default, Salesforce Data Cloud Connector uses JKS or PKCS12 keystores. To generate a JKS keystore file: 1. Go to your Mule workspace and open the terminal or shell application for your operating system. 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. ## Next Step After you complete configuring the connector, you can try the [Examples](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/salesforce-data-cloud-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 Data Cloud Connector version: 1.5 is-latest-version: true --- # Salesforce Data Cloud Connector 1.5 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio: - If you manually code a Mule runtime engine (Mule) app in XML either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/sdc http://www.mulesoft.org/schema/mule/sdc/current/mule-sdc.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint 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 mule4-sdc-connector x.x.x mule-plugin ``` Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `salesforce data cloud`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/salesforce-data-cloud-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 Data Cloud Connector version: 1.5 is-latest-version: true --- # Salesforce Data Cloud Connector 1.5 Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following examples show how to integrate with the various Salesforce Data 360 API endpoints with Salesforce Data Cloud Connector: - Streaming API Ingestion Flows include: - [Insert Data - Streaming API](#insert-data-streaming-api) Shows how to insert data via the streaming API to an object’s endpoint. - [Delete Data - Streaming API](#delete-data-streaming-api) Shows how to delete records via the streaming API for specific objects. - Bulk API Ingestion Flows include: - [Create Job - Bulk API](#create-job-bulk-api) Shows how to create a bulk job, which is needed for uploading data to Salesforce Data 360 Ingestion API objects. - [Upload Job Data - Bulk API](#upload-job-data-bulk-api) Shows how to upload data for inserting to or deleting from a Salesforce Data 360 Ingestion API object. - [Close Job - Bulk API](#close-job-bulk-api) Shows how to update the status of the specified job ID so that the job is closed and queued for processing. - [Abort Job - Bulk API](#abort-job-bulk-api) Shows how to update the status of the specified job ID so that the job is aborted and not queued for processing. - [Get Job - Bulk API](#get-job-bulk-api) Shows how to retrieve current status of the specified job ID. - [List Jobs - Bulk API](#list-jobs-bulk-api) Shows how to retrieve all bulk jobs. - [Delete Job - Bulk API](#delete-job-bulk-api) Shows how to delete or close the specified job ID, which deletes job data and metadata stored by Salesforce. - Query API Flows include: - [Query API](#query-api) Shows how to query the Salesforce Data 360 data lake across data model, lake, unified, and linked objects. - [Query v2](#query-v2) Shows how to use the Query v2 API to make a query against the Data 360 data lake. - [Query v2 - Get Next Batch](#query-v2-get-next-batch) Shows how to use the Query v2 Get Next Batch API to get the next batch of results. - [Query v3](#query-v3) Shows how to submit a SQL query in asynchronous or adaptive mode and obtain a query ID for polling. - [Query v3 - Get Status](#query-v3-get-status) Shows how to poll the execution status of a submitted query. - [Query v3 - Get Rows](#query-v3-get-rows) Shows how to page through query results with an offset and limit. - [Query v3 - Get Chunk](#query-v3-get-chunk) Shows how to retrieve a result chunk, which is the preferred way to read large result sets. - [Query v3 - Get Metadata](#query-v3-get-metadata) Shows how to retrieve the result schema without fetching rows. - [Query v3 - Cancel](#query-v3-cancel) Shows how to cancel a running query. - Calculated Insights API Flows include: - [Insights - List Metadata API](#insights-list-metadata-api) Shows how to retrieve the metadata, including the dimensions and measures for all calculated insights. - [Insights - Get Metadata API](#insights-get-metadata-api) Shows how to retrieve the metadata, including the dimensions and measures for a calculated insight. - [Insights - Get Insights API](#insights-get-insights-api) Shows how to query the calculated insights. Users can slice, dice, and filter by selecting different dimensions, measures, and filters. - Profile API Flows include: - [Profile - List Metadata API](#profile-list-metadata-api) Shows how to retrieve the metadata for all data model objects. - [Profile - Get Metadata API](#profile-get-metadata-api) Shows how to retrieve the metadata for the requested data model object. - [Profile - Search Records API](#profile-search-records-api) Shows how to retrieve data model object records based on search filters. - [Profile - Search Records By ID API](#profile-search-records-by-id-api) Shows how to retrieve data model object records based on indexes and search filters. - [Profile - Search Records With Child Records API](#profile-search-records-with-child-records-api) Shows how to retrieve data model object records and child object records based on indexes and search filters. - [Profile - Search Records With Insight API](#profile-search-records-with-insight-api) Shows how to retrieve data model object records and a computed view based on indexes and search filters. - Data Action API Flows include: - [Data Action Webhook](#data-action-webhook) Shows how to run operations when a data action is triggered. ## Insert Data - Streaming API This Mule flow shows how to insert data via the streaming API to an object’s endpoint. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-insert-records.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the source and object name as the URI parameters. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Insert Objects** operation. - **Streaming Insert** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the source name, object name, and payload. - Calls the Salesforce API to insert the payload to that object’s endpoint. ![Salesforce Data Cloud Connector Insert flow with Listener, Logger, Insert Objects, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/object-insert-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `POST` to `localhost:8081/{SOURCE_API_NAME}/{OBJECT_NAME}` with a JSON payload that matches your object’s schema, for example: ```json { "data": [ { "your_object_field_1": "value_1", "your_object_field_2": "value_2", "your_object_field_3": "value_3" } ] } ``` ## Delete Data - Streaming API This Mule flow shows how to delete data via the streaming API using an object’s endpoint. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-delete-records.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP DELETE requests with the source api and object name as URI parameters and record IDs as query parameters. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Streaming Delete** operation. - **Streaming Delete** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the source api name, object name, and record IDs. - Calls the Salesforce API to delete the records from the query parameters using that object’s endpoint. ![Salesforce Data Cloud Connector Delete flow with Listener, Logger, Delete Objects, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/delete-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `DELETE` to `localhost:8081/delete/{SOURCE_API_NAME}/{OBJECT_NAME}?ids={RECORD_ID1},{RECORD_ID2}`, for example: `localhost:8081/delete/My_SourceApi/My_Object?ids=1,2,3` ## Create Job - Bulk API This Mule flow shows how to create a bulk job, which uploads data to a Salesforce Data 360 Ingestion API object. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-create-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the source api and object name as URI parameters and record IDs as query parameters. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Create Job** operation. - Create Job: - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the source api name, object name, and job operation. You can find the job operations in the [Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/salesforce-data-cloud-connector-reference) page. - Calls the Salesforce API to create the job and returns the response. ![Salesforce Data Cloud Connector Create Job flow with Listener, Create Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/create-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `POST` to `localhost:8081/jobs/create/{SOURCE_API_NAME}/{OBJECT_NAME}/{OPERATION}`. ## Upload Job Data - Bulk API This Mule flow shows how to upload data for inserting to or deleting from a Salesforce Data 360 Ingestion API object specified by the job ID. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-upload-job-data.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the job ID in the URI. - **CSV Reader** Reads data from the CSV that is configured in the absolute file path. - **Set Payload** Updates the payload with the CSV data for **Upload Job Data**. - **Upload Job Data** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID from the HTTP request and CSV data that is now in the payload. - Uploads data from the CSV to the Salesforce Data 360 Ingestion API object, and eventually returns an HTTP response. - **Logger** Shows the HTTP result from the **Upload Job Data** operation. ![Salesforce Data Cloud Connector Upload Job flow with Listener, Read, Set Payload, Upload Job Data, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/upload-job-data-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Enter a valid absolute file path to a CSV in the CSV Reader’s **File Path** attribute. 3. Save the project. 4. [Create a job](#create-job-bulk-api) and copy its job ID. 5. Test the flow by sending a `POST` to `localhost:8081/jobs/upload/{JOB_ID}` using the job ID you copied earlier. ## Close Job - Bulk API This Mule flow shows how to update the status of the specified job ID so that the job is closed. After a job is closed, it is queued for processing [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-close-or-abort-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the job ID as a URI parameter. - **Logger** Shows the HTTP response from the **Close Job** operation. - **Close Job** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the specified job ID. - Calls the Salesforce API with the `UploadComplete` state, which completes that job and subsequently receives an HTTP response. ![Salesforce Data Cloud Connector Close Job flow with Listener, Close Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/close-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Create a job and copy the resulting job ID. 4. Test the flow by sending a `GET` to `localhost:8081/jobs/close/{JOB_ID}` with the job ID you copied earlier. ## Abort Job - Bulk API This Mule flow shows how to update the status of the specified job ID so that the job is aborted. After a job is aborted, it will not be queued for processing [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-close-or-abort-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the job ID as a URI parameter. - **Logger** Shows the HTTP response from the **Abort Job** operation. - **Abort Job**: - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID that was used as the URI parameter. - Calls the Salesforce API with the aborted state, aborts that job, and then receives an HTTP response. ![Salesforce Data Cloud Connector Abort Job flow with Listener, Abort Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/abort-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api) and copy the resulting job ID. 4. Test the flow by sending a `GET` to `localhost:8081/jobs/abort/{JOB_ID}` with the job ID that you previously copied. ## Get Job - Bulk API This Mule flow shows how to retrieve the current status of the specified job ID. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-job-info.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the job ID included in the URI parameters. - **Logger** Shows the HTTP response from the **Get Job** operation. - **Get Job** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID from the URI parameters. - Calls the Salesforce API and returns the job status. ![Salesforce Data Cloud Connector Get Job flow with Listener, Get Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/get-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api) and copy the resulting job ID. 4. Test the flow by sending a `GET` to `localhost:8081/jobs/get/{JOB_ID}`, using the job ID you copied earlier. ## List Jobs - Bulk API This Mule flow shows how to retrieve all bulk jobs. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-all-jobs.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with all jobs included in the URI parameters. - **Logger** Shows the HTTP response from the **List Jobs** operation. - **List Jobs** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives all jobs from the URI parameters. - Calls the Salesforce API and returns the job status. ![Salesforce Data Cloud Connector List Jobs flow with Listener, List Jobs, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/list-jobs-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api). 4. Test the flow by sending a `GET` to `localhost:8081/jobs/get/`. ## Delete Job - Bulk API This Mule flow shows how to delete or close the specified job ID, which deletes job data and metadata that is stored by Salesforce. In order to delete a job, a job must have a state of `UploadComplete`, `JobComplete`, `Aborted`, or `Failed`. Refer to the [Salesforce API docs](https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-delete-a-job.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP DELETE requests with the job ID included in the URI parameters. - **Logger** Shows the HTTP response from the **Delete Job** operation. - **Delete Job** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the job ID used in the URI parameters. - Calls the Salesforce API and deletes the job. ![Salesforce Data Cloud Connector Delete Job flow with Listener, Delete Job, and Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/delete-job-bulk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. [Create a job](#create-job-bulk-api) and copy the resulting job ID. 4. Use the job you copied to close the job (see [Close Job - Bulk API](#close-job-bulk-api) flow). 5. Test the flow by sending a `DELETE` to `localhost:8081/jobs/delete/{JOB_ID}`, using the job ID that you copied earlier. ## Query API This Mule flow shows how to query data from Data 360 using a custom SOQL query. Refer to the [Salesforce SOQL docs](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the query in the payload. - **Logger** Shows the HTTP request received from the **Listener**, then later shows the HTTP response from the **Query** operation. - **Query** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the earlier SOQL query. - Calls the Salesforce API with the query and receives the result. ![Salesforce Data Cloud Connector Query flow with Listener, Logger, Query, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/query-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `POST` to `localhost:8081/query` with SOQL query in the request body, for example: ```json { "sql": "SELECT ID FROM ACCOUNT LIMIT 1" } ``` ## Query v2 This Mule flow shows how to send an initial query. Use this flow before [Query v2 - Get Next Batch](#query-v2-get-next-batch). For more information about the Query v2 API, refer to the [Data 360 Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-query-v2.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP POST requests with the query in the payload. - **Logger** Shows the HTTP request received from the **Listener**. - **Set Variable** Sets a variable called `sampleResults` to get a maximum sample of 10 results. Your paging calls are unaffected and this is to limit returned payloads to avoid having 40 MB large payloads on your testing calls. - **Query v2** Makes a query against the Data 360 data lake. - **Flow Reference** Makes a reference to the [Query v2 - Get Next Batch](#query-v2-get-next-batch) flow. ![Salesforce Data Cloud Connector Query v2 flow with Listener, Logger, Set Variable, Query v2, and Flow Reference](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/query-v2-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a request, for example: curl --location 'http://127.0.0.1:8081/queryv2' \\ --header 'Content-Type: application/json' \\ --data '{"sql": "SELECT assigned\_to\_uid\_\_c, campaign\_name\_\_c, cdp\_sys\_PartitionDate\_\_c, coupon\_code\_\_c, currency\_\_c, DataSource\_\_c, DataSourceObject\_\_c, expiry\_date\_\_c, sent\_\_c, value\_\_c FROM MunitQueryV2Test\_coupons\_C7876AA7\_\_dll "}' This example request returns this example response, in which you can use `nextBatchId` to get the next set of results if any are present in the [Query v2 - Get Next Batch](#query-v2-get-next-batch): { "data": \[ \[ "TorBsKqi", "kvoEyIhx", "2022-08-22 00:00:00.000 UTC", "pxMEsTAR", "GJWzpgut", "MunitQueryV2Test\_b1ed190e\_fd18\_49ce\_8813\_f2f4ad59df50", "MunitQueryV2Test\_coupons\_C7876AA7", "2022-08-22 18:28:58.905 UTC", "RkXmYcdH", "87.000000000000000000" \], \[...\] \], "startTime": "2023-03-30T15:51:44.33103Z", "endTime": "2023-03-30T15:51:46.065576Z", "rowCount": 63803, "queryId": "20230330\_155144\_13391\_5rx4m", "nextBatchId": "1449c1d1-2bf2-471d-824f-62c8f18c5c26", "done": false, "metadata": { "value\_\_c": { "type": "DECIMAL", "placeInOrder": 9, "typeCode": 3 }, "sent\_\_c": { "type": "VARCHAR", "placeInOrder": 8, "typeCode": 12 }, "assigned\_to\_uid\_\_c": { "type": "VARCHAR", "placeInOrder": 0, "typeCode": 12 }, "currency\_\_c": { "type": "VARCHAR", "placeInOrder": 4, "typeCode": 12 }, "DataSource\_\_c": { "type": "VARCHAR", "placeInOrder": 5, "typeCode": 12 }, "campaign\_name\_\_c": { "type": "VARCHAR", "placeInOrder": 1, "typeCode": 12 }, "DataSourceObject\_\_c": { "type": "VARCHAR", "placeInOrder": 6, "typeCode": 12 }, "coupon\_code\_\_c": { "type": "VARCHAR", "placeInOrder": 3, "typeCode": 12 }, "expiry\_date\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 7, "typeCode": 2014 }, "cdp\_sys\_PartitionDate\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 2, "typeCode": 2014 } } } ## Query v2 - Get Next Batch This Mule flow shows how to page through the results using the `nextBatchId` forward only cursor for Salesforce Data 360. Use this flow after [Query v2](#query-v2). For more information about the Query v2 Get Next Batch API, refer to the [Data 360 Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-get-query-v2.html). This example uses the following operations: - **HTTP Listener** Accepts data from HTTP GET requests with the query in the payload. - **Logger** Shows the HTTP request received from the **Listener**. - **Set Variable** Sets a variable called `sampleResults` to get a maximum sample of 10 results. Your paging calls are unaffected and this is to limit returned payloads to avoid having 40 MB large payloads on your testing calls. - **Query v2 - Get Next Batch** Uses a forward cursor to get more results from the [Query v2](#query-v2) and [Query v2 - Get Next Batch](#query-v2-get-next-batch) flows using `nextBatchId`. - **Flow Reference** Makes a reference to the [Query v2](#query-v2) flow. ![Salesforce Data Cloud Connector Query v2 Get Next Batch flow with Listener, Logger, Set Variable, Query v2 Get Next Batch, and Flow Reference](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/query-v2-get-next-batch.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a request, for example: curl --location 'http://127.0.0.1:8081/queryv2?nextBatchId=3e2f0036-f75b-4ee9-a29b-35d8f914e2f1' This example request returns this example response: { "data": \[ \[ "TorBsKqi", "kvoEyIhx", "2022-08-22 00:00:00.000 UTC", "pxMEsTAR", "GJWzpgut", "MunitQueryV2Test\_b1ed190e\_fd18\_49ce\_8813\_f2f4ad59df50", "MunitQueryV2Test\_coupons\_C7876AA7", "2022-08-22 18:28:58.905 UTC", "RkXmYcdH", "87.000000000000000000" \], \[...\] \], "startTime": "2023-03-30T15:51:44.33103Z", "endTime": "2023-03-30T15:51:46.065576Z", "rowCount": 63803, "queryId": "20230330\_155144\_13391\_5rx4m", "nextBatchId": "1449c1d1-2bf2-471d-824f-62c8f18c5c26", "done": false, "metadata": { "value\_\_c": { "type": "DECIMAL", "placeInOrder": 9, "typeCode": 3 }, "sent\_\_c": { "type": "VARCHAR", "placeInOrder": 8, "typeCode": 12 }, "assigned\_to\_uid\_\_c": { "type": "VARCHAR", "placeInOrder": 0, "typeCode": 12 }, "currency\_\_c": { "type": "VARCHAR", "placeInOrder": 4, "typeCode": 12 }, "DataSource\_\_c": { "type": "VARCHAR", "placeInOrder": 5, "typeCode": 12 }, "campaign\_name\_\_c": { "type": "VARCHAR", "placeInOrder": 1, "typeCode": 12 }, "DataSourceObject\_\_c": { "type": "VARCHAR", "placeInOrder": 6, "typeCode": 12 }, "coupon\_code\_\_c": { "type": "VARCHAR", "placeInOrder": 3, "typeCode": 12 }, "expiry\_date\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 7, "typeCode": 2014 }, "cdp\_sys\_PartitionDate\_\_c": { "type": "TIMESTAMP WITH TIME ZONE", "placeInOrder": 2, "typeCode": 2014 } } } ## Query v3 This Mule flow submits a SQL query against the Data 360 data lake. Submit the query in `ASYNC` mode to receive a query ID that the other Query v3 flows use, or in `ADAPTIVE` mode to receive rows in the same response when the query finishes quickly. For more information, refer to the [Data 360 Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/). This example uses the following operations: - **HTTP Listener** Accepts HTTP POST requests with the query in the payload. - **Logger** Shows the SQL received from the **Listener**, then shows the query status returned by the **Query v3** operation. - **Query v3** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the request body as the query, which sets `sql` and can optionally set `transferMode`. - Calls the Salesforce API and returns the result schema, rows when the query completes within the adaptive timeout, and the query status in the response header. ![Salesforce Data Cloud Connector Query v3 flow with Listener, Logger, Query v3, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/query-v3-flow.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Send a `POST` request to `localhost:8081/queryv3`: ```bash curl --location 'http://localhost:8081/queryv3' --header 'Content-Type: application/json' --data '{"sql":"SELECT ssot__id__c, ssot__name__c FROM ssot__account__dlm ORDER BY ssot__id__c LIMIT 3"}' ``` 4. This request returns the result schema and rows, for example: ```json { "metadata": { "columns": [ { "type": "varchar", "nullable": false, "name": "ssot__id__c" }, { "type": "varchar", "nullable": true, "name": "ssot__name__c" } ] }, "data": [ ["0015b000029TJB8AAO", "Updated Account 1"], ["0015b00002DySwvAAF", "Create Composite Test Account adadad662000000"], ["0015b00002LLLTFAA5", "AccountTest"] ], "returnedRows": 3 } ``` 5. To retrieve a query ID for polling, use asynchronous mode: ```bash curl --location 'http://localhost:8081/queryv3' --header 'Content-Type: application/json' --data '{"sql":"SELECT ssot__id__c, ssot__name__c, ssot__createddate__c FROM ssot__account__dlm ORDER BY ssot__id__c LIMIT 2500","transferMode":"ASYNC"}' ``` In `ASYNC` mode, the response body carries only the schema and `returnedRows` is `0`, because no rows are streamed back: ```json { "metadata": { "columns": [ { "type": "varchar", "nullable": false, "name": "ssot__id__c" }, { "type": "varchar", "nullable": true, "name": "ssot__name__c" }, { "type": "timestamptz", "nullable": true, "name": "ssot__createddate__c" } ] }, "returnedRows": 0 } ``` The response logger writes the status header, including the `queryId` used by the other Query v3 examples, for example: ```json { "queryId": "MTAuNzguNjEuMTM1Ojc0ODQ_0731d532-152c-beba-bd44-6d0dd407b4da", "completionStatus": "RUNNING", "chunkCount": 0, "rowCount": 0, "progress": 0.0 } ``` ## Query v3 - Get Status This Mule flow polls the execution status of a query submitted by [Query v3](#query-v3). Poll until `completionStatus` is `RESULTS_PRODUCED` or `FINISHED`, then retrieve the results with [Query v3 - Get Rows](#query-v3-get-rows) or [Query v3 - Get Chunk](#query-v3-get-chunk). For more information, refer to the [Data 360 Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/). This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the query ID as a URI parameter. - **Logger** Shows the query ID received from the **Listener**, then shows the returned status. - **Query v3 - Get Status** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the query ID and a wait time of 10000 milliseconds. - Calls the Salesforce API and returns the completion status, row count, chunk count, progress, and execution statistics. ![Salesforce Data Cloud Connector Query v3 Get Status flow with Listener, Logger, Query v3 Get Status, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/query-v3-get-status.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Submit a query with [Query v3](#query-v3) and copy its query ID. 4. Send a `GET` request to `localhost:8081/queryv3/{QUERY_ID}`. The operation long-polls for up to 10 seconds and returns the completion status, row count, chunk count, progress, and execution statistics: ```bash curl --location 'http://localhost:8081/queryv3/MTAuNzguNjEuMTM1Ojc0ODQ_0731d532-152c-beba-bd44-6d0dd407b4da' ``` ```json { "queryId": "MTAuNzguNjEuMTM1Ojc0ODQ_0731d532-152c-beba-bd44-6d0dd407b4da", "completionStatus": "FINISHED", "chunkCount": 1, "rowCount": 2500, "progress": 1.0, "expirationTime": "2026-08-18T06:15:05Z", "executionStats": { "wallClockTime": 0.125647841, "rowsProcessed": 41577 } } ``` ## Query v3 - Get Rows This Mule flow pages through the results of a completed query with an offset and limit. Use this flow after [Query v3](#query-v3). For large result sets, use [Query v3 - Get Chunk](#query-v3-get-chunk) instead. For more information, refer to the [Data 360 Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/). This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the query ID as a URI parameter and offset and limit as query parameters. - **Logger** Shows the query ID received from the **Listener**, then shows the returned rows. - **Query v3 - Get Rows** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the query ID, offset, and limit. The example defaults offset to `0` and limit to `10`. - Calls the Salesforce API and returns the page of rows and schema. ![Salesforce Data Cloud Connector Query v3 Get Rows flow with Listener, Logger, Query v3 Get Rows, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/query-v3-get-rows.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Submit a query with [Query v3](#query-v3) and copy its query ID. 4. Send a `GET` request to `localhost:8081/queryv3/{QUERY_ID}/rows?offset=0&limit=3`: ```bash curl --location \ 'http://localhost:8081/queryv3/MTAuNzguNjEuMTM1Ojc0ODQ_0731d532-152c-beba-bd44-6d0dd407b4da/rows?offset=0&limit=3' ``` 5. To retrieve the next page, increase `offset` by the number of rows already read, up to the `rowCount` returned by [Query v3 - Get Status](#query-v3-get-status). The response includes the schema, rows, and `returnedRows`, for example: ```json { "metadata": { "columns": [ { "name": "ssot__id__c", "type": "varchar", "nullable": false }, { "name": "ssot__name__c", "type": "varchar", "nullable": true }, { "name": "ssot__createddate__c", "type": "timestamptz", "nullable": true } ] }, "data": [ ["0015b000029TJB8AAO", "Updated Account 1", "2022-12-12T18:13:31+00:00"], [ "0015b00002DySwvAAF", "Create Composite Test Account adadad662000000", "2023-05-12T01:11:55+00:00" ], ["0015b00002LLLTFAA5", "AccountTest", "2023-11-15T11:34:47+00:00"] ], "returnedRows": 3 } ``` ## Query v3 - Get Chunk This Mule flow retrieves a chunk of a completed query result. Reading by chunk is the preferred way to consume a large result set because the service determines the chunk boundaries and streams each chunk. Chunk IDs are zero-indexed. For more information, refer to the [Data 360 Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/). This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the query ID and chunk ID as URI parameters. - **Logger** Shows the query ID and chunk ID received from the **Listener**, then shows the returned chunk. - **Query v3 - Get Chunk** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the query ID and zero-indexed chunk ID. - Calls the Salesforce API and returns the chunk rows and schema. ![Salesforce Data Cloud Connector Query v3 Get Chunk flow with Listener, Logger, Query v3 Get Chunk, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/query-v3-get-chunk.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Submit a query with [Query v3](#query-v3) and obtain its `chunkCount` from [Query v3 - Get Status](#query-v3-get-status). 4. Send a `GET` request to `localhost:8081/queryv3/{QUERY_ID}/chunks/0`: ```bash curl --location 'http://localhost:8081/queryv3/MTAuNzguNjEuMTM1Ojc0ODQ_0731d532-152c-beba-bd44-6d0dd407b4da/chunks/0' ``` The response includes the schema and all rows in the requested chunk. The `returnedRows` value can be larger than the page size used by [Query v3 - Get Rows](#query-v3-get-rows), for example: ```json { "metadata": { "columns": [ { "name": "ssot__id__c", "type": "varchar", "nullable": false }, { "name": "ssot__name__c", "type": "varchar", "nullable": true }, { "name": "ssot__createddate__c", "type": "timestamptz", "nullable": true } ] }, "data": [ ["0015b000029TJB8AAO", "Updated Account 1", "2022-12-12T18:13:31+00:00"], [ "0015b00002DySwvAAF", "Create Composite Test Account adadad662000000", "2023-05-12T01:11:55+00:00" ], ["0015b00002LLLTFAA5", "AccountTest", "2023-11-15T11:34:47+00:00"] ], "returnedRows": 2500 } ``` ## Query v3 - Get Metadata This Mule flow retrieves a query result schema without fetching rows. Use it to inspect the column names, types, and nullability before reading a large result set. For more information, refer to the [Data 360 Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/). This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the query ID as a URI parameter. - **Logger** Shows the query ID received from the **Listener**, then shows the returned schema. - **Query v3 - Get Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the query ID. - Calls the Salesforce API and returns the column definitions without data rows. ![Salesforce Data Cloud Connector Query v3 Get Metadata flow with Listener, Logger, Query v3 Get Metadata, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/query-v3-get-metadata.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Submit a query with [Query v3](#query-v3) and copy its query ID. 4. Send a `GET` request to `localhost:8081/queryv3/{QUERY_ID}/metadata`: ```bash curl --location 'http://localhost:8081/queryv3/MTAuNzguNjEuMTM1Ojc0ODQ_0731d532-152c-beba-bd44-6d0dd407b4da/metadata' ``` The response contains the result schema, for example: ```json { "metadata": { "columns": [ { "name": "ssot__id__c", "type": "varchar", "nullable": false }, { "name": "ssot__name__c", "type": "varchar", "nullable": true }, { "name": "ssot__createddate__c", "type": "timestamptz", "nullable": true } ] } } ``` ## Query v3 - Cancel This Mule flow cancels a query and frees the server resources it holds. Cancel a query when its results are no longer needed, for example, if the requesting client has timed out. For more information, refer to the [Data 360 Reference Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/). This example uses the following operations: - **HTTP Listener** Accepts HTTP DELETE requests with the query ID as a URI parameter. - **Logger** Shows the query ID received from the **Listener**, then shows the HTTP status returned by the cancel operation. - **Query v3 - Cancel** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the query ID. - Calls the Salesforce API to cancel the query. A successful call returns `204 No Content` with an empty body. ![Salesforce Data Cloud Connector Query v3 Cancel flow with Listener, Logger, Query v3 Cancel, and Response Logger](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/query-v3-cancel.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Submit a query with [Query v3](#query-v3) and copy its query ID. 4. Send a `DELETE` request to `localhost:8081/queryv3/{QUERY_ID}`: ```bash curl --location --request DELETE 'http://localhost:8081/queryv3/MTAuNzguNjEuMTM1Ojc0ODQ_7a6ce284-300e-3694-394a-55867c82422a' ``` A successful cancel returns `204 No Content` with an empty response body. The response logger writes `Cancel returned HTTP 204`. ## Insights - List Metadata API This Mule flow shows how to get the metadata, including the dimensions and filters for all calculated insights. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests. - **Insights - List Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Calls the Salesforce Data 360 API to return the metadata for all calculated insights. ![Salesforce Data Cloud Connector Insights List Metadata flow with Listener and Insights List Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/insights-list-metadata.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/insight/metadata`. ## Insights - Get Metadata API This Mule flow shows how to retrieve the metadata, including the dimensions and filters for a calculated insight. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-insights-meta-ci-name.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the calculated insight name as the required URI parameter. - **Insights - Get Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the calculated insight name. - Calls the Salesforce Data 360 API to return the metadata for the requested calculated insight. ![Salesforce Data Cloud Connector Insights Get Metadata flow with Listener and Insights Get Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/insights-get-metadata.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 ``` ### Steps for Running This Example 1. [Verify that your connector is configured.](https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-connect-an-ingestion-source.html) 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/insight/metadata/{CALCULATED_INSIGHT_NAME}`. ## Insights - Get Insights API This Mule flow shows how to query the calculated insights. Users can slice, dice, and filter by selecting different dimensions, measures, and filters. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-insights-ci-ci-name.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the calculated insight name as the required URI parameter and a combination of any optional query parameters. - **Insights - Get Insights** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the calculated insight name and any other optional URI parameters. - Calls the Salesforce Data 360 API to return the records of the requested calculated insight that match the query criteria. ![Salesforce Data Cloud Connector Insights Get Insights flow with Listener and Insights Get Insights](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/insights-get-insights.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/insight/calculated-insights/{CALCULATED_INSIGHT_NAME}`. ## Profile - List Metadata API This Mule flow shows how to retrieve the list of data model objects and their fields and category. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-meta.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests. - **Profile - List Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Calls the Salesforce Data 360 API to return the list of data model objects and their fields and category. ![Salesforce Data Cloud Connector Profile List Metadata flow with Listener and Profile List Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/profile-list-metadata.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/metadata`. ## Profile - Get Metadata API This Mule flow shows how to retrieve the metadata for a data model object. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-meta-dmname.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name as the required URI parameter. - **Profile - Get Metadata** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name. - Calls the Salesforce Data 360 API to return the metadata for the requested data model object. ![Salesforce Data Cloud Connector Profile Get Metadata flow with Listener and Profile Get Metadata](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/profile-get-metadata.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/metadata/{DATA_MODEL_NAME}`. ## Profile - Search Records API This Mule flow shows how to retrieve data model object records based on search filters. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name as the required URI parameter, fields as the required query parameter, and a combination of any other query parameters. - **Profile - Search Records** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, fields and any optional query parameters. - Calls the Salesforce Data 360 API to return the data model object records based on search filters. ![Salesforce Data Cloud Connector Profile Search Records flow with Listener and Profile Search Records](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/profile-search-records.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}?filters={FILTERS}`. ## Profile - Search Records By ID API This Mule flow shows how to retrieve data model object records based on search indexes and filters. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name and ID as the required URI parameters, and a combination of any optional query parameters. - **Profile - Search Records By Id** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, ID, and any optional query parameters. - Calls the Salesforce Data 360 API to return the data model object records based on search indexes and filters. ![Salesforce Data Cloud Connector Profile Search Records By Id flow with Listener and Profile Search Records By Id](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/profile-search-records-by-id.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}/{Id}`. ## Profile - Search Records With Child Records API This Mule flow shows how to retrieve data model object records along with child data model object records based on indexes and search filters. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id-child-dmname.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name, child data model name, and ID as the required URI parameters, and a combination of any optional query parameters. - **Profile - Search Records With Child Records** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, child data model name, ID, and any optional query parameters. - Calls the Salesforce Data 360 API to return the data model object records along with child data model object records based on indexes and search filters. ![Salesforce Data Cloud Connector Profile Search Records With Child Records flow with Listener and Profile Search Records With Child Records](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/profile-search-records-with-child-records.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}/{Id}/{CHILD_DATA_MODEL_NAME}`. ## Profile - Search Records With Insight API This Mule flow shows how to retrieve data model object records and a computed view based on indexes and search filters. Refer to the [Salesforce Data 360 API Developer Guide](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id-ci-ci-name.html) for usage and further details. This example uses the following operations: - **HTTP Listener** Accepts HTTP GET requests with the data model name, ID, and calculated insight name as the required URI parameters, and a combination of any optional query parameters. - **Profile - Search Records With Insight** - Authenticates based on your choice of OAuth Client Credentials, OAuth JWT, or OAuth Username and Password. - Receives the data model name, ID, calculated insight name, and any optional query parameters. - Calls the Salesforce Data 360 API to return the data model object records and a computed view based on indexes and search filters. ![Salesforce Data Cloud Connector Profile Search Records With Insight flow with Listener and Profile Search Records With Insight](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/profile-search-records-with-insight.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 ``` ### Steps for Running This Example 1. Verify that your connector is configured. 2. Save the project. 3. Test the flow by sending a `GET` to `localhost:8081/profile/{DATA_MODEL_NAME}/{Id}/calculated-insights/{CALCULATED_INSIGHT_NAME}`. ## Data Action Webhook This Mule flow shows how to create a webhook that logs its payload when triggered by a Data Action. Refer to the [Salesforce Data Action docs](https://help.salesforce.com/s/articleView?id=data.c360_a_data_actions.htm&type=5). This example uses the following operations: - **Data Action Webhook** Creates a webhook as the target of a Salesforce Data 360 Data Action. - **Logger** Shows the payload sent to the Data Action Webhook. ![Salesforce Data Cloud Connector Data Action Webhook flow with Data Cloud Connector Data Action Webhook and Logger Log Payload](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/data-action-webhook.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 ``` ### Steps for Running This Example 1. [Create a Streaming Insight](https://help.salesforce.com/s/articleView?id=data.c360_a_create_streaming_insight.htm&type=5). 2. [Create a Data Action Target](https://help.salesforce.com/s/articleView?id=data.c360_a_data_actions.htm&type=5) with an Action Target Type of `Webhook`. 3. [Create a Data Action](https://help.salesforce.com/s/articleView?id=data.c360_a_data_actions.htm&type=5) that uses the Data Action Target and runs on a condition against your streaming Calculated Insight. 4. Save the Mule project. 5. [Deploy your app to CloudHub.](https://docs.mulesoft.com/cloudhub/deploying-to-cloudhub) 6. Point the data action target to your application’s URL. Your application URL looks like this: `[https://{{app-name}}.{{region}}.cloudhub.io/webhook](https://{{app-name}}.{{region}}.cloudhub.io/webhook)`. 7. Trigger the data action’s condition to test the flow, and observe the logged payload. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.5 is-latest-version: true --- # Salesforce Data Cloud Connector 1.5 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Data Cloud (Salesforce Data Cloud Connector) provides Mule users with a quick and easy way to integrate with Salesforce Data 360 API endpoints. Users can automate data ingestion from third parties, query the Data 360 Data Lake, search and query customer profile information and calculated insights, and consume data action events to enrich the 360-degree view of their customers in their Data 360 instance. ## Configurations --- ### SDC Config #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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

x

Connection

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

60

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Configures an expiration policy for the configuration.

#### Connection Types ##### OAuth Client Credentials Custom connection provider for the OAuth Client Credentials flow. ###### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Array of Default Header.

Headers automatically added to every outbound request.

Query Parameters

Query parameters automatically added to every outbound request.

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

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

Token endpoint

String

URL pointing to the server responsible for providing the authentication token.

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

Data Space

String

Filters results from this data space only.

default

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

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

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

##### OAuth JWT Custom connection provider for the OAuth JWT flow. > [!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. ###### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Array of Default Header.

Headers automatically added to every outbound request.

Query Parameters

Query parameters automatically added to every outbound request.

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

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.

x

Subject

String

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

x

Audience url

String

Identifies the authorization server as an intended audience.

x

Data Space

String

Filters results from this data space only.

default

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

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

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

##### OAuth Username Password Custom connection provider for the username and password flow. ###### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Array of Default Header.

Headers automatically added to every outbound request.

Query Parameters

Query parameters automatically added to every outbound request.

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

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

Audience url

String

Identifies the authorization server as an intended audience.

x

Data Space

String

Filters results from this data space only.

default

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

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

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

### Data Action Webhook Config Configuration element for a Webhook Source. #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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

x

Connection

Connection types for this configuration.

x

Base Path

String

Base path to use for all requests that reference this configuration.

Name

String

ID of this element used for reference in other components

x

#### Connection Types ##### Listener ###### Parameters
NameTypeDescriptionDefault ValueRequired

TLS_Config

Reference to a TLS configuration element. Enables HTTPS for this configuration.

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. When using HTTPS, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, the user must configure the keystore in the tls:context child element of this listener configuration.

HTTP

Host

String

Host in which the requests are sent.

x

Port

Number

Port in which the requests are received.

x

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Connection Idle Timeout

Number

Number of milliseconds that a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled. The listener default timeout is bigger than our requester default timeout to avoid the Remotely closed exception when sending a request to an existing connection before the timeout occurs.

40000

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

## Associated Operations - [Query v3 - Cancel](#CancelQueryV3) - [Bulk - Create Job](#CreateBulkJob) - [Bulk - Delete Job](#DeleteBulkJob) - [Streaming - Delete Objects](#DeleteObjects) - [Insights - List Metadata](#GetAllCalculatedInsightMetadata) - [Bulk - Get Job](#GetBulkJob) - [Bulk - List Jobs](#GetBulkJobs) - [Insights - Get Metadata](#GetCalculatedInsightMetadata) - [Insights - Get Insights](#GetCalculatedInsightWithFiltersFieldsAndLimit) - [Profile - Search Records With Insight](#GetComputedViewForProfile) - [Profile - Get Metadata](#GetMeta) - [Profile - List Metadata](#GetMetaByCategory) - [Query v2 - Get Next Batch](#GetNextBatchAnsiSqlV2) - [Profile - Search Records By Id](#GetParent) - [Profile - Search Records With Child Records](#GetParentAndChild) - [Profile - Search Records](#GetParentWithFilters) - [Query v3 - Get Chunk](#GetQueryChunkV3) - [Query v3 - Get Metadata](#GetQueryMetadataV3) - [Query v3 - Get Rows](#GetQueryRowsV3) - [Query v3 - Get Status](#GetQueryStatusV3) - [Streaming - Insert Objects](#InsertObjects) - [Query](#Query) - [Query v2](#QueryAnsiSqlV2) - [Query v3](#QueryV3) - [Bulk - Close / Abort Job](#UpdateBulkOperationJob) - [Bulk - Upload Job Data](#UploadDataBulkJob) ## Associated Sources - [Data Action Webhook](#WebhookSource) ## Operations ## Query v3 - Cancel `` Cancels an in-progress query. Returns `204 No Content` on success. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Query ID

String

Query identifier to cancel.

x

Workload Name

String

Workload identifier for monitoring and debugging.

External Client Context

String

Additional context information as a JSON string.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Create Job `` Creates a job that represents the bulk operation for sending data to Salesforce Data 360 for asynchronous processing. This operation makes an HTTP POST request to the /ingest/jobs endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source API name

String

Name of the ingestion source API to work with.

x

Object name

String

Name of object to work with.

x

Operation

Enumeration, one of:

  • delete

  • upsert

Operation to execute.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Delete Job `` Deletes the job for the specified job ID. This operation makes an HTTP DELETE request to the /ingest/jobs/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID returned in the response body from the Create Job request.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Streaming - Delete Objects `` Deletes one or more records from Salesforce Data 360. This operation makes an HTTP DELETE request to the /ingest/sources/{source-name}/{object-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source API name

String

Ingest source API name.

x

Object name

String

Name of the collection to delete data from.

x

IDs

Array of String

Comma-separated list of IDs to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Insights - List Metadata `` The metadata includes the dimension and measure that are part of the calculated insight. This operation makes an HTTP GET request to the /insight/metadata endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Get Job `` Retrieves the job details for the specified job ID. This operation makes an HTTP GET request to the /ingest/jobs/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID returned in the response body from the Create Job request.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - List Jobs `` Retrieves all bulk jobs. This operation makes an HTTP GET request to the /ingest/jobs endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Insights - Get Metadata `` The metadata includes the dimension and measure that are part of the calculated insight. This operation makes an HTTP GET request to the /insight/metadata/{ci-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

ci_name

String

Calculated insight name, for example, IndividualChildrenCount__cio.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Insights - Get Insights `` Use this API to query the calculated insights. Users can slice, dice, and filter by selecting different dimensions, measures, and filters. This operation makes an HTTP GET request to the /insight/calculated-insights/{ci-name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

ci_name

String

Calculated insight name.

x

dimensions

String

Comma-separated list of dimensions to project. By default, this parameter includes all of the available dimensions.

measures

String

Comma-separated list of measures to project. By default, this parameter includes all of the available measures.

limit

Number

Number of items to return. The maximum number of items to return is 4999.

offset

Number

Number of rows to skip before starting to return.

filters

String

This parameter is added to a select query to select only results of a specific type.

orderby

String

Comma-separated values to sort the result set in ascending or descending order.

timeGranularity

Enumeration, one of:

  • HOUR

  • DAY

  • MONTH

  • QUARTER

  • YEAR

User-specified granularity if ci has one or more time dimensions available.

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.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records With Insight `` Returns data model objects and a computed view based on indexes and search filters. This operation makes an HTTP GET request to the /profile/{dataModelName}/{id}/calculated-insights/{ci\_name} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

id

String

Value of an indexed column.

x

ci_name

String

Calculated insight name.

x

searchKey

String

Index name if an object’s ID is different from the primary key.

dimensions

String

Comma-separated name of the dimensions to be a part of the result from the computed view. By default, this parameter includes all the dimensions.

measures

String

Comma-separated name of the measures to be a part of the result from the computed view. By default, this parameter includes all the measures.

limit

Number

Number of items to return.

filters

String

Filters are applied only on the parent object.

offset

Number

Number of rows to skip before starting to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order.

timeGranularity

Enumeration, one of:

  • HOUR

  • DAY

  • MONTH

  • QUARTER

  • YEAR

User-specified granularity if ci has one or more time dimensions available.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Get Metadata `` Returns the metadata for the data model object. The metadata includes the list of fields, data types, and indexes available for lookup. This operation makes an HTTP GET request to the /profile/metadata/{dataModelName} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - List Metadata `` Returns the list of data model objects, their fields, and category. This operation makes an HTTP GET request to the /profile/metadata endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v2 - Get Next Batch `` Returns the next batch of data from the initial POST request. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Next Batch Id

String

Get next batch of data using batchId.

x

Enable arrow stream

Enumeration is one of:

  • TRUE

  • FALSE

Determines whether to get the response data in arrow stream or JSON format. A value of true returns the data in arrow stream format.

FALSE

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.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records By Id `` Returns data model objects based on search indexes and filters. Use this API call to retrieve the object record based on the primary key or secondary keys. Returns an empty list when records are not found. This operation makes an HTTP GET request to the /profile/{dataModelName}/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

Id

String

Value of the primary or secondary key field. Defaults to the primary key when not specified.

x

searchKey

String

Name of the key field, if a field other than the primary key is used.

fields

String

Distinct comma-separated name of fields to include in the result. Not specifying this parameter returns an arbitrary set of fields.

filters

String

Set of comma-separated equality expressions, within square brackets.

limit

Number

Numbers of records to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order. This field is available in API version 52.0 and later.

offset

Number

Number of rows to skip before starting to return. This field is available in API version 52.0 and later.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records With Child Records `` Returns data model objects and child objects based on indexes and search filters. This operation makes an HTTP GET request to the /profile/{dataModelName}/{id}/{childDataModelName} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

id

String

Value of an indexed column.

x

childDataModelName

String

Child data model object API name.

x

searchKey

String

Index name if an object’s ID is different from the primary key.

fields

String

Comma-separated name of the fields of the result from the child entity. If unspecified, the first ten alphabetically-sorted fields are given.

limit

Number

Numbers of items to return.

filters

String

Filters are applied only on the parent object.

offset

Number

Number of rows to skip before starting to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Profile - Search Records `` Returns data model objects based on search filters. Use this API call to retrieve the object records after applying the selected filters. This operation makes an HTTP GET request to the /profile/{dataModelName} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

dataModelName

String

Data model object API name.

x

filters

String

Set of comma-separated equality expressions, in square brackets.

x

fields

String

Distinct comma-separated name of fields to include in the result. If unspecified, this parameter returns an arbitrary set of fields.

limit

Number

Numbers of records to return.

orderby

String

Comma-separated values to sort the result set in ascending or descending order. This field is available in API version 52.0 and later.

offset

Number

Number of rows to skip before starting to return. This field is available in API version 52.0 and later.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v3 - Get Chunk `` Retrieves a specific chunk of query results for large result sets. Use this operation when the query status indicates multiple chunks (`chunkCount > 1`). ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Query ID

String

Query identifier.

x

Chunk ID

Number

Zero-indexed chunk identifier.

x

Omit Schema

Boolean

If true, omits metadata and schema from the response.

false

Accept Header

Enumeration, one of:

  • APPLICATION_JSON

  • ARROW_IPC

Response format: JSON or Apache Arrow stream.

APPLICATION_JSON

Workload Name

String

Workload identifier for monitoring and debugging.

External Client Context

String

Additional context information as a JSON string.

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 used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request.

#[null]

Custom Headers

Object

Custom headers to include in the request.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v3 - Get Metadata `` Retrieves the schema, including column definitions, of a query result without fetching data. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Query ID

String

Query identifier.

x

Accept Header

Enumeration, one of:

  • APPLICATION_JSON

  • ARROW_IPC

Response format: JSON or Apache Arrow stream.

APPLICATION_JSON

Workload Name

String

Workload identifier for monitoring and debugging.

External Client Context

String

Additional context information as a JSON string.

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 used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request.

#[null]

Custom Headers

Object

Custom headers to include in the request.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v3 - Get Rows `` Retrieves all rows from a completed query result. Unlike chunks, this returns all data at once (for smaller result sets). ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Query ID

String

Query identifier.

x

Offset

Number

Row offset from which to start.

x

Limit

Number

Maximum number of rows to return. If omitted, the server decides.

Byte Limit

Number

Maximum byte size of the result. If omitted, the server default is 20000000.

Omit Schema

Boolean

If true, omits metadata and schema from the response.

false

Accept Header

Enumeration, one of:

  • APPLICATION_JSON

  • ARROW_IPC

Response format: JSON or Apache Arrow stream.

APPLICATION_JSON

Workload Name

String

Workload identifier for monitoring and debugging.

External Client Context

String

Additional context information as a JSON string.

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 used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request.

#[null]

Custom Headers

Object

Custom headers to include in the request.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v3 - Get Status `` Retrieves the execution status of a query. Supports long polling through the **Wait Time (ms)** parameter. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Query ID

String

Query identifier returned by the submit response.

x

Wait Time (ms)

Number

Long-polling timeout in milliseconds. The maximum is 10000.

10000

Workload Name

String

Workload identifier for monitoring and debugging.

External Client Context

String

Additional context information as a JSON string.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request.

#[null]

Custom Headers

Object

Custom headers to include in the request.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Streaming - Insert Objects `` Creates new records or updates existing records in Salesforce Data Cloud. This operation makes an HTTP POST request to the `/ingest/sources/{source-name}/{object-name}` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source API name

String

Ingest source API name.

x

Object name

String

Name of the collection to load data into.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query `` Executes a query against the specified object and returns data that matches the specified criteria. This operation makes an HTTP POST request to the /query endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v2 `` Query V2 supports SQL queries in ANSI standard and returns results as an array of records. The expected input when calling this API is free-form SQL. The input objects include data stream, profile and engagement data model objects, and unified data model objects. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Enable arrow stream

Enumeration, one of:

  • TRUE

  • FALSE

Determines whether to get the response data in arrow stream or JSON format. A value of true returns the data in arrow stream format.

FALSE

Body

Any

#[payload]

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.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Query v3 `` Executes a SQL query against Data 360 with support for asynchronous and adaptive transfer modes. Results can be returned in JSON or Apache Arrow format based on **Accept Header**. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Accept Header

Enumeration, one of:

  • APPLICATION_JSON

  • ARROW_IPC

Response format: JSON or Apache Arrow stream.

APPLICATION_JSON

Workload Name

String

Workload identifier for monitoring and debugging.

External Client Context

String

Additional context information as a JSON string.

Body

Any

Content to use.

#[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 used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request.

Custom Headers

Object

Custom headers to include in the request.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Close / Abort Job `` Closes or aborts a job given its ID. This operation makes an HTTP PATCH request to the /ingest/jobs/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Job ID

String

Job ID returned in the response body from the Create Job request.

x

State

Enumeration, one of:

  • Aborted

  • UploadComplete

New state for the job.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Bulk - Upload Job Data `` Uploads data for a job using CSV data you provide. This operation makes an HTTP PUT request to the /ingest/jobs/{id}/batches endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

id

String

Job ID returned in the response body from the Create Job request.

x

Body

String

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target 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

Attributes Type

### For Configurations - [SDC Config](#SdcConfig) ### Throws - SDC:BAD\_REQUEST - SDC:CLIENT\_ERROR - SDC:CONNECTIVITY - SDC:INTERNAL\_SERVER\_ERROR - SDC:NOT\_ACCEPTABLE - SDC:NOT\_FOUND - SDC:RETRY\_EXHAUSTED - SDC:SERVER\_ERROR - SDC:SERVICE\_UNAVAILABLE - SDC:TIMEOUT - SDC:TOO\_MANY\_REQUESTS - SDC:UNAUTHORIZED - SDC:UNSUPPORTED\_MEDIA\_TYPE ## Sources ## Data Action Webhook `` Listener for Salesforce Data 360 Data Action Webhook. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Path

String

Relative path from MuleSoft Salesforce Data 360 Data Action Webhook configuration.

/

Signing Key

String

Secret key copied from Salesforce Data 360 Data Action Target.

x

Signing Algorithm

Enumeration, one of:

  • HmacSHA256

Signing algorithm copied from Salesforce Data 360 Data Action Target.

x

Output Mime Type

String

MIME type of the payload that the operation outputs.

On Capacity Overload

Enumeration, one of:

  • FAIL

  • DROP

Strategy applied by the runtime when the flow receives more messages than it has the capacity to handle.

FAIL

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Redelivery Policy

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

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

String

### For Configurations - [Data Action Webhook Config](#SdcWebhookConfig) ## Types ### Default Header Headers automatically added to every outbound request.
FieldTypeDescriptionDefault ValueRequired

Key

String

Key for this type.

x

Value

String

Value for this type.

x

### Default Query Param Query parameters automatically added to every outbound request.
FieldTypeDescriptionDefault ValueRequired

Key

String

Key for this type.

x

Value

String

Value for this type.

x

### Proxy Configures the settings used to connect through a proxy.
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.

Non Proxy Hosts

String

### 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 how to validate certificates.

### 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, if possible.

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.

### 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, if possible.

Type

String

Type of store used.

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.

### 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

    Do not use the secondary method to check certificate validity.

  • false

    Use the method that wasn’t specified in the Prefer Crls field (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.

### 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.

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

Path

String

Path to the CRL file.

### 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.

### 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 operation source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often the Mule app attempts to reconnect to the remote service or API, in milliseconds.

Blocking

Boolean

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

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

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it is considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

### HTTP Response Attributes
FieldTypeDescriptionDefault ValueRequired

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

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

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

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

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero 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.

### 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.

### Error Mapping In each operation of your Mule flow, you can map the possible error types to a custom error type of your choosing.
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

### 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 how to identify a redelivered message and how to find out when the message was redelivered.
FieldTypeDescriptionDefault ValueRequired

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

## See Also - [Salesforce Data Cloud Connector Overview](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.3 --- # Using Anypoint Studio to Configure Salesforce Data Cloud Connector 1.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-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 in real time, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, refer to [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 Data Cloud Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/salesforce-data-cloud-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 Data Cloud 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 the **Add Dependencies to Project** window, type `salesforce Data Cloud` in the search field. 3. Click Salesforce Data Cloud in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Salesforce Data Cloud Connector: - HTTP Listener Initiates a flow each time it receives a request on the configured host and port - Scheduler Initiates a flow when a time-based condition is met For example, to configure an HTTP Listener source, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the HTTP Listener source in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On 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**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you are specifying an action for that connector to perform. To add an operation for Salesforce Data Cloud Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce Data Cloud** and then select the desired operation. 2. Drag the operation onto the Studio canvas next to the input source. ## Configure a Global Element for the Connector When you configure a connector, configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Salesforce Data Cloud system. Salesforce Data Cloud Connector supports OAuth Client Credentials, OAuth JWT, and OAuth Username Password authentication. To configure the global element for Salesforce Data Cloud Connector, follow these steps: 1. Select the operation in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the authentication method to configure: - [**OAuth Client Credentials**](#oauth-client-credentials) - [**OAuth JWT**](#oauth-jwt) - [**OAuth Username Password**](#oauth-username-password) You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, refer to [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### OAuth Client Credentials OAuth Client Credentials authentication uses OAuth 2.0 with a token endpoint for authentication. Enter this information on the **General** tab of the **Global Element Properties** screen to configure OAuth Client Credentials authentication.
FieldDescription

Consumer key

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

Consumer secret

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

Token endpoint

URL pointing to the server responsible for providing the authentication token, for example, https://domain.my.salesforce.com/services/oauth2/token.

Data Space

Filters results from this data space only.

This image shows an example of configuring OAuth Client Credentials authentication. ![OAuth Client Credentials selected in the Connection field with the authentication fields completed on the General tab](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/salesforce-sdc-studio-oauth-client-credentials.png) ### OAuth JWT OAuth JWT uses OAuth 2.0 with a JSON Web Token (JWT) request for user authentication. Enter this information on the **General** tab of the **Global Element Properties** screen to configure OAuth JWT authentication.
FieldDescription

Consumer key

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

Key store

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

Store password

Password for the keystore.

Certificate alias

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

Subject

Username of the Salesforce user.

Audience url

The URL of the authorization server.

Data Space

Filters results from this data space only.

This image shows an example of configuring OAuth JWT authentication. ![OAuth JWT selected in the Connection field with the authentication fields completed on the General tab](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/salesforce-sdc-studio-oauth-jwt.png) ### OAuth Username Password OAuth Username Password authentication uses OAuth 2.0 with a user and password for authentication. Enter this information on the **General** tab of the **Global Element Properties** screen to configure OAuth Username Password authentication.
FieldDescription

Consumer key

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

Consumer secret

Consumer secret for the connector to access Salesforce.

Username

Salesforce username.

Password

Corresponding password.

Audience url

The URL of the authorization server.

Data Space

Filters results from this data space only.

This image shows an example of configuring OAuth Username Password authentication. ![OAuth Username Password selected in the Connection field with the authentication fields completed on the General tab](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.3/_images/salesforce-sdc-studio-oauth-user-pass.png) ## Configure Additional Connector Fields After you configure a global element for Salesforce Data Cloud Connector, configure the other required fields for the connector. The required fields vary depending on which connector operation you use. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step See [Additional Configuration Information](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/salesforce-data-cloud-connector-config-topics) for more configuration steps. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Salesforce Data Cloud Connector Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.3/salesforce-data-cloud-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.4 --- # Using Anypoint Studio to Configure Salesforce Data Cloud Connector 1.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-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 in real time, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, refer to [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 Data Cloud Connector Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/salesforce-data-cloud-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 Data Cloud 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 the **Add Dependencies to Project** window, type `salesforce Data Cloud` in the search field. 3. Click Salesforce Data Cloud in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Salesforce Data Cloud Connector: - HTTP Listener Initiates a flow each time it receives a request on the configured host and port - Scheduler Initiates a flow when a time-based condition is met For example, to configure an HTTP Listener source, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the HTTP Listener source in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On 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**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you are specifying an action for that connector to perform. To add an operation for Salesforce Data Cloud Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce Data Cloud** and then select the desired operation. 2. Drag the operation onto the Studio canvas next to the input source. ## Configure a Global Element for the Connector When you configure a connector, configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Salesforce Data 360 system. Salesforce Data Cloud Connector supports OAuth Client Credentials, OAuth JWT, and OAuth Username Password authentication. To configure the global element for Salesforce Data Cloud Connector, follow these steps: 1. Select the operation in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the authentication method to configure: - [**OAuth Client Credentials**](#oauth-client-credentials) - [**OAuth JWT**](#oauth-jwt) - [**OAuth Username Password**](#oauth-username-password) You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, refer to [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### OAuth Client Credentials OAuth Client Credentials authentication uses OAuth 2.0 with a token endpoint for authentication. Enter this information on the **General** tab of the **Global Element Properties** screen to configure OAuth Client Credentials authentication.
FieldDescription

Consumer key

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

Consumer secret

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

Token endpoint

URL pointing to the server responsible for providing the authentication token, for example, https://domain.my.salesforce.com/services/oauth2/token.

Data Space

Filters results from this data space only.

This image shows an example of configuring OAuth Client Credentials authentication. ![OAuth Client Credentials selected in the Connection field with the authentication fields completed on the General tab](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/salesforce-sdc-studio-oauth-client-credentials.png) ### OAuth JWT OAuth JWT uses OAuth 2.0 with a JSON Web Token (JWT) request for user authentication. Enter this information on the **General** tab of the **Global Element Properties** screen to configure OAuth JWT authentication.
FieldDescription

Consumer key

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

Key store

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

Store password

Password for the keystore.

Certificate alias

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

Subject

Username of the Salesforce user.

Audience url

The URL of the authorization server.

Data Space

Filters results from this data space only.

This image shows an example of configuring OAuth JWT authentication. ![OAuth JWT selected in the Connection field with the authentication fields completed on the General tab](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/salesforce-sdc-studio-oauth-jwt.png) ### OAuth Username Password OAuth Username Password authentication uses OAuth 2.0 with a user and password for authentication. Enter this information on the **General** tab of the **Global Element Properties** screen to configure OAuth Username Password authentication.
FieldDescription

Consumer key

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

Consumer secret

Consumer secret for the connector to access Salesforce.

Username

Salesforce username.

Password

Corresponding password.

Audience url

The URL of the authorization server.

Data Space

Filters results from this data space only.

This image shows an example of configuring OAuth Username Password authentication. ![OAuth Username Password selected in the Connection field with the authentication fields completed on the General tab](/mulesoft/current/en-us/salesforce-data-cloud-connector/1.4/_images/salesforce-sdc-studio-oauth-user-pass.png) ## Configure Additional Connector Fields After you configure a global element for Salesforce Data Cloud Connector, configure the other required fields for the connector. The required fields vary depending on which connector operation you use. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step See [Additional Configuration Information](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/salesforce-data-cloud-connector-config-topics) for more configuration steps. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Salesforce Data Cloud Connector Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/1.4/salesforce-data-cloud-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Data Cloud Connector version: 1.5 is-latest-version: true --- # Using Anypoint Studio to Configure Salesforce Data Cloud Connector 1.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-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 in real time, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, refer to [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 Data Cloud Connector Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/salesforce-data-cloud-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 Data Cloud 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 the **Add Dependencies to Project** window, type `salesforce Data Cloud` in the search field. 3. Click Salesforce Data Cloud in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Salesforce Data Cloud Connector: - HTTP Listener Initiates a flow each time it receives a request on the configured host and port - Scheduler Initiates a flow when a time-based condition is met For example, to configure an HTTP Listener source, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the HTTP Listener source in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On 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**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you are specifying an action for that connector to perform. To add an operation for Salesforce Data Cloud Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce Data Cloud** and then select the desired operation. 2. Drag the operation onto the Studio canvas next to the input source. ## Configure a Global Element for the Connector When you configure a connector, configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Salesforce Data 360 system. Salesforce Data Cloud Connector supports OAuth Client Credentials, OAuth JWT, and OAuth Username Password authentication. To configure the global element for Salesforce Data Cloud Connector, follow these steps: 1. Select the operation in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the authentication method to configure: - [**OAuth Client Credentials**](#oauth-client-credentials) - [**OAuth JWT**](#oauth-jwt) - [**OAuth Username Password**](#oauth-username-password) You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, refer to [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### OAuth Client Credentials OAuth Client Credentials authentication uses OAuth 2.0 with a token endpoint for authentication. Enter this information on the **General** tab of the **Global Element Properties** screen to configure OAuth Client Credentials authentication.
FieldDescription

Consumer key

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

Consumer secret

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

Token endpoint

URL pointing to the server responsible for providing the authentication token, for example, https://domain.my.salesforce.com/services/oauth2/token.

Data Space

Filters results from this data space only.

This image shows an example of configuring OAuth Client Credentials authentication. ![OAuth Client Credentials selected in the Connection field with the authentication fields completed on the General tab](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/salesforce-sdc-studio-oauth-client-credentials.png) ### OAuth JWT 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. Enter this information on the **General** tab of the **Global Element Properties** screen to configure OAuth JWT authentication.
FieldDescription

Consumer key

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

Key store

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

Store password

Password for the keystore.

Certificate alias

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

Subject

Username of the Salesforce user.

Audience url

The URL of the authorization server.

Data Space

Filters results from this data space only.

This image shows an example of configuring OAuth JWT authentication. ![OAuth JWT selected in the Connection field with the authentication fields completed on the General tab](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/salesforce-sdc-studio-oauth-jwt.png) ### OAuth Username Password OAuth Username Password authentication uses OAuth 2.0 with a user and password for authentication. Enter this information on the **General** tab of the **Global Element Properties** screen to configure OAuth Username Password authentication.
FieldDescription

Consumer key

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

Consumer secret

Consumer secret for the connector to access Salesforce.

Username

Salesforce username.

Password

Corresponding password.

Audience url

The URL of the authorization server.

Data Space

Filters results from this data space only.

This image shows an example of configuring OAuth Username Password authentication. ![OAuth Username Password selected in the Connection field with the authentication fields completed on the General tab](/mulesoft/current/en-us/salesforce-data-cloud-connector/latest/_images/salesforce-sdc-studio-oauth-user-pass.png) ## Configure Additional Connector Fields After you configure a global element for Salesforce Data Cloud Connector, configure the other required fields for the connector. The required fields vary depending on which connector operation you use. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step See [Additional Configuration Information](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/salesforce-data-cloud-connector-config-topics) for more configuration steps. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Salesforce Data Cloud Connector Reference](https://docs.mulesoft.com/salesforce-data-cloud-connector/latest/salesforce-data-cloud-connector-reference) - [Salesforce Help](https://help.salesforce.com)