Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
= Salesforce Einstein Analytics Connector 3.18 Reference

[[salesforce-analytics]]
== Default Configuration

=== Parameters
Expand All @@ -13,7 +14,7 @@
* OAuth JWT
* OAuth 2.0 SAML Bearer
| The connection types to provide to this configuration. | |x
| Expiration Policy a| 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. | |
| Expiration Policy a| <<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
Expand All @@ -32,7 +33,7 @@
| Password a| String | Password used to authenticate the user. | |x
| Security Token a| String | User's security token. It can be omitted if your IP has been added to the allow list on Salesforce. | |
| Authorization URL a| 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 a| 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. | |
| Reconnection a| <<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 a| 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 a| Enumeration, one of:

Expand Down Expand Up @@ -82,7 +83,7 @@ include::connectors::partial$oauth2-description.adoc[]

** LOGIN
** CONSENT | | LOGIN |
| Reconnection a| 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. | |
| Reconnection a| <<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 a| 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 a| Enumeration, one of:

Expand Down Expand Up @@ -211,12 +212,12 @@ Use the authorization server's URL for the audience value, for example: `+https:

==== List of Operations

* createDataSet
* deleteDataSet
* startDataProcessing
* unauthorize
* uploadExternalData
* uploadExternalDataIntoNewDataSetAndStartProcessing
* <<createDataSet>>
* <<deleteDataSet>>
* <<startDataProcessing>>
* <<unauthorize>>
* <<uploadExternalData>>
* <<uploadExternalDataIntoNewDataSetAndStartProcessing>>


== Operations
Expand Down Expand Up @@ -258,8 +259,8 @@ Creates a new dataset (InsightsExternalData record) in the Salesforce Analytics
** NONE | Mode. | `NONE` |
| Target Variable a| String | The variable name where to store the operation's output. | |
| Target Value a| String | An expression to evaluate against the operation's output. The outcome of that expression is stored in the target variable. | `#[payload]` |
| Reconnection Strategy a| * reconnect
* reconnect-forever | A retry strategy in case of connectivity errors. | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | A retry strategy in case of connectivity errors. | |
|===

==== Output
Expand All @@ -271,7 +272,7 @@ Creates a new dataset (InsightsExternalData record) in the Salesforce Analytics

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>

==== Throws

Expand All @@ -298,13 +299,13 @@ Deletes the specified dataset (InsightsExternalData record) from the Salesforce
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use | |x
| Data Set Id a| String | Identifier of the dataset (InsightsExternalData ID) to delete. | |x
| Reconnection Strategy a| * reconnect
* reconnect-forever | A retry strategy in case of connectivity errors | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | A retry strategy in case of connectivity errors | |
|===

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>

==== Throws

Expand All @@ -331,13 +332,13 @@ Tells the Salesforce Analytics Cloud system to start processing the records uplo
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use | |x
| Data Set Id a| String | Identifier of the dataset (InsightsExternalData ID) to process. | |x
| Reconnection Strategy a| * reconnect
* reconnect-forever | A retry strategy in case of connectivity errors | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | A retry strategy in case of connectivity errors | |
|===

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>

==== Throws

Expand Down Expand Up @@ -368,7 +369,7 @@ Deletes all the access token information of a given resource owner ID so that it

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>


[[uploadExternalData]]
Expand All @@ -389,20 +390,20 @@ Creates an InsightsExternalDataPart record. The InsightsExternalDataPart object
| Records a| Array of Object | List of records to insert. | `#[payload]` |
| Target Variable a| String | The variable name where to store the operation's output. | |
| Target Value a| String | An expression to evaluate against the operation's output. The outcome of that expression is stored in the target variable. | `#[payload]` |
| Reconnection Strategy a| * reconnect
* reconnect-forever | A retry strategy in case of connectivity errors. | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | A retry strategy in case of connectivity errors. | |
|===

==== Output

[%autowidth.spread]
|===
| Type a| BulkOperationResult
| Type a| <<BulkOperationResult>>
|===

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>

==== Throws

Expand Down Expand Up @@ -453,8 +454,8 @@ Creates a dataset (InsightsExternalData), uploads data into InsightsExternalData
** NONE | Mode. | `NONE` |
| Target Variable a| String | The variable name where to store the operation's output. | |
| Target Value a| String | An expression to evaluate against the operation's output. The outcome of that expression is stored in the target variable. | `#[payload]` |
| Reconnection Strategy a| * reconnect
* reconnect-forever | A retry strategy in case of connectivity errors. | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | A retry strategy in case of connectivity errors. | |
|===

==== Output
Expand All @@ -466,7 +467,7 @@ Creates a dataset (InsightsExternalData), uploads data into InsightsExternalData

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>

==== Throws

Expand Down Expand Up @@ -561,8 +562,8 @@ Creates a dataset (InsightsExternalData), uploads data into InsightsExternalData
|===
| Field | Type | Description | Default Value | Required
| Fails Deployment a| 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 a| * reconnect
* reconnect-forever | The reconnection strategy to use | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | The reconnection strategy to use | |
|===

[[reconnect]]
Expand Down Expand Up @@ -609,7 +610,7 @@ Creates a dataset (InsightsExternalData), uploads data into InsightsExternalData
|===
| Field | Type | Description | Default Value | Required
| Id a| Any | | |
| Items a| Array of BulkItem | | |
| Items a| Array of <<BulkItem>> | | |
| Successful a| Boolean | | |
|===

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
= Salesforce Einstein Analytics Connector 3.19 Reference

[[salesforce-analytics]]
== Default Configuration

