Salesforce Einstein Analytics Connector 3.18 Reference | MuleSoft Documentation
# Salesforce Einstein Analytics Connector 3.18 Reference
## Default Configuration
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection | 
  * Basic Username and Password
  * OAuth v2.0
  * OAuth JWT
  * OAuth 2.0 SAML Bearer

| The connection types to provide to this configuration.  
Expiration Policy |  ExpirationPolicy | 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.  
## Connection Types
### Basic Username and Password
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
TLS configuration | If the protocol is configured as HTTPS, then you must also configure the keystore configuration.  
Username | Username used to initialize the session.  
Password | Password used to authenticate the user.  
Security Token | User’s security token. It can be omitted if your IP has been added to the allow list on Salesforce.  
Authorization URL | Web service URL responsible for user authentication. This is the URL for the endpoint that is configured to handle SOAP authentication requests. | There is no default value, but if left empty the connector uses the latest API version  
Reconnection |  Reconnection | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
Read Timeout | 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.  
Read Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the Read Timeout. | MILLISECONDS  
Connection Timeout | 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.  
Connection Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the Connection Timeout. | MILLISECONDS  
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.  
Port of the proxy. If host is set then this property must be set and cannot be a negative number.  
Username | 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.  
Password | Password used to authenticate against the proxy.  
### 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 or Configuring OAuth 2.0 for Connectors on CloudHub.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Enumeration, one of:
  * POPUP
  * TOUCH

  
Immediate |  Enumeration, one of:  
Enumeration, one of:
  * LOGIN
  * CONSENT

  
Reconnection |  Reconnection | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
Read Timeout | 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.  
Read Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the Read Timeout. | MILLISECONDS  
Connection Timeout | 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.  
Connection Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the Connection Timeout. | MILLISECONDS  
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.  
Port of the proxy. If host is set, then this property must be set and cannot be a negative number.  
Username | 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.  
Password | Password used to authenticate against the proxy.  
Consumer Key | The OAuth consumerKey as registered with the service provider.  
Consumer Secret | The OAuth consumerSecret as registered with the service provider.  
Authorization Url | The service provider’s authorization endpoint URL. | `https://login.salesforce.com/services/oauth2/authorize`  
Access Token Url | The service provider’s accessToken endpoint URL. | `https://login.salesforce.com/services/oauth2/token`  
The OAuth scopes to request during the dance. If not provided, it defaults to those in the annotation.  
Resource Owner Id | The resourceOwnerId that each component should use if it doesn’t reference otherwise.  
The name of a flow to execute immediately before starting the OAuth dance.  
The name of a flow to execute immediately after an accessToken is received.  
Listener Config | A reference to a `<http:listener-config />` to use to create the listener that catches the access token callback endpoint.  
Callback Path | The path of the access token callback endpoint.  
Authorize Path | The path of the local HTTP endpoint that triggers the OAuth dance.  
External Callback Url | 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.  
Object Store | 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.  
### OAuth JWT
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
TLS configuration | If the protocol is configured as HTTPS, then you must also configure the keystore configuration.  
Read Timeout | Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is `0`, which means infinite.  
Read Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the Read Timeout. | MILLISECONDS  
Connection Timeout | Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is `0`, which means infinite.  
Connection Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Time unit that qualifies the Read Timeout. | MILLISECONDS  
Connection Timeout | Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is `0`, which means infinite.  
Connection Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time Unit that qualifies the Connection Timeout. | MILLISECONDS  
Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.  
Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.  
Username | 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.  
Password | Password used to authenticate against the proxy.  
Consumer Key | Consumer key for the Salesforce-connected app.  
Key Store | Path to the keystore used to sign data during authentication.  
Store Password | Password of the keystore.  
Principal | Username of the Salesforce user on whose behalf to take action.  
Token Endpoint | URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is `https://login.salesforce.com/services/oauth2/token`. If implementing for a community, the URL is `https://acme.force.com/customers/services/oauth2/token`, where `acme.force.com/customers` is your own community URL. | `https://login.salesforce.com/services/oauth2/token`  
Audience Url | Identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token. Use the authorization server’s URL for the audience value, for example: `https://login.salesforce.com`, `https://test.salesforce.com`, or `+https://community.force.com/customers=` if implementing for a community.  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
### OAuth 2.0 SAML Bearer
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
TLS configuration | If the protocol is configured as HTTPS, then you must also configure the keystore configuration.  
Read Timeout | Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. The default value is `0`, which means infinite.  
Read Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time Unit that qualifies the Read Timeout. | MILLISECONDS  
Connection Timeout | Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. The default value is `0`, which means infinite.  
Connection Timeout Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time Unit that qualifies the Connection Timeout. | MILLISECONDS  
Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.  
Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.  
Username | 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.  
Password | Password used to authenticate against the proxy.  
Consumer Key | Consumer key for Salesforce-connected app.  
Key Store | Path to the keystore used to sign data during authentication.  
Store Password | Password of the keystore.  
Principal | Username of the Salesforce user on whose behalf to take action.  
Token Endpoint | URL pointing to the server responsible for providing the authentication token. According to Salesforce, this URL is `https://login.salesforce.com/services/oauth2/token`. If implementing for a community, the URL is `https://acme.force.com/customers/services/oauth2/token`, where `acme.force.com/customers` is your own community URL. | `https://login.salesforce.com/services/oauth2/token`  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to `true`, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
#### List of Operations
  * createDataSet
  * deleteDataSet
  * startDataProcessing
  * unauthorize
  * uploadExternalData
  * 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
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Represents the type of the dataset to be created  
Operation |  Enumeration, one of:
  * APPEND
  * OVERWRITE
  * UPSERT
  * DELETE

  
