# mulesoft Salesforce Einstein Analytics Connector - Full Documentation

<!-- document id=9a48e68ffa11ab44a2a9f25138785df8aa820fc10216fa1459ae1e830c196d97 url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/index.md -->

---
product: Salesforce Einstein Analytics Connector
version: 3.18
---

# Salesforce Einstein Analytics Cloud Connector 3.18

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Salesforce Einstein Analytics Cloud (Salesforce Analytics Connector) enables
you to connect to the Salesforce Analytics Cloud application using the Salesforce External Data API.
The connector exposes convenient methods for creating, deleting, and populating datasets into the
Salesforce Analytics Cloud system. Load data into Salesforce Einstein Analytics Cloud from many
different data sources whether they are on-premise or on the cloud. Go beyond .csv files with this
connector.

For software requirements and compatibility information, see
[Salesforce Einstein Analytics Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-analytics-connector-release-notes-mule-4).

## Before You Begin

To use this connector, you must be familiar with:

- The Salesforce Einstein Analytics API

- Anypoint connectors

- Mule runtime engine (Mule)

- Elements in a Mule flow

- Global elements

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have login credentials to test your connection to your target
resource.

## POM File Information

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-sfdc-analytics-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

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 `<connector-name>`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

### Required Parameters for Basic Username Password Authentication

- Username  
  Salesforce Einstein Analytics username

- Password  
  Password that corresponds with the Salesforce Einstein Analytics username

- Security Token  
  Corresponding security token

![Basic Authentication config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/_images/salesforce-analytics-dc-basic-auth.png)

### Required Parameters for the OAuth 2.0 Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app.

- Consumer Secret  
  Consumer secret for the connector to access Salesforce.

![OAuth Authentication config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/_images/salesforce-analytics-dc-oauth.png)

### Required Parameters for the OAuth 2.0 JWT Bearer Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app

