Contact Us 1-800-596-4880
  1. Homepage
  2. Salesforce Einstein Analytics Connector (3.17)

  3. Salesforce Einstein Analytics Connector Reference

All Connectors

Salesforce Einstein Analytics Connector 3.17 Reference - Mule 4

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

  • Basic Username and Password

  • OAuth v2.0

  • OAuth JWT

  • OAuth 2.0 SAML Bearer

The connection types to provide to this configuration.

x

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

Tls

If the protocol is configured as HTTPS, then you must also configure the keystore configuration.

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 added to the allow list 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.

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

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

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Read Timeout.

MILLISECONDS

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

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Connection Timeout.

MILLISECONDS

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 used against the proxy, otherwise this value must be specified.

Password

String

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

Display

Enumeration, one of:

  • PAGE

  • POPUP

  • TOUCH

PAGE

Immediate

Enumeration, one of:

  • TRUE

  • FALSE

FALSE

Prompt

Enumeration, one of:

  • LOGIN

  • CONSENT

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

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Read Timeout.

MILLISECONDS

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

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Connection Timeout.

MILLISECONDS

Host

String

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

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

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

Access Token Url

String

The service provider’s accessToken endpoint URL.

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

Scopes

String

The OAuth scopes to request during the dance. If not provided, it defaults to those in the annotation.

Resource Owner Id

String

The resourceOwnerId that each component should use if it doesn’t reference otherwise.

Before

String

The name of a flow to execute immediately before starting the OAuth dance.

After

String

The name of a flow to execute immediately after an accessToken is received.

Listener Config

String

A reference to a <http:listener-config /> to use to create the listener that catches the access token callback endpoint.

x

Callback Path

String

The path of the access token callback endpoint.

x

Authorize Path

String

The path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

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

String

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

Tls

If the protocol is configured as HTTPS, then you must also configure the keystore configuration.

Read Timeout

Number

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.

0

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Read Timeout.

MILLISECONDS

Connection Timeout

Number

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.

0

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time Unit that qualifies the Connection Timeout.

MILLISECONDS

Host

String

Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.

Port

Number

Port of the proxy. If a Host is set, this property must also be set, and cannot be a negative number.

Username

String

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

String

Password used to authenticate against the proxy.

Consumer Key

String

Consumer key for the Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Principal

String

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

x

Token Endpoint

String

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

String

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

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

Tls

If the protocol is configured as HTTPS, then you must also configure the keystore configuration.

Read Timeout

Number

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.

0

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time Unit that qualifies the Read Timeout.

MILLISECONDS

Connection Timeout

Number

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.

0

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time Unit that qualifies the Connection Timeout.

MILLISECONDS

Host

String

Host name of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.

Port

Number

Port of the proxy. If a Host is set, this property must also 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 used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Consumer Key

String

Consumer key for Salesforce-connected app.

x

Key Store

String

Path to the keystore used to sign data during authentication.

x

Store Password

String

Password of the keystore.

x

Principal

String

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

x

Token Endpoint

String

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

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

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:

  • APPEND

  • OVERWRITE

  • UPSERT

  • DELETE

x

Description

String

x

Label

String

x

Data Set Name

String

x

Edgemart Container

String

Notification Sent

Enumeration, one of:

  • ALWAYS

  • FAILURES

  • NEVER

  • WARNINGS

Notification Email

String

Mode

Enumeration, one of:

  • INCREMENTAL

  • NONE

Mode.

NONE

Target Variable

String

The variable name where to store the operation’s output.

Target Value

String

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

Type

String

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

String

The name of the configuration to use

x

Data Set Id

String

Identifier of the dataset (InsightsExternalData ID) to delete.

x

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

String

The name of the configuration to use

x

Data Set Id

String

Identifier of the dataset (InsightsExternalData ID) to process.

x

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

String

The name of the configuration to use

x

Resource Owner Id

String

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

String

The name of the configuration to use.

x

Data Set Id

String

Identifier of a dataset (InsightsExternalData ID) within the Salesforce Analytics Cloud system.

x

Records

Array of Object

List of records to insert.

#[payload]

Target Variable

String

The variable name where to store the operation’s output.

Target Value

String

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

Type

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

String

The name of the configuration to use.

x

Type

String

Type of the records to insert. This automatically computes based on metadata extracted from the provided file that contains the configuration element.

x

Records

Array of Object

List of records to insert.

#[payload]

Operation

Enumeration, one of:

  • APPEND

  • DELETE

  • OVERWRITE

  • UPSERT

x

Description

String

x

Label

String

x

Data Set Name

String

x

Edgemart Container

String

Notification Sent

Enumeration, one of:

  • ALWAYS

  • FAILURES

  • NEVER

  • WARNINGS

Notification Email

String

Mode

Enumeration, one of:

  • INCREMENTAL

  • NONE

Mode.

NONE

Target Variable

String

The variable name where to store the operation’s output.

Target Value

String

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

Type

String

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

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Key Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

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

Path

String

The location of the trust store, which will be resolved relative to the current classpath and file system, if possible.

Type

String

The type of store used.

Alias

String

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

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

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

Path

String

The path to the CRL file.

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

  • reconnect

  • reconnect-forever

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

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

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 is allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Bulk Operation Result

Field Type Description Default Value Required

Id

Any

Items

Array of BulkItem

Successful

Boolean

Bulk Item

Field Type Description Default Value Required

Exception

Any

Id

Any

Message

String

Payload

Object

Status Code

String

Successful

Boolean

See Also

MuleSoft Help Center

Back to top
View on GitHub