Description  
Data Set Name  
Edgemart Container  
Notification Sent |  Enumeration, one of:
  * ALWAYS
  * FAILURES
  * NEVER
  * WARNINGS

  
Notification Email  
Enumeration, one of:
  * INCREMENTAL

  
Target Variable | The variable name where to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  * reconnect
  * reconnect-forever

| A retry strategy in case of connectivity errors.  
#### For Configurations
  * 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.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Data Set Id | Identifier of the dataset (InsightsExternalData ID) to delete.  
Reconnection Strategy | 
  * reconnect
  * reconnect-forever

| A retry strategy in case of connectivity errors  
#### For Configurations
  * 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
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Data Set Id | Identifier of the dataset (InsightsExternalData ID) to process.  
Reconnection Strategy | 
  * reconnect
  * reconnect-forever

| A retry strategy in case of connectivity errors  
#### For Configurations
  * 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
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Resource Owner Id | The ID of the resource owner for whom to invalidate access  
#### For Configurations
  * salesforce-analytics
| A retry strategy in case of connectivity errors  
#### For Configurations
  * 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
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Resource Owner Id | The ID of the resource owner for whom to invalidate access  
#### For Configurations
  * 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
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Data Set Id | Identifier of a dataset (InsightsExternalData ID) within the Salesforce Analytics Cloud system.  
Array of Object | List of records to insert. | `#[payload]`  
Target Variable | The variable name where to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  * reconnect
  * reconnect-forever

| A retry strategy in case of connectivity errors.  
#### Output
BulkOperationResult  
---  
#### For Configurations
  * 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
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Type of the records to insert. This automatically computes based on metadata extracted from the provided file that contains the configuration element.  
Array of Object | List of records to insert. | `#[payload]`  
Operation |  Enumeration, one of:
  * APPEND
  * DELETE
  * OVERWRITE
  * UPSERT

  
Description  
Data Set Name  
Edgemart Container  
Notification Sent |  Enumeration, one of:
  * ALWAYS
  * FAILURES
  * NEVER
  * WARNINGS

  
Notification Email  
Enumeration, one of:
  * INCREMENTAL

  
Target Variable | The variable name where to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  * reconnect
  * reconnect-forever

| A retry strategy in case of connectivity errors.  
#### For Configurations
  * 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
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enabled Protocols | A comma-separated list of protocols enabled for this context.  
Enabled Cipher Suites | A comma-separated list of cipher suites enabled for this context.  
Trust Store  
Key Store  
Revocation Check | 
  * Standard Revocation Check
  * Custom OCSP Responder

  
### Trust Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.  
Password | The password used to protect the trust store.  
The type of store used.  
Algorithm | The algorithm used by the trust store.  
Insecure | If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.  
### Key Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.  
The type of store used.  
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.  
Key Password | The password used to protect the private key.  
Password | The password used to protect the keystore.  
Algorithm | The algorithm used by the keystore.  
### Standard Revocation Check
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Only End Entities | Only verify the last element of the certificate chain.  
Prefer Crls | Try CRL instead of OCSP first.  
No Fallback | Do not use the secondary checking method (the one not selected before).  
Soft Fail | Avoid verification failure when the revocation server can not be reached or is busy.  
### Custom OCSP Responder
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The URL of the OCSP responder.  
Cert Alias | Alias of the signing certificate for the OCSP response (must be in the trust store), if present.  
### CRL File
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The path to the CRL file.  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Fails Deployment | 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.  
Reconnection Strategy | 
  * reconnect
  * reconnect-forever

| The reconnection strategy to use  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to reconnect (in milliseconds)  
The number of reconnection attempts to make  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | 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.  
Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the maxIdleTime attribute.  
### Bulk Operation Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Array of BulkItem  
Successful  
### Bulk Item
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Status Code  
Successful  
## See Also
MuleSoft Help Center