- Keystore File  
  See [Generating a Keystore File](#generating-keystore)

- Store Password  
  Password for the keystore

- Principal  
  Salesforce username

![JWT Bearer config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/_images/salesforce-analytics-dc-jwt.png)

#### Required Parameters for the OAuth 2.0 SAML Bearer Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app.

- Keystore File  
  Path to the keystore used to sign data during authentication. Note that only the Java keystore
  format is allowed.

- Store Password  
  Keystore password.

- Principal  
  Salesforce username.

![SAML Bearer config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/_images/salesforce-analytics-saml.png)

#### Generating a Keystore File

The Keystore is the path to the keystore used to sign data during authentication. The following
example shows how to generate a JKS file:

1.  Go to your Mule workspace, and open the command prompt (for Windows) or Terminal (for Mac).

2.  Type `keytool -genkeypair -alias salesforce-cert -keyalg RSA -keystore salesforce-cert.jks` and
    press enter.

3.  Enter the following details:

    - Password for the keystore

    - Your first name and last name

    - Your organization unit

    - Name of your city, state, and the two letter code of your county

      The system generates a Java keystore file containing a private or public key-pair in your
      workspace.

4.  Provide the file path for the keystore in your connector configuration.

    Type
    `keytool -exportcert -alias salesforce-cert -file salesforce-cert.crt -keystore salesforce-cert.jks`
    and press enter.

    The system now exports the public key from the keystore into the workspace. This is the public
    key that you need 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.

## Add the Connector in Studio

1.  In Studio, create a Mule project.

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

3.  In **Add Modules to Project**, type "analytics" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

### Configure the Connector in Studio

1.  Drag the desired Salesforce Analytics operation to the Studio canvas.

2.  To create a global element for the connector, on the **General** tab, configure the
    authentication as described in the authentication sections.

    The following authentication connection types are available:

    - [Username Password](#basic-authentication)

    - [OAuth 2.0](#oauth2)

    - [OAuth 2.0 JWT](#oauth2-jwt)

    - [OAuth 2.0 SAML Bearer](#oauth2-saml)

3.  Configure these fields to upload external data into new dataset and start the processing
    operation:

    - Type  
      Type of the records to insert. Select a JSON file representing the schema of the dataset to
      create.

    - Records  
      DataSense expression; the records to insert.

    - Operation  
      Specify the operation to use when you’re loading data into a dataset.

    - Description

    - Label

    - Data Set Name

      ![Upload external data operation properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/_images/salesforce-analytics-studio-upload-and-start.png)

### Username Password

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure Basic authentication:

- **Username**  
  Enter the Salesforce username.

- **Password**  
  Enter the corresponding password.

- **Security Token**  
  Enter the corresponding security token.

The following screenshot shows an example of configuring Basic authentication:

![Username Password global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/_images/salesforce-analytics-basic.png)

Figure 1. Basic authentication fields

### OAuth 2.0

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app.

- **Consumer Secret**  
  Consumer secret for the connector to access Salesforce.

The following screenshot shows an example of configuring the OAuth 2.0 authentication:

![OAuth v2.0 global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/_images/salesforce-analytics-oauth.png)

Figure 2. OAuth 2.0 authentication fields

### OAuth 2.0 JWT

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 JWT authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app

- **Keystore File**  
  See [Generating a Keystore File](#generating-keystore)

- **Store Password**  
  Password for the keystore

- **Principal**  
  Salesforce username

![OAuth JWT global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/_images/salesforce-analytics-jwt.png)

Figure 3. OAuth 2.0 JWT authentication fields

### OAuth 2.0 SAML Bearer

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 SAML Bearer authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app

- **Keystore File**  
  See [Generating a Keystore File](#generating-keystore)

  - **Store Password**  
    Password for the keystore.

  - Principal  
    Salesforce username

![OAuth 2.0 SAML Bearer global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/_images/salesforce-analytics-saml.png)

Figure 4. OAuth 2.0 SAML Bearer authentication fields

## Use Case: Studio

This use case provides an example of how to use the Salesforce Einstein Analytics Connector and
contains this end to end flow:

- Uses an HTTP Listener as the input source.

- Configures a connection using a username, password, and the security token.

- Uses a Salesforce Analytics operation with the parameters to use.

The example that follows contains these components:

- HTTP Listener, which accepts data from HTTP requests.

- Transform Message, which provides the records input data required by Salesforce Einstein Analytics
  connector.

```dataweave
%dw 2.0
output application/java
---
[
	{
		"Id": 1,
		"Country": "Country",
		"City": "City",
		"Year": 428742153,
		"Distance": 284644936,
		"Currencies":
		[
			"EUR",
			"USD"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	},
	{
		"Id": 2,
		"Country": "Country",
		"City": "City",
		"Year": 1432651434,
		"Distance": 1336594394,
		"Currencies":
		[
			"EUR",
			"USD",
			"HUF"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	}
]
```

- Salesforce Analytics Connector, which connects with Salesforce, and performs an operation to push
  data into Salesforce Einstein Analytics Cloud.

![Studio flow with Listener, Transform Message, and Upload external data into new data set and start processing](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/_images/salesforce-analytics-studio-use-case.png)

## Use Case: XML

Paste the XML code provided in this example into the Configuration XML tab in Anypoint Studio to
experiment with the flow described in the previous section.

Keep in mind that you must still provide the `metadata.json` file describing the schema of the
dataset to be created.

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:salesforce-analytics="http://www.mulesoft.org/schema/mule/salesforce-analytics"
xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
xmlns:file="http://www.mulesoft.org/schema/mule/file"
xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/file
http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/salesforce-analytics
http://www.mulesoft.org/schema/mule/salesforce-analytics/current/mule-salesforce-analytics.xsd">
 	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<salesforce-analytics:salesforce-analytics-config
	  name="Salesforce_Analytics_Salesforce_Analytics"
	  doc:name="Salesforce Analytics Salesforce Analytics" >
		<salesforce-analytics:basic-connection username="${salesforce.username}"
		   password="${salesforce.password}" securityToken="${salesforce.securityToken}"
		   url="${salesforce.url}"/>
	</salesforce-analytics:salesforce-analytics-config>
	<flow name="upload-all-in-one-with-append" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="append"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
[
	{
		"Id": 1,
		"Country": "Country",
		"City": "City",
		"Year": 428742153,
		"Distance": 284644936,
		"Currencies":
		[
			"EUR",
			"USD"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	},
	{
		"Id": 2,
		"Country": "Country",
		"City": "City",
		"Year": 1432651434,
		"Distance": 1336594394,
		"Currencies":
		[
			"EUR",
			"USD",
			"HUF"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	}
]]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing
		  doc:name="Upload external data into new data set and start processing"
		  config-ref="Salesforce_Analytics_Salesforce_Analytics" operation="APPEND"
		  description="${allInOne.dataSetDescription}" label="${allInOne.dataSetLabel}"
		  dataSetName="${allInOne.dataSetName}" edgemartContainer="${allInOne.dataSetContainerName}"
		  type="metadata.json" notificationSent="ALWAYS" notificationEmail="${notification.email}"/>
	</flow>
</mule>
```

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Einstein Analytics Connector on Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-sfdc-analytics-connector/)

- [Salesforce External Data API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/).

- For Required Parameters for Basic Username Password Authentication see
  [Salesforce Basic Authentication](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_login.htm)

- For Required Parameters for the OAuth 2.0 Configuration see
  [Salesforce OAuth 2.0](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_web_server_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 JWT Bearer Configuration see
  [Salesforce OAuth 2.0 JWT Bearer](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_jwt_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 SAML Bearer Configuration see
  [Salesforce OAuth 2.0 SAML Bearer](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_SAML_bearer_flow.htm&language=en_US&type=5)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=d7610b3fd3e5befeb88501451dcf41fb737ff1bef48ec8bfcd770e8f886cc889 url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/index.md -->

---
product: Salesforce Einstein Analytics Connector
version: 3.19
---

# Salesforce Einstein Analytics Cloud Connector 3.19

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Salesforce Einstein Analytics Cloud (Salesforce Analytics Connector) enables
you to connect to the Salesforce Analytics Cloud application using the Salesforce External Data API.
The connector exposes convenient methods for creating, deleting, and populating datasets into the
Salesforce Analytics Cloud system. Load data into Salesforce Einstein Analytics Cloud from many
different data sources whether they are on-premise or on the cloud. Go beyond .csv files with this
connector.

For software requirements and compatibility information, see
[Salesforce Einstein Analytics Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-analytics-connector-release-notes-mule-4).

## Before You Begin

To use this connector, you must be familiar with:

- The Salesforce Einstein Analytics API

- Anypoint connectors

- Mule runtime engine (Mule)

- Elements in a Mule flow

- Global elements

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have login credentials to test your connection to your target
resource.

## POM File Information

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-sfdc-analytics-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

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 `<connector-name>`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

### Required Parameters for Basic Username Password Authentication

- Username  
  Salesforce Einstein Analytics username

- Password  
  Password that corresponds with the Salesforce Einstein Analytics username

- Security Token  
  Corresponding security token

![Basic Authentication config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/_images/salesforce-analytics-dc-basic-auth.png)

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

### Required Parameters for the OAuth 2.0 Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app.

- Consumer Secret  
  Consumer secret for the connector to access Salesforce.

![OAuth Authentication config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/_images/salesforce-analytics-dc-oauth.png)

### Required Parameters for the OAuth 2.0 JWT Bearer Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app

- Keystore File  
  See [Generating a Keystore File](#generating-keystore)

- Store Password  
  Password for the keystore

- Principal  
  Salesforce username

![JWT Bearer config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/_images/salesforce-analytics-dc-jwt.png)

#### Required Parameters for the OAuth 2.0 SAML Bearer Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app.

- Keystore File  
  Path to the keystore used to sign data during authentication. Note that only the Java keystore
  format is allowed.

- Store Password  
  Keystore password.

- Principal  
  Salesforce username.

![SAML Bearer config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/_images/salesforce-analytics-saml.png)

#### Generating a Keystore File

The Keystore is the path to the keystore used to sign data during authentication. The following
example shows how to generate a JKS file:

1.  Go to your Mule workspace, and open the command prompt (for Windows) or Terminal (for Mac).

2.  Type `keytool -genkeypair -alias salesforce-cert -keyalg RSA -keystore salesforce-cert.jks` and
    press enter.

3.  Enter the following details:

    - Password for the keystore

    - Your first name and last name

    - Your organization unit

    - Name of your city, state, and the two letter code of your county

      The system generates a Java keystore file containing a private or public key-pair in your
      workspace.

4.  Provide the file path for the keystore in your connector configuration.

    Type
    `keytool -exportcert -alias salesforce-cert -file salesforce-cert.crt -keystore salesforce-cert.jks`
    and press enter.

    The system now exports the public key from the keystore into the workspace. This is the public
    key that you need 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.

## Add the Connector in Studio

1.  In Studio, create a Mule project.

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

3.  In **Add Modules to Project**, type "analytics" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

### Configure the Connector in Studio

1.  Drag the desired Salesforce Analytics operation to the Studio canvas.

2.  To create a global element for the connector, on the **General** tab, configure the
    authentication as described in the authentication sections.

    The following authentication connection types are available:

    - [Username Password](#basic-authentication)

    - [OAuth 2.0](#oauth2)

    - [OAuth 2.0 JWT](#oauth2-jwt)

    - [OAuth 2.0 SAML Bearer](#oauth2-saml)

3.  Configure these fields to upload external data into new dataset and start the processing
    operation:

    - Type  
      Type of the records to insert. Select a JSON file representing the schema of the dataset to
      create.

    - Records  
      DataSense expression; the records to insert.

    - Operation  
      Specify the operation to use when you’re loading data into a dataset.

    - Description

    - Label

    - Data Set Name

      ![Upload external data operation properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/_images/salesforce-analytics-studio-upload-and-start.png)

### Username Password

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure Basic authentication:

- **Username**  
  Enter the Salesforce username.

- **Password**  
  Enter the corresponding password.

- **Security Token**  
  Enter the corresponding security token.

The following screenshot shows an example of configuring Basic authentication:

![Username Password global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/_images/salesforce-analytics-basic.png)

Figure 1. Basic authentication fields

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

### OAuth 2.0

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app.

- **Consumer Secret**  
  Consumer secret for the connector to access Salesforce.

The following screenshot shows an example of configuring the OAuth 2.0 authentication:

![OAuth v2.0 global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/_images/salesforce-analytics-oauth.png)

Figure 2. OAuth 2.0 authentication fields

### OAuth 2.0 JWT

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 JWT authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app

- **Keystore File**  
  See [Generating a Keystore File](#generating-keystore)

- **Store Password**  
  Password for the keystore

- **Principal**  
  Salesforce username

![OAuth JWT global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/_images/salesforce-analytics-jwt.png)

Figure 3. OAuth 2.0 JWT authentication fields

### OAuth 2.0 SAML Bearer

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 SAML Bearer authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app

- **Keystore File**  
  See [Generating a Keystore File](#generating-keystore)

  - **Store Password**  
    Password for the keystore.

  - Principal  
    Salesforce username

![OAuth 2.0 SAML Bearer global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/_images/salesforce-analytics-saml.png)

Figure 4. OAuth 2.0 SAML Bearer authentication fields

## Use Case: Studio

This use case provides an example of how to use the Salesforce Einstein Analytics Connector and
contains this end to end flow:

- Uses an HTTP Listener as the input source.

- Configures a connection using a username, password, and the security token.

- Uses a Salesforce Analytics operation with the parameters to use.

The example that follows contains these components:

- HTTP Listener, which accepts data from HTTP requests.

- Transform Message, which provides the records input data required by Salesforce Einstein Analytics
  connector.

```dataweave
%dw 2.0
output application/java
---
[
	{
		"Id": 1,
		"Country": "Country",
		"City": "City",
		"Year": 428742153,
		"Distance": 284644936,
		"Currencies":
		[
			"EUR",
			"USD"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	},
	{
		"Id": 2,
		"Country": "Country",
		"City": "City",
		"Year": 1432651434,
		"Distance": 1336594394,
		"Currencies":
		[
			"EUR",
			"USD",
			"HUF"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	}
]
```

- Salesforce Analytics Connector, which connects with Salesforce, and performs an operation to push
  data into Salesforce Einstein Analytics Cloud.

![Studio flow with Listener, Transform Message, and Upload external data into new data set and start processing](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/_images/salesforce-analytics-studio-use-case.png)

## Use Case: XML

Paste the XML code provided in this example into the Configuration XML tab in Anypoint Studio to
experiment with the flow described in the previous section.

Keep in mind that you must still provide the `metadata.json` file describing the schema of the
dataset to be created.

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:salesforce-analytics="http://www.mulesoft.org/schema/mule/salesforce-analytics"
xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
xmlns:file="http://www.mulesoft.org/schema/mule/file"
xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/file
http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/salesforce-analytics
http://www.mulesoft.org/schema/mule/salesforce-analytics/current/mule-salesforce-analytics.xsd">
 	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<salesforce-analytics:salesforce-analytics-config
	  name="Salesforce_Analytics_Salesforce_Analytics"
	  doc:name="Salesforce Analytics Salesforce Analytics" >
		<salesforce-analytics:basic-connection username="${salesforce.username}"
		   password="${salesforce.password}" securityToken="${salesforce.securityToken}"
		   url="${salesforce.url}"/>
	</salesforce-analytics:salesforce-analytics-config>
	<flow name="upload-all-in-one-with-append" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="append"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
[
	{
		"Id": 1,
		"Country": "Country",
		"City": "City",
		"Year": 428742153,
		"Distance": 284644936,
		"Currencies":
		[
			"EUR",
			"USD"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	},
	{
		"Id": 2,
		"Country": "Country",
		"City": "City",
		"Year": 1432651434,
		"Distance": 1336594394,
		"Currencies":
		[
			"EUR",
			"USD",
			"HUF"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	}
]]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing
		  doc:name="Upload external data into new data set and start processing"
		  config-ref="Salesforce_Analytics_Salesforce_Analytics" operation="APPEND"
		  description="${allInOne.dataSetDescription}" label="${allInOne.dataSetLabel}"
		  dataSetName="${allInOne.dataSetName}" edgemartContainer="${allInOne.dataSetContainerName}"
		  type="metadata.json" notificationSent="ALWAYS" notificationEmail="${notification.email}"/>
	</flow>
</mule>
```

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Einstein Analytics Connector on Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-sfdc-analytics-connector/)

- [Salesforce External Data API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/).

- For Required Parameters for Basic Username Password Authentication see
  [Salesforce Basic Authentication](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_login.htm)

- For Required Parameters for the OAuth 2.0 Configuration see
  [Salesforce OAuth 2.0](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_web_server_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 JWT Bearer Configuration see
  [Salesforce OAuth 2.0 JWT Bearer](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_jwt_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 SAML Bearer Configuration see
  [Salesforce OAuth 2.0 SAML Bearer](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_SAML_bearer_flow.htm&language=en_US&type=5)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=b4dc29b48c5164f7e9424f5195031fa6f36ad259b9d97be8de57cd0cd4c810bf url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/index.md -->

---
product: Salesforce Einstein Analytics Connector
version: 3.20
---

# Salesforce Einstein Analytics Cloud Connector 3.20

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Salesforce Einstein Analytics Cloud (Salesforce Analytics Connector) enables
you to connect to the Salesforce Analytics Cloud application using the Salesforce External Data API.
The connector exposes convenient methods for creating, deleting, and populating datasets into the
Salesforce Analytics Cloud system. Load data into Salesforce Einstein Analytics Cloud from many
different data sources whether they are on-premise or on the cloud. Go beyond .csv files with this
connector.

For software requirements and compatibility information, see
[Salesforce Einstein Analytics Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-analytics-connector-release-notes-mule-4).

## Before You Begin

To use this connector, you must be familiar with:

- The Salesforce Einstein Analytics API

- Anypoint connectors

- Mule runtime engine (Mule)

- Elements in a Mule flow

- Global elements

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have login credentials to test your connection to your target
resource.

## POM File Information

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-sfdc-analytics-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

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 `<connector-name>`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

### Required Parameters for Basic Username Password Authentication

- Username  
  Salesforce Einstein Analytics username

- Password  
  Password that corresponds with the Salesforce Einstein Analytics username

- Security Token  
  Corresponding security token

![Basic Authentication config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/_images/salesforce-analytics-dc-basic-auth.png)

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

### Required Parameters for the OAuth 2.0 Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app.

- Consumer Secret  
  Consumer secret for the connector to access Salesforce.

![OAuth Authentication config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/_images/salesforce-analytics-dc-oauth.png)

### Required Parameters for the OAuth 2.0 JWT Bearer Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app

- Keystore File  
  See [Generating a Keystore File](#generating-keystore)

- Store Password  
  Password for the keystore

- Principal  
  Salesforce username

![JWT Bearer config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/_images/salesforce-analytics-dc-jwt.png)

#### Required Parameters for the OAuth 2.0 SAML Bearer Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app.

- Keystore File  
  Path to the keystore used to sign data during authentication. Note that only the Java keystore
  format is allowed.

- Store Password  
  Keystore password.

- Principal  
  Salesforce username.

![SAML Bearer config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/_images/salesforce-analytics-saml.png)

#### Generating a Keystore File

The Keystore is the path to the keystore used to sign data during authentication. The following
example shows how to generate a JKS file:

1.  Go to your Mule workspace, and open the command prompt (for Windows) or Terminal (for Mac).

2.  Type `keytool -genkeypair -alias salesforce-cert -keyalg RSA -keystore salesforce-cert.jks` and
    press enter.

3.  Enter the following details:

    - Password for the keystore

    - Your first name and last name

    - Your organization unit

    - Name of your city, state, and the two letter code of your county

      The system generates a Java keystore file containing a private or public key-pair in your
      workspace.

4.  Provide the file path for the keystore in your connector configuration.

    Type
    `keytool -exportcert -alias salesforce-cert -file salesforce-cert.crt -keystore salesforce-cert.jks`
    and press enter.

    The system now exports the public key from the keystore into the workspace. This is the public
    key that you need 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.

## Add the Connector in Studio

1.  In Studio, create a Mule project.

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

3.  In **Add Modules to Project**, type "analytics" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

### Configure the Connector in Studio

1.  Drag the desired Salesforce Analytics operation to the Studio canvas.

2.  To create a global element for the connector, on the **General** tab, configure the
    authentication as described in the authentication sections.

    The following authentication connection types are available:

    - [Username Password](#basic-authentication)

    - [OAuth 2.0](#oauth2)

    - [OAuth 2.0 JWT](#oauth2-jwt)

    - [OAuth 2.0 SAML Bearer](#oauth2-saml)

3.  Configure these fields to upload external data into new dataset and start the processing
    operation:

    - Type  
      Type of the records to insert. Select a JSON file representing the schema of the dataset to
      create.

    - Records  
      DataSense expression; the records to insert.

    - Operation  
      Specify the operation to use when you’re loading data into a dataset.

    - Description

    - Label

    - Data Set Name

      ![Upload external data operation properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/_images/salesforce-analytics-studio-upload-and-start.png)

### Username Password

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure Basic authentication:

- **Username**  
  Enter the Salesforce username.

- **Password**  
  Enter the corresponding password.

- **Security Token**  
  Enter the corresponding security token.

The following screenshot shows an example of configuring Basic authentication:

![Username Password global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/_images/salesforce-analytics-basic.png)

Figure 1. Basic authentication fields

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

### OAuth 2.0

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app.

- **Consumer Secret**  
  Consumer secret for the connector to access Salesforce.

The following screenshot shows an example of configuring the OAuth 2.0 authentication:

![OAuth v2.0 global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/_images/salesforce-analytics-oauth.png)

Figure 2. OAuth 2.0 authentication fields

### OAuth 2.0 JWT

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 JWT authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app

- **Keystore File**  
  See [Generating a Keystore File](#generating-keystore)

- **Store Password**  
  Password for the keystore

- **Principal**  
  Salesforce username

![OAuth JWT global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/_images/salesforce-analytics-jwt.png)

Figure 3. OAuth 2.0 JWT authentication fields

### OAuth 2.0 SAML Bearer

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 SAML Bearer authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app

- **Keystore File**  
  See [Generating a Keystore File](#generating-keystore)

  - **Store Password**  
    Password for the keystore.

  - Principal  
    Salesforce username

![OAuth 2.0 SAML Bearer global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/_images/salesforce-analytics-saml.png)

Figure 4. OAuth 2.0 SAML Bearer authentication fields

## Use Case: Studio

This use case provides an example of how to use the Salesforce Einstein Analytics Connector and
contains this end to end flow:

- Uses an HTTP Listener as the input source.

- Configures a connection using a username, password, and the security token.

- Uses a Salesforce Analytics operation with the parameters to use.

The example that follows contains these components:

- HTTP Listener, which accepts data from HTTP requests.

- Transform Message, which provides the records input data required by Salesforce Einstein Analytics
  connector.

```dataweave
%dw 2.0
output application/java
---
[
	{
		"Id": 1,
		"Country": "Country",
		"City": "City",
		"Year": 428742153,
		"Distance": 284644936,
		"Currencies":
		[
			"EUR",
			"USD"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	},
	{
		"Id": 2,
		"Country": "Country",
		"City": "City",
		"Year": 1432651434,
		"Distance": 1336594394,
		"Currencies":
		[
			"EUR",
			"USD",
			"HUF"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	}
]
```

- Salesforce Analytics Connector, which connects with Salesforce, and performs an operation to push
  data into Salesforce Einstein Analytics Cloud.

![Studio flow with Listener, Transform Message, and Upload external data into new data set and start processing](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/_images/salesforce-analytics-studio-use-case.png)

## Use Case: XML

Paste the XML code provided in this example into the Configuration XML tab in Anypoint Studio to
experiment with the flow described in the previous section.

Keep in mind that you must still provide the `metadata.json` file describing the schema of the
dataset to be created.

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:salesforce-analytics="http://www.mulesoft.org/schema/mule/salesforce-analytics"
xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
xmlns:file="http://www.mulesoft.org/schema/mule/file"
xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/file
http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/salesforce-analytics
http://www.mulesoft.org/schema/mule/salesforce-analytics/current/mule-salesforce-analytics.xsd">
 	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<salesforce-analytics:salesforce-analytics-config
	  name="Salesforce_Analytics_Salesforce_Analytics"
	  doc:name="Salesforce Analytics Salesforce Analytics" >
		<salesforce-analytics:basic-connection username="${salesforce.username}"
		   password="${salesforce.password}" securityToken="${salesforce.securityToken}"
		   url="${salesforce.url}"/>
	</salesforce-analytics:salesforce-analytics-config>
	<flow name="upload-all-in-one-with-append" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="append"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
[
	{
		"Id": 1,
		"Country": "Country",
		"City": "City",
		"Year": 428742153,
		"Distance": 284644936,
		"Currencies":
		[
			"EUR",
			"USD"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	},
	{
		"Id": 2,
		"Country": "Country",
		"City": "City",
		"Year": 1432651434,
		"Distance": 1336594394,
		"Currencies":
		[
			"EUR",
			"USD",
			"HUF"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	}
]]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing
		  doc:name="Upload external data into new data set and start processing"
		  config-ref="Salesforce_Analytics_Salesforce_Analytics" operation="APPEND"
		  description="${allInOne.dataSetDescription}" label="${allInOne.dataSetLabel}"
		  dataSetName="${allInOne.dataSetName}" edgemartContainer="${allInOne.dataSetContainerName}"
		  type="metadata.json" notificationSent="ALWAYS" notificationEmail="${notification.email}"/>
	</flow>
</mule>
```

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Einstein Analytics Connector on Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-sfdc-analytics-connector/)

- [Salesforce External Data API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/).

- For Required Parameters for Basic Username Password Authentication see
  [Salesforce Basic Authentication](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_login.htm)

- For Required Parameters for the OAuth 2.0 Configuration see
  [Salesforce OAuth 2.0](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_web_server_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 JWT Bearer Configuration see
  [Salesforce OAuth 2.0 JWT Bearer](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_jwt_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 SAML Bearer Configuration see
  [Salesforce OAuth 2.0 SAML Bearer](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_SAML_bearer_flow.htm&language=en_US&type=5)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=6e523421bfb8774f9b0abb09b3ac2b212815fa6836b7307cc7b18fe777dc485c url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/index.md -->

---
product: Salesforce Einstein Analytics Connector
version: 3.21
---

# Salesforce Einstein Analytics Cloud Connector 3.21

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Salesforce Einstein Analytics Cloud (Salesforce Analytics Connector) enables
you to connect to the Salesforce Analytics Cloud application using the Salesforce External Data API.
The connector exposes convenient methods for creating, deleting, and populating datasets into the
Salesforce Analytics Cloud system. Load data into Salesforce Einstein Analytics Cloud from many
different data sources whether they are on-premise or on the cloud. Go beyond .csv files with this
connector.

For software requirements and compatibility information, see
[Salesforce Einstein Analytics Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-analytics-connector-release-notes-mule-4).

## Before You Begin

To use this connector, you must be familiar with:

- The Salesforce Einstein Analytics API

- Anypoint connectors

- Mule runtime engine (Mule)

- Elements in a Mule flow

- Global elements

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have login credentials to test your connection to your target
resource.

## POM File Information

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-sfdc-analytics-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

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 `<connector-name>`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

### Required Parameters for Basic Username Password Authentication

- Username  
  Salesforce Einstein Analytics username

- Password  
  Password that corresponds with the Salesforce Einstein Analytics username

- Security Token  
  Corresponding security token

![Basic Authentication config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/_images/salesforce-analytics-dc-basic-auth.png)

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

### Required Parameters for the OAuth 2.0 Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app.

- Consumer Secret  
  Consumer secret for the connector to access Salesforce.

![OAuth Authentication config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/_images/salesforce-analytics-dc-oauth.png)

### Required Parameters for the OAuth 2.0 JWT Bearer Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app

- Keystore File  
  See [Generating a Keystore File](#generating-keystore)

- Store Password  
  Password for the keystore

- Principal  
  Salesforce username

![JWT Bearer config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/_images/salesforce-analytics-dc-jwt.png)

#### Required Parameters for the OAuth 2.0 SAML Bearer Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app.

- Keystore File  
  Path to the keystore used to sign data during authentication. Note that only the Java keystore
  format is allowed.

- Store Password  
  Keystore password.

- Principal  
  Salesforce username.

![SAML Bearer config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/_images/salesforce-analytics-saml.png)

#### Generating a Keystore File

The Keystore is the path to the keystore used to sign data during authentication. The following
example shows how to generate a JKS file:

1.  Go to your Mule workspace, and open the command prompt (for Windows) or Terminal (for Mac).

2.  Type `keytool -genkeypair -alias salesforce-cert -keyalg RSA -keystore salesforce-cert.jks` and
    press enter.

3.  Enter the following details:

    - Password for the keystore

    - Your first name and last name

    - Your organization unit

    - Name of your city, state, and the two letter code of your county

      The system generates a Java keystore file containing a private or public key-pair in your
      workspace.

4.  Provide the file path for the keystore in your connector configuration.

    Type
    `keytool -exportcert -alias salesforce-cert -file salesforce-cert.crt -keystore salesforce-cert.jks`
    and press enter.

    The system now exports the public key from the keystore into the workspace. This is the public
    key that you need 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.

## Add the Connector in Studio

1.  In Studio, create a Mule project.

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

3.  In **Add Modules to Project**, type "analytics" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

### Configure the Connector in Studio

1.  Drag the desired Salesforce Analytics operation to the Studio canvas.

2.  To create a global element for the connector, on the **General** tab, configure the
    authentication as described in the authentication sections.

    The following authentication connection types are available:

    - [Username Password](#basic-authentication)

    - [OAuth 2.0](#oauth2)

    - [OAuth 2.0 JWT](#oauth2-jwt)

    - [OAuth 2.0 SAML Bearer](#oauth2-saml)

3.  Configure these fields to upload external data into new dataset and start the processing
    operation:

    - Type  
      Type of the records to insert. Select a JSON file representing the schema of the dataset to
      create.

    - Records  
      DataSense expression; the records to insert.

    - Operation  
      Specify the operation to use when you’re loading data into a dataset.

    - Description

    - Label

    - Data Set Name

      ![Upload external data operation properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/_images/salesforce-analytics-studio-upload-and-start.png)

### Username Password

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure Basic authentication:

- **Username**  
  Enter the Salesforce username.

- **Password**  
  Enter the corresponding password.

- **Security Token**  
  Enter the corresponding security token.

The following screenshot shows an example of configuring Basic authentication:

![Username Password global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/_images/salesforce-analytics-basic.png)

Figure 1. Basic authentication fields

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

### OAuth 2.0

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app.

- **Consumer Secret**  
  Consumer secret for the connector to access Salesforce.

The following screenshot shows an example of configuring the OAuth 2.0 authentication:

![OAuth v2.0 global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/_images/salesforce-analytics-oauth.png)

Figure 2. OAuth 2.0 authentication fields

### OAuth 2.0 JWT

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 JWT authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app

- **Keystore File**  
  See [Generating a Keystore File](#generating-keystore)

- **Store Password**  
  Password for the keystore

- **Principal**  
  Salesforce username

![OAuth JWT global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/_images/salesforce-analytics-jwt.png)

Figure 3. OAuth 2.0 JWT authentication fields

### OAuth 2.0 SAML Bearer

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 SAML Bearer authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app

- **Keystore File**  
  See [Generating a Keystore File](#generating-keystore)

  - **Store Password**  
    Password for the keystore.

  - Principal  
    Salesforce username

![OAuth 2.0 SAML Bearer global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/_images/salesforce-analytics-saml.png)

Figure 4. OAuth 2.0 SAML Bearer authentication fields

## Use Case: Studio

This use case provides an example of how to use the Salesforce Einstein Analytics Connector and
contains this end to end flow:

- Uses an HTTP Listener as the input source.

- Configures a connection using a username, password, and the security token.

- Uses a Salesforce Analytics operation with the parameters to use.

The example that follows contains these components:

- HTTP Listener, which accepts data from HTTP requests.

- Transform Message, which provides the records input data required by Salesforce Einstein Analytics
  connector.

```dataweave
%dw 2.0
output application/java
---
[
	{
		"Id": 1,
		"Country": "Country",
		"City": "City",
		"Year": 428742153,
		"Distance": 284644936,
		"Currencies":
		[
			"EUR",
			"USD"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	},
	{
		"Id": 2,
		"Country": "Country",
		"City": "City",
		"Year": 1432651434,
		"Distance": 1336594394,
		"Currencies":
		[
			"EUR",
			"USD",
			"HUF"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	}
]
```

- Salesforce Analytics Connector, which connects with Salesforce, and performs an operation to push
  data into Salesforce Einstein Analytics Cloud.

![Studio flow with Listener, Transform Message, and Upload external data into new data set and start processing](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/_images/salesforce-analytics-studio-use-case.png)

## Use Case: XML

Paste the XML code provided in this example into the Configuration XML tab in Anypoint Studio to
experiment with the flow described in the previous section.

Keep in mind that you must still provide the `metadata.json` file describing the schema of the
dataset to be created.

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:salesforce-analytics="http://www.mulesoft.org/schema/mule/salesforce-analytics"
xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
xmlns:file="http://www.mulesoft.org/schema/mule/file"
xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/file
http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/salesforce-analytics
http://www.mulesoft.org/schema/mule/salesforce-analytics/current/mule-salesforce-analytics.xsd">
 	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<salesforce-analytics:salesforce-analytics-config
	  name="Salesforce_Analytics_Salesforce_Analytics"
	  doc:name="Salesforce Analytics Salesforce Analytics" >
		<salesforce-analytics:basic-connection username="${salesforce.username}"
		   password="${salesforce.password}" securityToken="${salesforce.securityToken}"
		   url="${salesforce.url}"/>
	</salesforce-analytics:salesforce-analytics-config>
	<flow name="upload-all-in-one-with-append" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="append"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
[
	{
		"Id": 1,
		"Country": "Country",
		"City": "City",
		"Year": 428742153,
		"Distance": 284644936,
		"Currencies":
		[
			"EUR",
			"USD"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	},
	{
		"Id": 2,
		"Country": "Country",
		"City": "City",
		"Year": 1432651434,
		"Distance": 1336594394,
		"Currencies":
		[
			"EUR",
			"USD",
			"HUF"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	}
]]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing
		  doc:name="Upload external data into new data set and start processing"
		  config-ref="Salesforce_Analytics_Salesforce_Analytics" operation="APPEND"
		  description="${allInOne.dataSetDescription}" label="${allInOne.dataSetLabel}"
		  dataSetName="${allInOne.dataSetName}" edgemartContainer="${allInOne.dataSetContainerName}"
		  type="metadata.json" notificationSent="ALWAYS" notificationEmail="${notification.email}"/>
	</flow>
</mule>
```

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Einstein Analytics Connector on Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-sfdc-analytics-connector/)

- [Salesforce External Data API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/).

- For Required Parameters for Basic Username Password Authentication see
  [Salesforce Basic Authentication](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_login.htm)

- For Required Parameters for the OAuth 2.0 Configuration see
  [Salesforce OAuth 2.0](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_web_server_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 JWT Bearer Configuration see
  [Salesforce OAuth 2.0 JWT Bearer](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_jwt_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 SAML Bearer Configuration see
  [Salesforce OAuth 2.0 SAML Bearer](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_SAML_bearer_flow.htm&language=en_US&type=5)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=6e11d8b45c1ccf6ae2bb980555552bbd1c7ec701c98054bf4cb86a00a73db602 url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/index.md -->

---
product: Salesforce Einstein Analytics Connector
version: 4.0
is-latest-version: true
---

# Salesforce Einstein Analytics Cloud Connector 4.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Salesforce Einstein Analytics Cloud (Salesforce Analytics Connector) enables
you to connect to the Salesforce Analytics Cloud application using the Salesforce External Data API.
The connector exposes convenient methods for creating, deleting, and populating datasets into the
Salesforce Analytics Cloud system. Load data into Salesforce Einstein Analytics Cloud from many
different data sources whether they are on-premise or on the cloud. Go beyond .csv files with this
connector.

For software requirements and compatibility information, see
[Salesforce Einstein Analytics Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-analytics-connector-release-notes-mule-4).

## Before You Begin

To use this connector, you must be familiar with:

- The Salesforce Einstein Analytics API

- Anypoint connectors

- Mule runtime engine (Mule)

- Elements in a Mule flow

- Global elements

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have login credentials to test your connection to your target
resource.

## POM File Information

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-sfdc-analytics-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

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 `<connector-name>`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

### Required Parameters for Basic Username Password Authentication

- Username  
  Salesforce Einstein Analytics username

- Password  
  Password that corresponds with the Salesforce Einstein Analytics username

- Security Token  
  Corresponding security token

![Basic Authentication config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/_images/salesforce-analytics-dc-basic-auth.png)

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

### Required Parameters for the OAuth 2.0 Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app.

- Consumer Secret  
  Consumer secret for the connector to access Salesforce.

![OAuth Authentication config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/_images/salesforce-analytics-dc-oauth.png)

### Required Parameters for the OAuth Client Credentials Configuration

- Client ID  
  The OAuth client ID value as registered with the service provider.

- Client Secret  
  The OAuth client secret value as registered with the service provider.

### Required Parameters for the OAuth 2.0 JWT Bearer Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app

- Keystore File  
  See [Generating a Keystore File](#generating-keystore)

- Store Password  
  Password for the keystore

- Principal  
  Salesforce username

![JWT Bearer config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/_images/salesforce-analytics-dc-jwt.png)

#### Required Parameters for the OAuth 2.0 SAML Bearer Configuration

- Consumer Key  
  Consumer key for the Salesforce connected app.

- Keystore File  
  Path to the keystore used to sign data during authentication. Note that only the Java keystore
  format is allowed.

- Store Password  
  Keystore password.

- Principal  
  Salesforce username.

![SAML Bearer config window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/_images/salesforce-analytics-saml.png)

#### Generating a Keystore File

The Keystore is the path to the keystore used to sign data during authentication. The following
example shows how to generate a JKS file:

1.  Go to your Mule workspace, and open the command prompt (for Windows) or Terminal (for Mac).

2.  Type `keytool -genkeypair -alias salesforce-cert -keyalg RSA -keystore salesforce-cert.jks` and
    press enter.

3.  Enter the following details:

    - Password for the keystore

    - Your first name and last name

    - Your organization unit

    - Name of your city, state, and the two letter code of your county

      The system generates a Java keystore file containing a private or public key-pair in your
      workspace.

4.  Provide the file path for the keystore in your connector configuration.

    Type
    `keytool -exportcert -alias salesforce-cert -file salesforce-cert.crt -keystore salesforce-cert.jks`
    and press enter.

    The system now exports the public key from the keystore into the workspace. This is the public
    key that you need 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.

## Add the Connector in Studio

1.  In Studio, create a Mule project.

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

3.  In **Add Modules to Project**, type "analytics" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

### Configure the Connector in Studio

1.  Drag the desired Salesforce Analytics operation to the Studio canvas.

2.  To create a global element for the connector, on the **General** tab, configure the
    authentication as described in the authentication sections.

    The following authentication connection types are available:

    - [Username Password](#basic-authentication)

    - [OAuth 2.0](#oauth2)

    - [OAuth 2.0 Client Credentials](#oauth-cc)

    - [OAuth 2.0 JWT](#oauth2-jwt)

    - [OAuth 2.0 SAML Bearer](#oauth2-saml)

3.  Configure these fields to upload external data into new dataset and start the processing
    operation:

    - Type  
      Type of the records to insert. Select a JSON file representing the schema of the dataset to
      create.

    - Records  
      DataSense expression; the records to insert.

    - Operation  
      Specify the operation to use when you’re loading data into a dataset.

    - Description

    - Label

    - Data Set Name

      ![Upload external data operation properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/_images/salesforce-analytics-studio-upload-and-start.png)

### Username Password

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure Basic authentication:

- **Username**  
  Enter the Salesforce username.

- **Password**  
  Enter the corresponding password.

- **Security Token**  
  Enter the corresponding security token.

The following screenshot shows an example of configuring Basic authentication:

![Username Password global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/_images/salesforce-analytics-basic.png)

Figure 1. Basic authentication fields

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

### OAuth 2.0

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app.

- **Consumer Secret**  
  Consumer secret for the connector to access Salesforce.

The following screenshot shows an example of configuring the OAuth 2.0 authentication:

![OAuth v2.0 global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/_images/salesforce-analytics-oauth.png)

Figure 2. OAuth 2.0 authentication fields

### OAuth 2.0 Client Credentials

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 Client Credentials authentication:

- **Client ID**  
  The OAuth client ID value as registered with the service provider.

- **Client Secret**  
  The OAuth client secret value as registered with the service provider.

- **Token URL**  
  The service provider’s token endpoint URL.  
  Default: `https://{domain}.my.salesforce.com/services/oauth2/token`

The following example shows an XML configuration for OAuth 2.0 Client Credentials authentication:

```xml
<salesforce-analytics:salesforce-analytics-config
  name="Salesforce_Analytics_Config">
  <salesforce-analytics:oauth-client-credentials-connection>
    <salesforce-analytics:oauth-client-credentials
      clientId="${config-oauth-client-credentials.clientId}"
      clientSecret="${config-oauth-client-credentials.clientSecret}"
      tokenUrl="${config-oauth-client-credentials.tokenUrl}"/>
  </salesforce-analytics:oauth-client-credentials-connection>
</salesforce-analytics:salesforce-analytics-config>
```

### OAuth 2.0 JWT

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 JWT authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app

- **Keystore File**  
  See [Generating a Keystore File](#generating-keystore)

- **Store Password**  
  Password for the keystore

- **Principal**  
  Salesforce username

![OAuth JWT global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/_images/salesforce-analytics-jwt.png)

Figure 3. OAuth 2.0 JWT authentication fields

### OAuth 2.0 SAML Bearer

On the **General** tab of the **Global Element Properties** screen, enter the following information
to configure OAuth 2.0 SAML Bearer authentication:

- **Consumer Key**  
  Consumer key for the Salesforce connected app

- **Keystore File**  
  See [Generating a Keystore File](#generating-keystore)

  - **Store Password**  
    Password for the keystore.

  - Principal  
    Salesforce username

![OAuth 2.0 SAML Bearer global element properties window](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/_images/salesforce-analytics-saml.png)

Figure 4. OAuth 2.0 SAML Bearer authentication fields

## Use Case: Studio

This use case provides an example of how to use the Salesforce Einstein Analytics Connector and
contains this end to end flow:

- Uses an HTTP Listener as the input source.

- Configures a connection using a username, password, and the security token.

- Uses a Salesforce Analytics operation with the parameters to use.

The example that follows contains these components:

- HTTP Listener, which accepts data from HTTP requests.

- Transform Message, which provides the records input data required by Salesforce Einstein Analytics
  connector.

```dataweave
%dw 2.0
output application/java
---
[
	{
		"Id": 1,
		"Country": "Country",
		"City": "City",
		"Year": 428742153,
		"Distance": 284644936,
		"Currencies":
		[
			"EUR",
			"USD"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	},
	{
		"Id": 2,
		"Country": "Country",
		"City": "City",
		"Year": 1432651434,
		"Distance": 1336594394,
		"Currencies":
		[
			"EUR",
			"USD",
			"HUF"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	}
]
```

- Salesforce Analytics Connector, which connects with Salesforce, and performs an operation to push
  data into Salesforce Einstein Analytics Cloud.

![Studio flow with Listener, Transform Message, and Upload external data into new data set and start processing](/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/_images/salesforce-analytics-studio-use-case.png)

## Use Case: XML

Paste the XML code provided in this example into the Configuration XML tab in Anypoint Studio to
experiment with the flow described in the previous section.

Keep in mind that you must still provide the `metadata.json` file describing the schema of the
dataset to be created.

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:salesforce-analytics="http://www.mulesoft.org/schema/mule/salesforce-analytics"
xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
xmlns:file="http://www.mulesoft.org/schema/mule/file"
xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/file
http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/salesforce-analytics
http://www.mulesoft.org/schema/mule/salesforce-analytics/current/mule-salesforce-analytics.xsd">
 	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<salesforce-analytics:salesforce-analytics-config
	  name="Salesforce_Analytics_Salesforce_Analytics"
	  doc:name="Salesforce Analytics Salesforce Analytics" >
		<salesforce-analytics:basic-connection username="${salesforce.username}"
		   password="${salesforce.password}" securityToken="${salesforce.securityToken}"
		   url="${salesforce.url}"/>
	</salesforce-analytics:salesforce-analytics-config>
	<flow name="upload-all-in-one-with-append" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="append"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
[
	{
		"Id": 1,
		"Country": "Country",
		"City": "City",
		"Year": 428742153,
		"Distance": 284644936,
		"Currencies":
		[
			"EUR",
			"USD"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	},
	{
		"Id": 2,
		"Country": "Country",
		"City": "City",
		"Year": 1432651434,
		"Distance": 1336594394,
		"Currencies":
		[
			"EUR",
			"USD",
			"HUF"
		],
		"CreationDate": "20/12/2017" as Date {format: "dd/MM/yyyy"}
	}
]]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing
		  doc:name="Upload external data into new data set and start processing"
		  config-ref="Salesforce_Analytics_Salesforce_Analytics" operation="APPEND"
		  description="${allInOne.dataSetDescription}" label="${allInOne.dataSetLabel}"
		  dataSetName="${allInOne.dataSetName}" edgemartContainer="${allInOne.dataSetContainerName}"
		  type="metadata.json" notificationSent="ALWAYS" notificationEmail="${notification.email}"/>
	</flow>
</mule>
```

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Einstein Analytics Connector on Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-sfdc-analytics-connector/)

- [Salesforce External Data API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/).

- For Required Parameters for Basic Username Password Authentication see
  [Salesforce Basic Authentication](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_login.htm)

- For Required Parameters for the OAuth 2.0 Configuration see
  [Salesforce OAuth 2.0](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_web_server_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 Client Credentials Configuration see
  [Salesforce OAuth 2.0 Client Credentials Flow](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_client_credentials_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 JWT Bearer Configuration see
  [Salesforce OAuth 2.0 JWT Bearer](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_jwt_flow.htm&language=en_US&type=5)

- For Required Parameters for the OAuth 2.0 SAML Bearer Configuration see
  [Salesforce OAuth 2.0 SAML Bearer](https://help.salesforce.com/s/articleView?id=remoteaccess_oauth_SAML_bearer_flow.htm&language=en_US&type=5)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=fb75373c5870c0e7c052ec911dcd09272ba6b916bb38312b9308ae06594e2ed8 url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.18/salesforce-analytics-connector-reference.md -->

---
product: Salesforce Einstein Analytics Connector
version: 3.18
---

# Salesforce Einstein Analytics Connector 3.18 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Default Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p>Basic Username and Password</p></li><li><p>OAuth v2.0</p></li><li><p>OAuth JWT</p></li><li><p>OAuth 2.0 SAML Bearer</p></li></ul></div></div></td><td><p>The connection types to provide to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></td><td></td><td></td></tr></tbody></table>

## Connection Types

### Basic Username and Password

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to initialize the session.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Security Token</p></td><td><div><div><p>String</p></div></div></td><td><p>User’s security token. It can be omitted if your IP has been added to the allow list on Salesforce.</p></td><td></td><td></td></tr><tr><td><p>Authorization URL</p></td><td><div><div><p>String</p></div></div></td><td><p>Web service URL responsible for user authentication. This is the URL for the endpoint that is configured to handle SOAP authentication requests.</p></td><td><p>There is no default value, but if left empty the connector uses the latest API version</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set then no proxy is used, otherwise a proxy is used, but a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr></tbody></table>

### OAuth v2.0

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

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Display</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAGE</p></li><li><p>POPUP</p></li><li><p>TOUCH</p></li></ul></div></div></td><td></td><td><p>PAGE</p></td><td></td></tr><tr><td><p>Immediate</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>TRUE</p></li><li><p>FALSE</p></li></ul></div></div></td><td></td><td><p>FALSE</p></td><td></td></tr><tr><td><p>Prompt</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>LOGIN</p></li><li><p>CONSENT</p></li></ul></div></div></td><td></td><td><p>LOGIN</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set, then no proxy is used, otherwise a proxy is used, and a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set, then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerKey as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerSecret as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s authorization endpoint URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/authorize</code></p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s accessToken endpoint URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth scopes to request during the dance. If not provided, it defaults to those in the annotation.</p></td><td></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The resourceOwnerId that each component should use if it doesn’t reference otherwise.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately before starting the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately after an accessToken is received.</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to a <code>&lt;http:listener-config /&gt;</code> to use to create the listener that catches the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the local HTTP endpoint that triggers the OAuth dance.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Specify the URL the OAuth provider should use to access the callback if the callback endpoint is behind a proxy or will be accessed through a non-direct URL.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store to use to store each resource owner ID’s data. If not specified, the Mule automatically provisions the default object store.</p></td><td></td><td></td></tr></tbody></table>

### OAuth JWT

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. Required if using authentication against the proxy. If this property is not set, then no authentication is used against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for the Salesforce-connected app.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Salesforce user on whose behalf to take action.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is <code>https://login.salesforce.com/services/oauth2/token</code>. If implementing for a community, the URL is <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your own community URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Audience Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.</p><p>Use the authorization server’s URL for the audience value, for example: <code>https://login.salesforce.com</code>, <code>https://test.salesforce.com</code>, or <code>+https://community.force.com/customers=</code> if implementing for a community.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

### OAuth 2.0 SAML Bearer

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for Salesforce-connected app.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Salesforce user on whose behalf to take action.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is <code>https://login.salesforce.com/services/oauth2/token</code>. If implementing for a community, the URL is <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your own community URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

#### List of Operations

- [Create Data Set](#createDataSet)

- [Delete Data Set](#deleteDataSet)

- [Start Data Processing](#startDataProcessing)

- [Unauthorize](#unauthorize)

- [Upload External Data](#uploadExternalData)

- [Upload External Data Into New Dataset And Start Processing](#uploadExternalDataIntoNewDataSetAndStartProcessing)

## Operations

### Create Data Set

`<salesforce-analytics:create-data-set>`

Creates a new dataset (InsightsExternalData record) in the Salesforce Analytics Cloud system and
returns the identifier (InsightsExternalData ID) of the created dataset within the Salesforce
Analytics Cloud system.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Represents the type of the dataset to be created</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Operation</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>APPEND</p></li><li><p>OVERWRITE</p></li><li><p>UPSERT</p></li><li><p>DELETE</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Label</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Edgemart Container</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Sent</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>FAILURES</p></li><li><p>NEVER</p></li><li><p>WARNINGS</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Email</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCREMENTAL</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Mode.</p></td><td><p><code>NONE</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Delete Data Set

`<salesforce-analytics:delete-data-set>`

Deletes the specified dataset (InsightsExternalData record) from the Salesforce Analytics Cloud
system. For more information about limitations, refer to
[The InsightsExternalData Object](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/bi_ext_data_object_externaldata.htm).

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of the dataset (InsightsExternalData ID) to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Start Data Processing

`<salesforce-analytics:start-data-processing>`

Tells the Salesforce Analytics Cloud system to start processing the records uploaded at this point
into a dataset.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of the dataset (InsightsExternalData ID) to process.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Unauthorize

`<salesforce-analytics:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it’s impossible to
execute any operation for the user without repeating the authorization dance.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the resource owner for whom to invalidate access</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

### Upload External Data

`<salesforce-analytics:upload-external-data>`

Creates an InsightsExternalDataPart record. The InsightsExternalDataPart object works with the
InsightsExternalData ID. After you insert a row into the InsightsExternalData object, you can create
part objects to split up your data into parts.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of a dataset (InsightsExternalData ID) within the Salesforce Analytics Cloud system.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Records</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of records to insert.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p><a href="#BulkOperationResult">Bulk Operation Result</a></p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Upload External Data Into New Dataset And Start Processing

`<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing>`

Creates a dataset (InsightsExternalData), uploads data into InsightsExternalDataPart records, and
tells the Salesforce Analytics Cloud system to start processing the uploaded data to create the
Salesforce dataset.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Type of the records to insert. This automatically computes based on metadata extracted from the provided file that contains the configuration element.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Records</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of records to insert.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Operation</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>APPEND</p></li><li><p>DELETE</p></li><li><p>OVERWRITE</p></li><li><p>UPSERT</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Label</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Edgemart Container</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Sent</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>FAILURES</p></li><li><p>NEVER</p></li><li><p>WARNINGS</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Email</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCREMENTAL</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Mode.</p></td><td><p><code>NONE</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

## Types

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Enabled Protocols</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of protocols enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Enabled Cipher Suites</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of cipher suites enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Trust Store</p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Key Store</p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Revocation Check</p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom OCSP Responder</a></p></li><li><p><a href="#crl-file">CRL File</a></p></li></ul></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the trust store.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the trust store.</p></td><td></td><td></td></tr><tr><td><p>Insecure</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></td><td></td><td></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.</p></td><td></td><td></td></tr><tr><td><p>Key Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the private key.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the keystore.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the keystore.</p></td><td></td><td></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Only End Entities</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Only verify the last element of the certificate chain.</p></td><td></td><td></td></tr><tr><td><p>Prefer Crls</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Try CRL instead of OCSP first.</p></td><td></td><td></td></tr><tr><td><p>No Fallback</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Do not use the secondary checking method (the one not selected before).</p></td><td></td><td></td></tr><tr><td><p>Soft Fail</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></td><td></td><td></td></tr></tbody></table>

### Custom OCSP Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The URL of the OCSP responder.</p></td><td></td><td></td></tr><tr><td><p>Cert Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></td><td></td><td></td></tr></tbody></table>

### CRL File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path to the CRL file.</p></td><td></td><td></td></tr></tbody></table>

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>The reconnection strategy to use</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds)</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration.</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute.</p></td><td></td><td></td></tr></tbody></table>

### Bulk Operation Result

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Id</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Items</p></td><td><div><div><p>Array of <a href="#BulkItem">Bulk Item</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Successful</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Bulk Item

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Exception</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Id</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Message</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Payload</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Status Code</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Successful</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=6b94c3aa6e206da40a3806de6cdadf510721b58b298f6ede80ae4d23ec0ea984 url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.19/salesforce-analytics-connector-reference.md -->

---
product: Salesforce Einstein Analytics Connector
version: 3.19
---

# Salesforce Einstein Analytics Connector 3.19 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Default Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p>Basic Username and Password</p></li><li><p>OAuth v2.0</p></li><li><p>OAuth JWT</p></li><li><p>OAuth 2.0 SAML Bearer</p></li></ul></div></div></td><td><p>The connection types to provide to this configuration. Note that the <code>Username Password</code> connection type is only supported for Salesforce API v64.0 and earlier versions.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></td><td></td><td></td></tr></tbody></table>

## Connection Types

### Basic Username and Password

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to initialize the session.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Security Token</p></td><td><div><div><p>String</p></div></div></td><td><p>User’s security token. It can be omitted if your IP has been added to the allow list on Salesforce.</p></td><td></td><td></td></tr><tr><td><p>Authorization URL</p></td><td><div><div><p>String</p></div></div></td><td><p>Web service URL responsible for user authentication. This is the URL for the endpoint that is configured to handle SOAP authentication requests.</p></td><td><p>There is no default value, but if left empty the connector uses the latest API version</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set then no proxy is used, otherwise a proxy is used, but a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr></tbody></table>

### OAuth v2.0

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

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Display</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAGE</p></li><li><p>POPUP</p></li><li><p>TOUCH</p></li></ul></div></div></td><td></td><td><p>PAGE</p></td><td></td></tr><tr><td><p>Immediate</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>TRUE</p></li><li><p>FALSE</p></li></ul></div></div></td><td></td><td><p>FALSE</p></td><td></td></tr><tr><td><p>Prompt</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>LOGIN</p></li><li><p>CONSENT</p></li></ul></div></div></td><td></td><td><p>LOGIN</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set, then no proxy is used, otherwise a proxy is used, and a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set, then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerKey as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerSecret as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s authorization endpoint URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/authorize</code></p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s accessToken endpoint URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth scopes to request during the dance. If not provided, it defaults to those in the annotation.</p></td><td></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The resourceOwnerId that each component should use if it doesn’t reference otherwise.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately before starting the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately after an accessToken is received.</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to a <code>&lt;http:listener-config /&gt;</code> to use to create the listener that catches the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the local HTTP endpoint that triggers the OAuth dance.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Specify the URL the OAuth provider should use to access the callback if the callback endpoint is behind a proxy or will be accessed through a non-direct URL.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store to use to store each resource owner ID’s data. If not specified, the Mule automatically provisions the default object store.</p></td><td></td><td></td></tr></tbody></table>

### OAuth JWT

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. Required if using authentication against the proxy. If this property is not set, then no authentication is used against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for the Salesforce-connected app.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Salesforce user on whose behalf to take action.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is <code>https://login.salesforce.com/services/oauth2/token</code>. If implementing for a community, the URL is <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your own community URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Audience Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.</p><p>Use the authorization server’s URL for the audience value, for example: <code>https://login.salesforce.com</code>, <code>https://test.salesforce.com</code>, or <code>+https://community.force.com/customers=</code> if implementing for a community.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

### OAuth 2.0 SAML Bearer

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for Salesforce-connected app.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Salesforce user on whose behalf to take action.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is <code>https://login.salesforce.com/services/oauth2/token</code>. If implementing for a community, the URL is <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your own community URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

#### List of Operations

- [Create Data Set](#createDataSet)

- [Delete Data Set](#deleteDataSet)

- [Start Data Processing](#startDataProcessing)

- [Unauthorize](#unauthorize)

- [Upload External Data](#uploadExternalData)

- [Upload External Data Into New Dataset And Start Processing](#uploadExternalDataIntoNewDataSetAndStartProcessing)

## Operations

### Create Data Set

`<salesforce-analytics:create-data-set>`

Creates a new dataset (InsightsExternalData record) in the Salesforce Analytics Cloud system and
returns the identifier (InsightsExternalData ID) of the created dataset within the Salesforce
Analytics Cloud system.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Represents the type of the dataset to be created</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Operation</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>APPEND</p></li><li><p>OVERWRITE</p></li><li><p>UPSERT</p></li><li><p>DELETE</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Label</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Edgemart Container</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Sent</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>FAILURES</p></li><li><p>NEVER</p></li><li><p>WARNINGS</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Email</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCREMENTAL</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Mode.</p></td><td><p><code>NONE</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Delete Data Set

`<salesforce-analytics:delete-data-set>`

Deletes the specified dataset (InsightsExternalData record) from the Salesforce Analytics Cloud
system. For more information about limitations, refer to
[The InsightsExternalData Object](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/bi_ext_data_object_externaldata.htm).

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of the dataset (InsightsExternalData ID) to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Start Data Processing

`<salesforce-analytics:start-data-processing>`

Tells the Salesforce Analytics Cloud system to start processing the records uploaded at this point
into a dataset.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of the dataset (InsightsExternalData ID) to process.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Unauthorize

`<salesforce-analytics:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it’s impossible to
execute any operation for the user without repeating the authorization dance.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the resource owner for whom to invalidate access</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

### Upload External Data

`<salesforce-analytics:upload-external-data>`

Creates an InsightsExternalDataPart record. The InsightsExternalDataPart object works with the
InsightsExternalData ID. After you insert a row into the InsightsExternalData object, you can create
part objects to split up your data into parts.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of a dataset (InsightsExternalData ID) within the Salesforce Analytics Cloud system.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Records</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of records to insert.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p><a href="#BulkOperationResult">Bulk Operation Result</a></p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Upload External Data Into New Dataset And Start Processing

`<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing>`

Creates a dataset (InsightsExternalData), uploads data into InsightsExternalDataPart records, and
tells the Salesforce Analytics Cloud system to start processing the uploaded data to create the
Salesforce dataset.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Type of the records to insert. This automatically computes based on metadata extracted from the provided file that contains the configuration element.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Records</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of records to insert.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Operation</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>APPEND</p></li><li><p>DELETE</p></li><li><p>OVERWRITE</p></li><li><p>UPSERT</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Label</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Edgemart Container</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Sent</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>FAILURES</p></li><li><p>NEVER</p></li><li><p>WARNINGS</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Email</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCREMENTAL</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Mode.</p></td><td><p><code>NONE</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

## Types

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Enabled Protocols</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of protocols enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Enabled Cipher Suites</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of cipher suites enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Trust Store</p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Key Store</p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Revocation Check</p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom OCSP Responder</a></p></li><li><p><a href="#crl-file">CRL File</a></p></li></ul></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the trust store.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the trust store.</p></td><td></td><td></td></tr><tr><td><p>Insecure</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></td><td></td><td></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.</p></td><td></td><td></td></tr><tr><td><p>Key Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the private key.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the keystore.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the keystore.</p></td><td></td><td></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Only End Entities</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Only verify the last element of the certificate chain.</p></td><td></td><td></td></tr><tr><td><p>Prefer Crls</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Try CRL instead of OCSP first.</p></td><td></td><td></td></tr><tr><td><p>No Fallback</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Do not use the secondary checking method (the one not selected before).</p></td><td></td><td></td></tr><tr><td><p>Soft Fail</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></td><td></td><td></td></tr></tbody></table>

### Custom OCSP Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The URL of the OCSP responder.</p></td><td></td><td></td></tr><tr><td><p>Cert Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></td><td></td><td></td></tr></tbody></table>

### CRL File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path to the CRL file.</p></td><td></td><td></td></tr></tbody></table>

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>The reconnection strategy to use</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds)</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration.</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute.</p></td><td></td><td></td></tr></tbody></table>

### Bulk Operation Result

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Id</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Items</p></td><td><div><div><p>Array of <a href="#BulkItem">Bulk Item</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Successful</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Bulk Item

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Exception</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Id</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Message</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Payload</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Status Code</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Successful</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=65ce7f68cdc1617430f2a658b30fc2bb66bbf8f52ecc862d497f837ae7db8aad url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.20/salesforce-analytics-connector-reference.md -->

---
product: Salesforce Einstein Analytics Connector
version: 3.20
---

# Salesforce Einstein Analytics Connector 3.20 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Default Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p>Basic Username and Password</p></li><li><p>OAuth v2.0</p></li><li><p>OAuth JWT</p></li><li><p>OAuth 2.0 SAML Bearer</p></li></ul></div></div></td><td><p>The connection types to provide to this configuration. Note that the <code>Username Password</code> connection type is only supported for Salesforce API v64.0 and earlier versions.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></td><td></td><td></td></tr></tbody></table>

## Connection Types

### Basic Username and Password

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to initialize the session.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Security Token</p></td><td><div><div><p>String</p></div></div></td><td><p>User’s security token. It can be omitted if your IP has been added to the allow list on Salesforce.</p></td><td></td><td></td></tr><tr><td><p>Authorization URL</p></td><td><div><div><p>String</p></div></div></td><td><p>Web service URL responsible for user authentication. This is the URL for the endpoint that is configured to handle SOAP authentication requests.</p></td><td><p>There is no default value, but if left empty the connector uses the latest API version</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set then no proxy is used, otherwise a proxy is used, but a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr></tbody></table>

### OAuth v2.0

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

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Display</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAGE</p></li><li><p>POPUP</p></li><li><p>TOUCH</p></li></ul></div></div></td><td></td><td><p>PAGE</p></td><td></td></tr><tr><td><p>Immediate</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>TRUE</p></li><li><p>FALSE</p></li></ul></div></div></td><td></td><td><p>FALSE</p></td><td></td></tr><tr><td><p>Prompt</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>LOGIN</p></li><li><p>CONSENT</p></li></ul></div></div></td><td></td><td><p>LOGIN</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set, then no proxy is used, otherwise a proxy is used, and a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set, then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerKey as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerSecret as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s authorization endpoint URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/authorize</code></p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s accessToken endpoint URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth scopes to request during the dance. If not provided, it defaults to those in the annotation.</p></td><td></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The resourceOwnerId that each component should use if it doesn’t reference otherwise.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately before starting the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately after an accessToken is received.</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to a <code>&lt;http:listener-config /&gt;</code> to use to create the listener that catches the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the local HTTP endpoint that triggers the OAuth dance.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Specify the URL the OAuth provider should use to access the callback if the callback endpoint is behind a proxy or will be accessed through a non-direct URL.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store to use to store each resource owner ID’s data. If not specified, the Mule automatically provisions the default object store.</p></td><td></td><td></td></tr></tbody></table>

### OAuth JWT

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. Required if using authentication against the proxy. If this property is not set, then no authentication is used against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for the Salesforce-connected app.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Salesforce user on whose behalf to take action.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is <code>https://login.salesforce.com/services/oauth2/token</code>. If implementing for a community, the URL is <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your own community URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Audience Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.</p><p>Use the authorization server’s URL for the audience value, for example: <code>https://login.salesforce.com</code>, <code>https://test.salesforce.com</code>, or <code>+https://community.force.com/customers=</code> if implementing for a community.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

### OAuth 2.0 SAML Bearer

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for Salesforce-connected app.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Salesforce user on whose behalf to take action.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is <code>https://login.salesforce.com/services/oauth2/token</code>. If implementing for a community, the URL is <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your own community URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

#### List of Operations

- [Create Data Set](#createDataSet)

- [Delete Data Set](#deleteDataSet)

- [Start Data Processing](#startDataProcessing)

- [Unauthorize](#unauthorize)

- [Upload External Data](#uploadExternalData)

- [Upload External Data Into New Dataset And Start Processing](#uploadExternalDataIntoNewDataSetAndStartProcessing)

## Operations

### Create Data Set

`<salesforce-analytics:create-data-set>`

Creates a new dataset (InsightsExternalData record) in the Salesforce Analytics Cloud system and
returns the identifier (InsightsExternalData ID) of the created dataset within the Salesforce
Analytics Cloud system.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Represents the type of the dataset to be created</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Operation</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>APPEND</p></li><li><p>OVERWRITE</p></li><li><p>UPSERT</p></li><li><p>DELETE</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Label</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Edgemart Container</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Sent</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>FAILURES</p></li><li><p>NEVER</p></li><li><p>WARNINGS</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Email</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCREMENTAL</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Mode.</p></td><td><p><code>NONE</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Delete Data Set

`<salesforce-analytics:delete-data-set>`

Deletes the specified dataset (InsightsExternalData record) from the Salesforce Analytics Cloud
system. For more information about limitations, refer to
[The InsightsExternalData Object](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/bi_ext_data_object_externaldata.htm).

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of the dataset (InsightsExternalData ID) to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Start Data Processing

`<salesforce-analytics:start-data-processing>`

Tells the Salesforce Analytics Cloud system to start processing the records uploaded at this point
into a dataset.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of the dataset (InsightsExternalData ID) to process.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Unauthorize

`<salesforce-analytics:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it’s impossible to
execute any operation for the user without repeating the authorization dance.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the resource owner for whom to invalidate access</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

### Upload External Data

`<salesforce-analytics:upload-external-data>`

Creates an InsightsExternalDataPart record. The InsightsExternalDataPart object works with the
InsightsExternalData ID. After you insert a row into the InsightsExternalData object, you can create
part objects to split up your data into parts.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of a dataset (InsightsExternalData ID) within the Salesforce Analytics Cloud system.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Records</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of records to insert.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p><a href="#BulkOperationResult">Bulk Operation Result</a></p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Upload External Data Into New Dataset And Start Processing

`<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing>`

Creates a dataset (InsightsExternalData), uploads data into InsightsExternalDataPart records, and
tells the Salesforce Analytics Cloud system to start processing the uploaded data to create the
Salesforce dataset.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Type of the records to insert. This automatically computes based on metadata extracted from the provided file that contains the configuration element.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Records</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of records to insert.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Operation</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>APPEND</p></li><li><p>DELETE</p></li><li><p>OVERWRITE</p></li><li><p>UPSERT</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Label</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Edgemart Container</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Sent</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>FAILURES</p></li><li><p>NEVER</p></li><li><p>WARNINGS</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Email</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCREMENTAL</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Mode.</p></td><td><p><code>NONE</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

## Types

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Enabled Protocols</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of protocols enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Enabled Cipher Suites</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of cipher suites enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Trust Store</p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Key Store</p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Revocation Check</p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom OCSP Responder</a></p></li><li><p><a href="#crl-file">CRL File</a></p></li></ul></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the trust store.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the trust store.</p></td><td></td><td></td></tr><tr><td><p>Insecure</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></td><td></td><td></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.</p></td><td></td><td></td></tr><tr><td><p>Key Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the private key.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the keystore.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the keystore.</p></td><td></td><td></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Only End Entities</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Only verify the last element of the certificate chain.</p></td><td></td><td></td></tr><tr><td><p>Prefer Crls</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Try CRL instead of OCSP first.</p></td><td></td><td></td></tr><tr><td><p>No Fallback</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Do not use the secondary checking method (the one not selected before).</p></td><td></td><td></td></tr><tr><td><p>Soft Fail</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></td><td></td><td></td></tr></tbody></table>

### Custom OCSP Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The URL of the OCSP responder.</p></td><td></td><td></td></tr><tr><td><p>Cert Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></td><td></td><td></td></tr></tbody></table>

### CRL File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path to the CRL file.</p></td><td></td><td></td></tr></tbody></table>

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>The reconnection strategy to use</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds)</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration.</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute.</p></td><td></td><td></td></tr></tbody></table>

### Bulk Operation Result

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Id</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Items</p></td><td><div><div><p>Array of <a href="#BulkItem">Bulk Item</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Successful</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Bulk Item

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Exception</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Id</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Message</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Payload</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Status Code</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Successful</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=6c86436ca278780c60078042a54417ea44000765ab6698c474b9d662dd882c45 url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/3.21/salesforce-analytics-connector-reference.md -->

---
product: Salesforce Einstein Analytics Connector
version: 3.21
---

# Salesforce Einstein Analytics Connector 3.21 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Default Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p>Basic Username and Password</p></li><li><p>OAuth v2.0</p></li><li><p>OAuth JWT</p></li><li><p>OAuth 2.0 SAML Bearer</p></li></ul></div></div></td><td><p>The connection types to provide to this configuration. Note that the <code>Username Password</code> connection type is only supported for Salesforce API v64.0 and earlier versions.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of this element used to reference it in other components.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></td><td></td><td></td></tr></tbody></table>

## Connection Types

### Basic Username and Password

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to initialize the session.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Security Token</p></td><td><div><div><p>String</p></div></div></td><td><p>User’s security token. It can be omitted if your IP has been added to the allow list on Salesforce.</p></td><td></td><td></td></tr><tr><td><p>Authorization URL</p></td><td><div><div><p>String</p></div></div></td><td><p>Web service URL responsible for user authentication. This is the URL for the endpoint that is configured to handle SOAP authentication requests.</p></td><td><p>There is no default value, but if left empty the connector uses the latest API version</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set then no proxy is used, otherwise a proxy is used, but a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr></tbody></table>

### OAuth v2.0

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

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Display</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAGE</p></li><li><p>POPUP</p></li><li><p>TOUCH</p></li></ul></div></div></td><td></td><td><p>PAGE</p></td><td></td></tr><tr><td><p>Immediate</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>TRUE</p></li><li><p>FALSE</p></li></ul></div></div></td><td></td><td><p>FALSE</p></td><td></td></tr><tr><td><p>Prompt</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>LOGIN</p></li><li><p>CONSENT</p></li></ul></div></div></td><td></td><td><p>LOGIN</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set, then no proxy is used, otherwise a proxy is used, and a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set, then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerKey as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerSecret as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s authorization endpoint URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/authorize</code></p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s accessToken endpoint URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth scopes to request during the dance. If not provided, it defaults to those in the annotation.</p></td><td></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The resourceOwnerId that each component should use if it doesn’t reference otherwise.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately before starting the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately after an accessToken is received.</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to a <code>&lt;http:listener-config /&gt;</code> to use to create the listener that catches the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the local HTTP endpoint that triggers the OAuth dance.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Specify the URL the OAuth provider should use to access the callback if the callback endpoint is behind a proxy or will be accessed through a non-direct URL.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store to use to store each resource owner ID’s data. If not specified, the Mule automatically provisions the default object store.</p></td><td></td><td></td></tr></tbody></table>

### OAuth JWT

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

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. Required if using authentication against the proxy. If this property is not set, then no authentication is used against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for the Salesforce-connected app.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Salesforce user on whose behalf to take action.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is <code>https://login.salesforce.com/services/oauth2/token</code>. If implementing for a community, the URL is <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your own community URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Audience Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.</p><p>Use the authorization server’s URL for the audience value, for example: <code>https://login.salesforce.com</code>, <code>https://test.salesforce.com</code>, or <code>+https://community.force.com/customers=</code> if implementing for a community.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

### OAuth 2.0 SAML Bearer

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

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for Salesforce-connected app.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Salesforce user on whose behalf to take action.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is <code>https://login.salesforce.com/services/oauth2/token</code>. If implementing for a community, the URL is <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your own community URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

#### List of Operations

- [Create Data Set](#createDataSet)

- [Delete Data Set](#deleteDataSet)

- [Start Data Processing](#startDataProcessing)

- [Unauthorize](#unauthorize)

- [Upload External Data](#uploadExternalData)

- [Upload External Data Into New Dataset And Start Processing](#uploadExternalDataIntoNewDataSetAndStartProcessing)

## Operations

### Create Data Set

`<salesforce-analytics:create-data-set>`

Creates a new dataset (InsightsExternalData record) in the Salesforce Analytics Cloud system and
returns the identifier (InsightsExternalData ID) of the created dataset within the Salesforce
Analytics Cloud system.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Represents the type of the dataset to be created</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Operation</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>APPEND</p></li><li><p>OVERWRITE</p></li><li><p>UPSERT</p></li><li><p>DELETE</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Label</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Edgemart Container</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Sent</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>FAILURES</p></li><li><p>NEVER</p></li><li><p>WARNINGS</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Email</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCREMENTAL</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Mode.</p></td><td><p><code>NONE</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Delete Data Set

`<salesforce-analytics:delete-data-set>`

Deletes the specified dataset (InsightsExternalData record) from the Salesforce Analytics Cloud
system. For more information about limitations, refer to
[The InsightsExternalData Object](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/bi_ext_data_object_externaldata.htm).

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of the dataset (InsightsExternalData ID) to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Start Data Processing

`<salesforce-analytics:start-data-processing>`

Tells the Salesforce Analytics Cloud system to start processing the records uploaded at this point
into a dataset.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of the dataset (InsightsExternalData ID) to process.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Unauthorize

`<salesforce-analytics:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it’s impossible to
execute any operation for the user without repeating the authorization dance.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the resource owner for whom to invalidate access</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

### Upload External Data

`<salesforce-analytics:upload-external-data>`

Creates an InsightsExternalDataPart record. The InsightsExternalDataPart object works with the
InsightsExternalData ID. After you insert a row into the InsightsExternalData object, you can create
part objects to split up your data into parts.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of a dataset (InsightsExternalData ID) within the Salesforce Analytics Cloud system.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Records</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of records to insert.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p><a href="#BulkOperationResult">Bulk Operation Result</a></p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Upload External Data Into New Dataset And Start Processing

`<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing>`

Creates a dataset (InsightsExternalData), uploads data into InsightsExternalDataPart records, and
tells the Salesforce Analytics Cloud system to start processing the uploaded data to create the
Salesforce dataset.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Type of the records to insert. This automatically computes based on metadata extracted from the provided file that contains the configuration element.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Records</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of records to insert.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Operation</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>APPEND</p></li><li><p>DELETE</p></li><li><p>OVERWRITE</p></li><li><p>UPSERT</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Label</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Edgemart Container</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Sent</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>FAILURES</p></li><li><p>NEVER</p></li><li><p>WARNINGS</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Email</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCREMENTAL</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Mode.</p></td><td><p><code>NONE</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

## Types

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Enabled Protocols</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of protocols enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Enabled Cipher Suites</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of cipher suites enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Trust Store</p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Key Store</p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Revocation Check</p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom OCSP Responder</a></p></li><li><p><a href="#crl-file">CRL File</a></p></li></ul></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the trust store.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the trust store.</p></td><td></td><td></td></tr><tr><td><p>Insecure</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></td><td></td><td></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.</p></td><td></td><td></td></tr><tr><td><p>Key Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the private key.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the keystore.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the keystore.</p></td><td></td><td></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Only End Entities</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Only verify the last element of the certificate chain.</p></td><td></td><td></td></tr><tr><td><p>Prefer Crls</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Try CRL instead of OCSP first.</p></td><td></td><td></td></tr><tr><td><p>No Fallback</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Do not use the secondary checking method (the one not selected before).</p></td><td></td><td></td></tr><tr><td><p>Soft Fail</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></td><td></td><td></td></tr></tbody></table>

### Custom OCSP Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The URL of the OCSP responder.</p></td><td></td><td></td></tr><tr><td><p>Cert Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></td><td></td><td></td></tr></tbody></table>

### CRL File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path to the CRL file.</p></td><td></td><td></td></tr></tbody></table>

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>The reconnection strategy to use</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds)</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration.</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute.</p></td><td></td><td></td></tr></tbody></table>

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Source</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Target</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr></tbody></table>

### Bulk Operation Result

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Id</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Items</p></td><td><div><div><p>Array of <a href="#BulkItem">Bulk Item</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Successful</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Bulk Item

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Exception</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Id</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Message</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Payload</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Status Code</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Successful</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=03da4bea651e6264ac6b3080327fbedaa3c0cfd7f356de93008c00931d99a154 url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/salesforce-analytics-connector-reference.md -->

---
product: Salesforce Einstein Analytics Connector
version: 4.0
is-latest-version: true
---

# Salesforce Einstein Analytics Connector 4.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Default Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p>Basic Username and Password</p></li><li><p>OAuth v2.0</p></li><li><p>OAuth Client Credentials</p></li><li><p>OAuth JWT</p></li><li><p>OAuth 2.0 SAML Bearer</p></li></ul></div></div></td><td><p>The connection types to provide to this configuration. Note that the <code>Username Password</code> connection type is only supported for Salesforce API v64.0 and earlier versions.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of this element used to reference it in other components.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></td><td></td><td></td></tr></tbody></table>

## Connection Types

### Basic Username and Password

> [!NOTE] The `Username Password` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to initialize the session.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Security Token</p></td><td><div><div><p>String</p></div></div></td><td><p>User’s security token. It can be omitted if your IP has been added to the allow list on Salesforce.</p></td><td></td><td></td></tr><tr><td><p>Authorization URL</p></td><td><div><div><p>String</p></div></div></td><td><p>Web service URL responsible for user authentication. This is the URL for the endpoint that is configured to handle SOAP authentication requests.</p></td><td><p>There is no default value, but if left empty the connector uses the latest API version</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set then no proxy is used, otherwise a proxy is used, but a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr></tbody></table>

### OAuth v2.0

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

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Display</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PAGE</p></li><li><p>POPUP</p></li><li><p>TOUCH</p></li></ul></div></div></td><td></td><td><p>PAGE</p></td><td></td></tr><tr><td><p>Immediate</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>TRUE</p></li><li><p>FALSE</p></li></ul></div></div></td><td></td><td><p>FALSE</p></td><td></td></tr><tr><td><p>Prompt</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>LOGIN</p></li><li><p>CONSENT</p></li></ul></div></div></td><td></td><td><p>LOGIN</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set, then no proxy is used, otherwise a proxy is used, and a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set, then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerKey as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerSecret as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s authorization endpoint URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/authorize</code></p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s accessToken endpoint URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth scopes to request during the dance. If not provided, it defaults to those in the annotation.</p></td><td></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The resourceOwnerId that each component should use if it doesn’t reference otherwise.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately before starting the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately after an accessToken is received.</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to a <code>&lt;http:listener-config /&gt;</code> to use to create the listener that catches the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the local HTTP endpoint that triggers the OAuth dance.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Specify the URL the OAuth provider should use to access the callback if the callback endpoint is behind a proxy or will be accessed through a non-direct URL.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store to use to store each resource owner ID’s data. If not specified, the Mule automatically provisions the default object store.</p></td><td></td><td></td></tr></tbody></table>

### OAuth Client Credentials

Use the OAuth Client Credentials connection type for automated, server-to-server integrations that
don’t require user interaction.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. If this property is not set then no proxy is used, otherwise a proxy is used, but a proxy host must be specified.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If host is set then this property must be set and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Client Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth client ID as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Client Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth client secret as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s token endpoint URL.</p></td><td><p><code>https://{domain}.my.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth scopes to request during the dance. If not provided, it defaults to those in the annotation.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store.</p></td><td></td><td></td></tr></tbody></table>

### OAuth JWT

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

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. Required if using authentication against the proxy. If this property is not set, then no authentication is used against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for the Salesforce-connected app.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Salesforce user on whose behalf to take action.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is <code>https://login.salesforce.com/services/oauth2/token</code>. If implementing for a community, the URL is <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your own community URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Audience Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.</p><p>Use the authorization server’s URL for the audience value, for example: <code>https://login.salesforce.com</code>, <code>https://test.salesforce.com</code>, or <code>+https://community.force.com/customers=</code> if implementing for a community.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

### OAuth 2.0 SAML Bearer

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

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><p>If the protocol is configured as HTTPS, then you must also configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Read Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Read Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is <code>0</code>, which means infinite.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Connection Timeout Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time Unit that qualifies the Connection Timeout.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy, otherwise this value must be specified.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate against the proxy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for Salesforce-connected app.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Salesforce user on whose behalf to take action.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is <code>https://login.salesforce.com/services/oauth2/token</code>. If implementing for a community, the URL is <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your own community URL.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

#### List of Operations

- [Create Data Set](#createDataSet)

- [Delete Data Set](#deleteDataSet)

- [Start Data Processing](#startDataProcessing)

- [Unauthorize](#unauthorize)

- [Upload External Data](#uploadExternalData)

- [Upload External Data Into New Dataset And Start Processing](#uploadExternalDataIntoNewDataSetAndStartProcessing)

## Operations

### Create Data Set

`<salesforce-analytics:create-data-set>`

Creates a new dataset (InsightsExternalData record) in the Salesforce Analytics Cloud system and
returns the identifier (InsightsExternalData ID) of the created dataset within the Salesforce
Analytics Cloud system.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Represents the type of the dataset to be created</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Operation</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>APPEND</p></li><li><p>OVERWRITE</p></li><li><p>UPSERT</p></li><li><p>DELETE</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Label</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Edgemart Container</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Sent</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>FAILURES</p></li><li><p>NEVER</p></li><li><p>WARNINGS</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Email</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCREMENTAL</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Mode.</p></td><td><p><code>NONE</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Delete Data Set

`<salesforce-analytics:delete-data-set>`

Deletes the specified dataset (InsightsExternalData record) from the Salesforce Analytics Cloud
system. For more information about limitations, refer to
[The InsightsExternalData Object](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/bi_ext_data_object_externaldata.htm).

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of the dataset (InsightsExternalData ID) to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Start Data Processing

`<salesforce-analytics:start-data-processing>`

Tells the Salesforce Analytics Cloud system to start processing the records uploaded at this point
into a dataset.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of the dataset (InsightsExternalData ID) to process.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Unauthorize

`<salesforce-analytics:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it’s impossible to
execute any operation for the user without repeating the authorization dance.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the resource owner for whom to invalidate access</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

### Upload External Data

`<salesforce-analytics:upload-external-data>`

Creates an InsightsExternalDataPart record. The InsightsExternalDataPart object works with the
InsightsExternalData ID. After you insert a row into the InsightsExternalData object, you can create
part objects to split up your data into parts.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Identifier of a dataset (InsightsExternalData ID) within the Salesforce Analytics Cloud system.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Records</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of records to insert.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p><a href="#BulkOperationResult">Bulk Operation Result</a></p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

### Upload External Data Into New Dataset And Start Processing

`<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing>`

Creates a dataset (InsightsExternalData), uploads data into InsightsExternalDataPart records, and
tells the Salesforce Analytics Cloud system to start processing the uploaded data to create the
Salesforce dataset.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Type of the records to insert. This automatically computes based on metadata extracted from the provided file that contains the configuration element.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Records</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of records to insert.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Operation</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>APPEND</p></li><li><p>DELETE</p></li><li><p>OVERWRITE</p></li><li><p>UPSERT</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Label</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Data Set Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Edgemart Container</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Sent</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS</p></li><li><p>FAILURES</p></li><li><p>NEVER</p></li><li><p>WARNINGS</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Notification Email</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCREMENTAL</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Mode.</p></td><td><p><code>NONE</code></p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The variable name where to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#salesforce-analytics)

#### Throws

- SALESFORCE-ANALYTICS:CONNECTIVITY

- SALESFORCE-ANALYTICS:ERROR\_RESPONSE

- SALESFORCE-ANALYTICS:INVALID\_SESSION

- SALESFORCE-ANALYTICS:INVALID\_REQUEST\_DATA

- SALESFORCE-ANALYTICS:RETRY\_EXHAUSTED

- SALESFORCE-ANALYTICS:TRANSACTION

- SALESFORCE-ANALYTICS:UNKNOWN

## Types

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Enabled Protocols</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of protocols enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Enabled Cipher Suites</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of cipher suites enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Trust Store</p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Key Store</p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Revocation Check</p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom OCSP Responder</a></p></li><li><p><a href="#crl-file">CRL File</a></p></li></ul></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the trust store.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the trust store.</p></td><td></td><td></td></tr><tr><td><p>Insecure</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></td><td></td><td></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.</p></td><td></td><td></td></tr><tr><td><p>Key Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the private key.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the keystore.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the keystore.</p></td><td></td><td></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Only End Entities</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Only verify the last element of the certificate chain.</p></td><td></td><td></td></tr><tr><td><p>Prefer Crls</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Try CRL instead of OCSP first.</p></td><td></td><td></td></tr><tr><td><p>No Fallback</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Do not use the secondary checking method (the one not selected before).</p></td><td></td><td></td></tr><tr><td><p>Soft Fail</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></td><td></td><td></td></tr></tbody></table>

### Custom OCSP Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The URL of the OCSP responder.</p></td><td></td><td></td></tr><tr><td><p>Cert Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></td><td></td><td></td></tr></tbody></table>

### CRL File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path to the CRL file.</p></td><td></td><td></td></tr></tbody></table>

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>The reconnection strategy to use</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds)</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration.</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute.</p></td><td></td><td></td></tr></tbody></table>

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Source</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Target</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr></tbody></table>

### Bulk Operation Result

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Id</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Items</p></td><td><div><div><p>Array of <a href="#BulkItem">Bulk Item</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Successful</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Bulk Item

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Exception</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Id</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Message</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Payload</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Status Code</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Successful</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=567f019f338b3cbc108b7ed06435c484688ff3e7413d2854cba71c1d24b852a7 url=/mulesoft/current/en-us/salesforce-analytics-cloud-connector/latest/salesforce-analytics-connector-upgrade.md -->

---
product: Salesforce Einstein Analytics Connector
version: 4.0
is-latest-version: true
---

# Upgrading and Migrating Salesforce Einstein Analytics Connector to Version 4.x

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Upgrade Anypoint Connector for Salesforce Einstein Analytics Cloud (Salesforce Analytics Connector)
from version 3.x to version 4.x.

## Supported Upgrade Paths

<table><colgroup><col> <col></colgroup><thead><tr><th>From Version</th><th>To Version</th></tr></thead><tbody><tr><td><div><div><p>3.x</p></div></div></td><td><div><div><p>4.x</p></div></div></td></tr></tbody></table>

## Changes

### 4.0

- Salesforce Analytics Connector now supports the
  [OAuth Client Credentials](https://docs.mulesoft.com/salesforce-analytics-cloud-connector/latest/salesforce-analytics-connector-reference#salesforce-analytics_oauth-client-credentials)
  connection type, which enables automated, server-to-server integrations that don’t require user
  interaction.

- The **Username Password** connection type is supported for Salesforce API v64.0 and earlier
  versions only. If your integration uses the **Username Password** connection type with a
  Salesforce API version later than v64.0, migrate to a supported OAuth connection type, such as
  [OAuth 2.0](https://docs.mulesoft.com/salesforce-analytics-cloud-connector/latest/salesforce-analytics-connector-reference#salesforce-analytics_basic),
  [OAuth Client Credentials](https://docs.mulesoft.com/salesforce-analytics-cloud-connector/latest/salesforce-analytics-connector-reference#salesforce-analytics_oauth-client-credentials),
  [OAuth JWT](https://docs.mulesoft.com/salesforce-analytics-cloud-connector/latest/salesforce-analytics-connector-reference#salesforce-analytics_oauth-jwt-connection),
  or
  [OAuth SAML Bearer](https://docs.mulesoft.com/salesforce-analytics-cloud-connector/latest/salesforce-analytics-connector-reference#salesforce-analytics_oauth-saml-connection).

## Requirements

Ensure your system meets the following compatibility requirements before you perform the upgrade:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule runtime</p></td><td><p>4.6.0 and later</p></td></tr></tbody></table>

## Upgrade Prerequisites

Before you perform the upgrade, you must:

1.  Create a backup of your files, data, and configuration in case you need to restore to the
    previous version.

2.  Ensure that your Mule runtime version is 4.6.0 or later.

3.  If your app uses the **Username Password** connection type with a Salesforce API version later
    than v64.0, migrate to the **OAuth Client Credentials**, **OAuth JWT**, **OAuth SAML Bearer**,
    or **OAuth 2.0** connection type.

## Upgrade Steps

Follow these steps to perform the upgrade from Salesforce Analytics Connector 3.x to Salesforce
Analytics Connector 4.x:

1.  In Anypoint Studio, create a Mule project.

2.  In the Mule Palette view, click **Search in Exchange**.

3.  In the **Add Dependencies to Project** window, enter `Salesforce Einstein Analytics` in the
    search field.

4.  In the **Available modules** section, select **Salesforce Einstein Analytics Connector - Mule
    4** and click **Add**.

5.  Click **Finish**.

6.  Verify that the `mule-sfdc-analytics-connector` dependency version is `4.x.x` in the `pom.xml`
    file, where `x.x` is the minor release and patch version number. For example, if you are
    upgrading to v4.0, the dependency version in the `pom.xml` file should be `4.0.0`.

Studio upgrades the connector automatically.

## Verify the Upgrade

After you install the latest version of the connector, follow these steps to verify the upgrade:

1.  In Studio, verify that there are no errors in the **Problems** or **Console** views.

2.  Check the project `pom.xml` file and verify that there are no problems.

3.  Test the connection and verify that the operations work.

## Troubleshooting

If there are problems with caching the parameters and caching the metadata, try restarting Studio.

## Revert the Upgrade

If it is necessary to revert to the previous version of Salesforce Analytics Connector, change the
`mule-sfdc-analytics-connector` dependency version in the project’s `pom.xml` file to the previous
version.

You must update the project’s `pom.xml` file in Anypoint Studio.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Einstein Analytics Cloud Connector Overview](https://docs.mulesoft.com/salesforce-analytics-cloud-connector/latest/)

- [Salesforce Einstein Analytics Connector Reference](https://docs.mulesoft.com/salesforce-analytics-cloud-connector/latest/salesforce-analytics-connector-reference)

- [Salesforce Einstein Analytics Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-analytics-connector-release-notes-mule-4)