-
Basic Username and Password
-
OAuth v2.0
-
OAuth JWT
-
OAuth 2.0 SAML Bearer
Salesforce Einstein Analytics Connector Reference - Mule 4
Support Category: Select
Salesforce Analytics Connector v3.1
Release Notes: Salesforce Einstein Analytics Connector Release Notes
Default Configuration
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
||
Expiration Policy |
ExpirationPolicy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances as needed. |
Connection Types
Basic Username and Password
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Username |
String |
Username used to initialize the session. |
x |
|
Password |
String |
Password used to authenticate the user. |
x |
|
Security Token |
String |
User’s security token. It can be omitted if your IP has been white listed on Salesforce. |
||
Authorization URL |
String |
Web service URL responsible for user authentication. This is the URL for the endpoint that is configured to handle SOAP authentication requests. |
|
|
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 |
Number |
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. |
0 |
|
Connection Timeout |
Number |
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. |
0 |
|
Host |
String |
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 |
Number |
Port of the proxy. If host is set then this property must be set and cannot be a negative number. |
||
Username |
String |
Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified. |
||
Password |
String |
Password used to authenticate against the proxy. |
OAuth v2.0
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Display |
Enumeration, one of:
|
x |
||
Immediate |
Enumeration, one of:
|
FALSE |
||
Prompt |
Enumeration, one of:
|
LOGIN |
||
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 |
Number |
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. |
0 |
|
Connection Timeout |
Number |
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. |
0 |
|
Host |
String |
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 |
Number |
Port of the proxy. If host is set, then this property must be set and cannot be a negative number. |
||
Username |
String |
Username used to authenticate against the proxy. If this property is not set, then no authentication is going to be used against the proxy, otherwise this value must be specified. |
||
Password |
String |
Password used to authenticate against the proxy. |
||
Consumer Key |
String |
The OAuth consumerKey as registered with the service provider. |
x |
|
Consumer Secret |
String |
The OAuth consumerSecret as registered with the service provider. |
x |
|
Authorization Url |
String |
The service provider’s authorization endpoint URL. |
|
|
Access Token Url |
String |
The service provider’s accessToken endpoint URL. |
|
|
Scopes |
String |
The OAuth scopes to be requested during the dance. If not provided, it will default to those in the annotation. |
||
Resource Owner Id |
String |
The resourceOwnerId which each component should use if it doesn’t reference otherwise. |
||
Before |
String |
The name of a flow to be executed right before starting the OAuth dance. |
||
After |
String |
The name of a flow to be executed right after an accessToken has been received. |
||
Listener Config |
String |
A reference to a |
x |
|
Callback Path |
String |
The path of the access token callback endpoint. |
x |
|
Authorize Path |
String |
The path of the local http endpoint which triggers the OAuth dance. |
x |
|
External Callback Url |
String |
If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback. |
||
Object Store |
String |
A reference to the object store that should be used to store each resource owner ID’s data. If not specified, the runtime automatically provisions the default one. |
OAuth JWT
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Consumer Key |
String |
Consumer key for Salesforce connected app. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication. |
x |
|
Store Password |
String |
Password of key store. |
x |
|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be |
|
|
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 |
Number |
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. |
0 |
|
Connection Timeout |
Number |
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. |
0 |
|
Host |
String |
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 |
Number |
Port of the proxy. If host is set then this property must be set and cannot be a negative number. |
||
Username |
String |
Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified. |
||
Password |
String |
Password used to authenticate against the proxy. |
OAuth 2.0 SAML Bearer
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Consumer Key |
String |
Consumer key for Salesforce connected app. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication. |
x |
|
Store Password |
String |
Password of key store. |
x |
|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be |
|
|
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 |
Number |
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. |
0 |
|
Connection Timeout |
Number |
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. |
0 |
|
Host |
String |
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 |
Number |
Port of the proxy. If host is set then this property must be set and cannot be a negative number. |
||
Username |
String |
Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified. |
||
Password |
String |
Password used to authenticate against the proxy. |
Create Data Set
<salesforce-analytics:create-data-set>
Creates a new data set into Salesforce Analytics Cloud system and returns the identifier of created data set within the Salesforce Analytics Cloud system.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
represents the type of the DataSet to be created |
x |
|
Operation |
Enumeration, one of:
|
x |
||
Description |
String |
x |
||
Label |
String |
x |
||
Data Set Name |
String |
x |
||
Edgemart Container |
String |
|||
Notification Sent |
Enumeration, one of:
|
|||
Notification Email |
String |
|||
Target Variable |
String |
The variable name where the output of the operation is stored. |
||
Target Value |
String |
An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable. |
|
|
Reconnection Strategy |
|
A retry strategy in case of connectivity errors. |
Delete Data Set
<salesforce-analytics:delete-data-set>
Deletes specified data set from the Salesforce Analytics Cloud system.
Start Data Processing
<salesforce-analytics:start-data-processing>
Tells the Salesforce Analytics Cloud system to start processing the records uploaded so far into a data set.
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 doing the authorization dance again.
Upload External Data
<salesforce-analytics:upload-external-data>
Inserts records into a data set at an ID obtained from the Salesforce Analytics Cloud system.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Data Set Id |
String |
Identifier of a data set within the Salesforce Analytics Cloud system. |
x |
|
Records |
Array of Object |
List of records to be inserted. |
|
|
Target Variable |
String |
The variable name where the output of the operation is stored. |
||
Target Value |
String |
An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable. |
|
|
Reconnection Strategy |
|
A retry strategy in case of connectivity errors. |
Upload External Data Into New Data Set And Start Processing
<salesforce-analytics:upload-external-data-into-new-data-set-and-start-processing>
Creates a data set, uploads data into it, and tells the Salesforce Analytics Cloud system to start processing the uploaded data.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
Type of the records to be inserted. This is automatically computed based on metadata extracted from file provided with configuration element. |
x |
|
Records |
Array of Object |
List of records to insert. |
|
|
Operation |
Enumeration, one of:
|
x |
||
Description |
String |
x |
||
Label |
String |
x |
||
Data Set Name |
String |
x |
||
Edgemart Container |
String |
|||
Notification Sent |
Enumeration, one of:
|
|||
Notification Email |
String |
|||
Target Variable |
String |
The variable name where the output of the operation is stored. |
||
Target Value |
String |
An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable. |
|
|
Reconnection Strategy |
|
A retry strategy in case of connectivity errors. |
Types
Reconnection
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
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 |
|
The reconnection strategy to use |
Reconnect
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often to reconnect (in milliseconds) |
||
Count |
Number |
The number of reconnection attempts to make |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread |
true |
Reconnect Forever
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread |
true |
Expiration Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute. |