=== Parameters
Expand All @@ -13,7 +14,7 @@
* OAuth JWT
* OAuth 2.0 SAML Bearer
| The connection types to provide to this configuration. Note that the `Username Password` connection type is only supported for Salesforce API v64.0 and earlier versions.| |x
| Expiration Policy a| 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. | |
| Expiration Policy a| <<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
Expand All @@ -33,7 +34,7 @@ NOTE: The `Username Password` connection type is only supported for Salesforce A
| Password a| String | Password used to authenticate the user. | |x
| Security Token a| String | User's security token. It can be omitted if your IP has been added to the allow list on Salesforce. | |
| Authorization URL a| 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 a| 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. | |
| Reconnection a| <<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 a| 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 a| Enumeration, one of:

Expand Down Expand Up @@ -83,7 +84,7 @@ include::connectors::partial$oauth2-description.adoc[]

** LOGIN
** CONSENT | | LOGIN |
| Reconnection a| 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. | |
| Reconnection a| <<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 a| 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 a| Enumeration, one of:

Expand Down Expand Up @@ -212,12 +213,12 @@ Use the authorization server's URL for the audience value, for example: `+https:

==== List of Operations

* createDataSet
* deleteDataSet
* startDataProcessing
* unauthorize
* uploadExternalData
* uploadExternalDataIntoNewDataSetAndStartProcessing
* <<createDataSet>>
* <<deleteDataSet>>
* <<startDataProcessing>>
* <<unauthorize>>
* <<uploadExternalData>>
* <<uploadExternalDataIntoNewDataSetAndStartProcessing>>


== Operations
Expand Down Expand Up @@ -259,8 +260,8 @@ Creates a new dataset (InsightsExternalData record) in the Salesforce Analytics
** NONE | Mode. | `NONE` |
| Target Variable a| String | The variable name where to store the operation's output. | |
| Target Value a| String | An expression to evaluate against the operation's output. The outcome of that expression is stored in the target variable. | `#[payload]` |
| Reconnection Strategy a| * reconnect
* reconnect-forever | A retry strategy in case of connectivity errors. | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | A retry strategy in case of connectivity errors. | |
|===

==== Output
Expand All @@ -272,7 +273,7 @@ Creates a new dataset (InsightsExternalData record) in the Salesforce Analytics

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>

==== Throws

Expand All @@ -299,13 +300,13 @@ Deletes the specified dataset (InsightsExternalData record) from the Salesforce
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use | |x
| Data Set Id a| String | Identifier of the dataset (InsightsExternalData ID) to delete. | |x
| Reconnection Strategy a| * reconnect
* reconnect-forever | A retry strategy in case of connectivity errors | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | A retry strategy in case of connectivity errors | |
|===

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>

==== Throws

Expand All @@ -332,13 +333,13 @@ Tells the Salesforce Analytics Cloud system to start processing the records uplo
| Name | Type | Description | Default Value | Required
| Configuration | String | The name of the configuration to use | |x
| Data Set Id a| String | Identifier of the dataset (InsightsExternalData ID) to process. | |x
| Reconnection Strategy a| * reconnect
* reconnect-forever | A retry strategy in case of connectivity errors | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | A retry strategy in case of connectivity errors | |
|===

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>

==== Throws

Expand Down Expand Up @@ -369,7 +370,7 @@ Deletes all the access token information of a given resource owner ID so that it

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>


[[uploadExternalData]]
Expand All @@ -390,20 +391,20 @@ Creates an InsightsExternalDataPart record. The InsightsExternalDataPart object
| Records a| Array of Object | List of records to insert. | `#[payload]` |
| Target Variable a| String | The variable name where to store the operation's output. | |
| Target Value a| String | An expression to evaluate against the operation's output. The outcome of that expression is stored in the target variable. | `#[payload]` |
| Reconnection Strategy a| * reconnect
* reconnect-forever | A retry strategy in case of connectivity errors. | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | A retry strategy in case of connectivity errors. | |
|===

==== Output

[%autowidth.spread]
|===
| Type a| BulkOperationResult
| Type a| <<BulkOperationResult>>
|===

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>

==== Throws

Expand Down Expand Up @@ -454,8 +455,8 @@ Creates a dataset (InsightsExternalData), uploads data into InsightsExternalData
** NONE | Mode. | `NONE` |
| Target Variable a| String | The variable name where to store the operation's output. | |
| Target Value a| String | An expression to evaluate against the operation's output. The outcome of that expression is stored in the target variable. | `#[payload]` |
| Reconnection Strategy a| * reconnect
* reconnect-forever | A retry strategy in case of connectivity errors. | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | A retry strategy in case of connectivity errors. | |
|===

==== Output
Expand All @@ -467,7 +468,7 @@ Creates a dataset (InsightsExternalData), uploads data into InsightsExternalData

==== For Configurations

* salesforce-analytics
* <<salesforce-analytics>>

==== Throws

Expand Down Expand Up @@ -562,8 +563,8 @@ Creates a dataset (InsightsExternalData), uploads data into InsightsExternalData
|===
| Field | Type | Description | Default Value | Required
| Fails Deployment a| 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 a| * reconnect
* reconnect-forever | The reconnection strategy to use | |
| Reconnection Strategy a| * <<reconnect>>
* <<reconnect-forever>> | The reconnection strategy to use | |
|===

[[reconnect]]
Expand Down Expand Up @@ -610,7 +611,7 @@ Creates a dataset (InsightsExternalData), uploads data into InsightsExternalData
|===
| Field | Type | Description | Default Value | Required
| Id a| Any | | |
| Items a| Array of BulkItem | | |
| Items a| Array of <<BulkItem>> | | |
| Successful a| Boolean | | |
|===

Expand Down
Loading