Connector to manipulate specific data to Salesforce CRM.
Configurations
Listener Config
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name of this configuration. With this name can be later referenced. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
Connection Types
Basic User/Pass SOAP Connection
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 whitelisted on Salesforce |
|
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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 JWT Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication |
x |
|
Store Password |
String |
Password of key store |
x |
|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
OAuth SAML Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication |
x |
|
Store Password |
String |
Password of key store |
x |
|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
OAuth User/Pass Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Consumer Secret |
String |
Your application's client secret (consumer secret in Remote Access Detail). |
x |
|
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 whitelisted on Salesforce |
|
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
Salesforce Apex
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name of this configuration. With this name can be later referenced. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
||
Fetch All Apex SOAP Metadata |
Boolean |
If checked then Datasense is performed for all Apex classes in the organization, otherwise it is performed only for the classes in Apex class names. If the organization contains a lot of Apex classes this might cause ConnectionTimeout during Datasense. Default value is false. |
false |
|
Fetch All Apex REST Metadata |
Boolean |
If checked then Datasense will be performed for all Apex classes in the organization else Datasense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during Datasense. Default value is false. |
false |
|
Apex Class Names |
Array of String |
List of Apex class names involved in metadata retrieval via Datasense. |
|
Connection Types
Basic User/Pass SOAP Connection
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 whitelisted on Salesforce |
|
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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 JWT Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication |
x |
|
Store Password |
String |
Password of key store |
x |
|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
OAuth SAML Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication |
x |
|
Store Password |
String |
Password of key store |
x |
|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
OAuth User/Pass Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Consumer Secret |
String |
Your application's client secret (consumer secret in Remote Access Detail). |
x |
|
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 whitelisted on Salesforce |
|
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
Salesforce Bulk
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name of this configuration. With this name can be later referenced. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
Connection Types
Basic User/Pass SOAP Connection
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 whitelisted on Salesforce |
|
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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 JWT Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication |
x |
|
Store Password |
String |
Password of key store |
x |
|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
OAuth SAML Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication |
x |
|
Store Password |
String |
Password of key store |
x |
|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
OAuth User/Pass Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Consumer Secret |
String |
Your application's client secret (consumer secret in Remote Access Detail). |
x |
|
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 whitelisted on Salesforce |
|
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
Salesforce Core
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name of this configuration. With this name can be later referenced. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
Connection Types
Basic User/Pass SOAP Connection
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 whitelisted on Salesforce |
|
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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 JWT Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication |
x |
|
Store Password |
String |
Password of key store |
x |
|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
OAuth SAML Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication |
x |
|
Store Password |
String |
Password of key store |
x |
|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
OAuth User/Pass Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Consumer Secret |
String |
Your application's client secret (consumer secret in Remote Access Detail). |
x |
|
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 whitelisted on Salesforce |
|
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
Associated Operations
Salesforce Metadata
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name of this configuration. With this name can be later referenced. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
Connection Types
Basic User/Pass SOAP Connection
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 whitelisted on Salesforce |
|
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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 JWT Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication |
x |
|
Store Password |
String |
Password of key store |
x |
|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
OAuth SAML Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Key Store |
String |
Path to key store used to sign data during authentication |
x |
|
Store Password |
String |
Password of key store |
x |
|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
OAuth User/Pass Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Consumer Key |
String |
Consumer key for Salesforce connected app |
x |
|
Consumer Secret |
String |
Your application's client secret (consumer secret in Remote Access Detail). |
x |
|
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 whitelisted on Salesforce |
|
|
Session Id |
String |
This value may be used to specify and identify an active Salesforce session |
|
|
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
|
|
Read Timeout |
Number |
Specifies the amount of time, in milliseconds, that the consumer will wait 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 will attempt to establish a connection before it times out. Default value is 0, which means infinite. |
0 |
|
Token Endpoint |
String |
URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL). |
https://login.salesforce.com/services/oauth2/token |
|
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. |
https://login.salesforce.com/services/Soap/u/36.0 |
|
Clear Null Fields |
Boolean |
If false, then in order to clear a field its name must be provided in an update request in the 'fieldsToNull' field, otherwise, for clearing a field it can also be simply added to the request with the value 'null'. Default value is false. |
false |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
||
Host |
String |
Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be 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. |
|
|
Api Version |
Number |
39.0 |
|
Associated Operations
Operations
Invoke Apex Rest Method
Invokes any operation from an Apex class that is exposed as REST web service object containing request information The Apex class method name that will be invoked using REST
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Apex Class Method Name |
String |
x |
||
Request |
Object |
#[payload] |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Object |
For Configurations.
Throws
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
Invoke Apex Soap Method
Invokes any operation from an Apex class that is exposed as SOAP web service the Apex class method name that will be invoked using SOAP XML containing information about the method to be invoked and its parameters. The XML must adhere to the WSDL standards.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Apex Class Method Name |
String |
x |
||
Input |
Any |
#[payload] |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Any |
For Configurations.
Throws
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
Abort Job
Closes an open Job given its ID. The Job ID identifying the Job to be closed.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job id |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Batch Info
Access latest { BatchInfo} of a submitted { BatchInfo}. Allows tracking of the execution status. The org.mule.extension.salesforce.api.bulk.BatchInfo being monitored - content type used at job creation. If not provided default value used is ContentType.XML.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Batch info |
#[payload] |
|
||
Content type |
Enumeration, one of:
|
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Batch Info List
Get information about all batches in a job. - id of the job that you want to retrieve batch information for
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job Id |
String |
#[payload] |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Batch Result
Access { com.sforce.async.BatchResult} of a submitted { BatchInfo}. The com.sforce.async.BatchInfo being monitored
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Batch To Retrieve |
#[payload] |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Batch Result Stream
Access { com.sforce.async.BatchResult} of a submitted { BatchInfo}. The com.sforce.async.BatchInfo being monitored The custom headers to be associated with this batch request
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Batch To Retrieve |
#[payload] |
|
||
Streaming Strategy |
Configure if repeatable streams should be used and their behaviour |
|
||
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Close Job
Closes an open Job given its ID. The Job ID identifying the Job to be closed.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job id |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Create Batch
Creates a Batch using the given objects within the specified Job. The Job can be of XML or CSV type. This call uses the Bulk API. The operation will be done in asynchronous fashion. The com.sforce.async.JobInfo in which the batch will be created. The Job can be of XML, JSON or CSV type. A list of one or more sObject objects. This parameter defaults to payload content. The com.sforce.async.JobInfo in which the batch will be created. The Job can be of XML, JSON or CSV type. Async SObject recursive MAX_DEPTH check
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job info |
x |
|||
Payload |
Array of Object |
#[payload] |
|
|
Sobject Max Depth |
Number |
x |
||
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Create Batch For Query
Creates a Batch using the given query. This call uses the Bulk API. The operation will be done in asynchronous fashion. The JobInfo in which the batch will be created. The query to be executed.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job info |
#[payload] |
|
||
Query |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
Create Batch Stream
Creates a Batch using the given stream within the specified Job. The stream can have a CSV,XML, ZIP_CSV or ZIP_XML format. This call uses the Bulk API. The operation will be done in asynchronous fashion. The JobInfo in which the batch will be created. This parameter defaults to payload content. A stream containing the data. The stream can have a CSV,XML, ZIP_CSV or ZIP_XML format.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job info |
x |
|||
Payload |
Binary |
#[payload] |
|
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Create Bulk
Adds one or more new records to your organization's data. This call uses the Bulk API. The creation will be done in asynchronous fashion. Type of object to create An array of one or more sObject objects. Async SObject recursive MAX_DEPTH check
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Sobject Max Depth |
Number |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Create Job
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Operation |
Enumeration, one of:
|
x |
||
Type |
String |
x |
||
Create Job Request |
|
|||
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Hard Delete Bulk
Deletes one or more records from your organization's data. The deleted records are not stored in the Recycle Bin. Instead, they become immediately eligible for deletion. This call uses the Bulk API. The deletion will be done in asynchronous fashion. An array of one or more sObject objects. Type of object to delete Async SObject recursive MAX_DEPTH check
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Sobject Max Depth |
Number |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Job Info
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job Id |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Update Bulk
Updates one or more existing records in your organization's data. This call uses the Bulk API. The creation will be done in asynchronous fashion. An array of one or more sObject objects. Type of object to update Async SObject recursive MAX_DEPTH check
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Sobject Max Depth |
Number |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Upsert Bulk
Upserts a homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records. In most cases, prefer { #upsert(String, String, List, Map)} over { #create(String, List, Map)}, to avoid creating unwanted duplicate records. This call uses the Bulk API. The creation will be done in asynchronous fashion. The objects to upsert Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects. The type of the given objects. The list of objects to upsert must be homogeneous. Async SObject recursive MAX_DEPTH check
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
External Id Field Name |
String |
x |
||
Sobject Max Depth |
Number |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Convert Lead
Converts a Lead into an Account, Contact, or (optionally) an Opportunity. information needed for lead convertion Salesforce Headers More Info
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Contact Id |
String |
ID of the Contact into which the lead will be merged (this contact must be associated with the specified accountId, and an accountId must be specified). Required only when updating an existing contact.IMPORTANT if you are converting a lead into a person account, do not specify the contactId or an error will result. Specify only the accountId of the person account. If no contactID is specified, then the API creates a new contact that is implicitly associated with the Account. To create a new contact, the client application must be logged in with sufficient access rights. To merge a lead into an existing contact, the client application must be logged in with read/write access to the specified contact. The contact name and other existing data are not overwritten (unless overwriteLeadSource is set to true, in which case only the LeadSource field is overwritten). For information on IDs, see ID Field Type. |
|
|
Account Id |
String |
ID of the Account into which the lead will be merged. Required only when updating an existing account, including person accounts. If no accountID is specified, then the API creates a new account. To create a new account, the client application must be logged in with sufficient access rights. To merge a lead into an existing account, the client application must be logged in with read/write access to the specified account. The account name and other existing data are not overwritten. For information on IDs, see ID Field Type. |
|
|
Send Email To Owner |
Boolean |
Specifies whether to send a notification email to the owner specified in the ownerId (true) or not (false, the default). |
false |
|
Opportunity Name |
String |
Name of the opportunity to create. If no name is specified, then this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If doNotCreateOpportunity argument is true, then no Opportunity is created and this field must be left blank; otherwise, an error is returned. |
|
|
Do Not Create Opportunity |
Boolean |
Specifies whether to create an Opportunity during lead conversion (false, the default) or not (true). Set this flag to true only if you do not want to create an opportunity from the lead. An opportunity is created by default. |
|
|
Over Write Lead Source |
Boolean |
Specifies whether to overwrite the LeadSource field on the target Contact object with the contents of the LeadSource field in the source Lead object (true), or not (false, the default). To set this field to true, the client application must specify a contactId for the target contact. |
false |
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Create
Adds one or more new records to your organization's data.
IMPORTANT: When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at Salesforce. Take the CloseDate of an Opportunity as an example, if you set that field to a string of value "2011-12-13" it will be sent to Salesforce as a string and operation will be rejected on the basis that CloseDate is not of the expected type. The proper way to actually map it is to generate a Java Date object, you can do so using Groovy expression evaluator as #[groovy:Date.parse("yyyy-MM-dd", "2011-12-13")].
type of record to be added records to be added to your organization headers to be send with requestParameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
x |
||
Records |
Array of Object |
#[payload] |
|
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Save Result |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Create Single
Adds one new record to your organization's data.
IMPORTANT: When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at Salesforce. Take the CloseDate of an Opportunity as an example, if you set that field to a string of value "2011-12-13" it will be sent to Salesforce as a string and operation will be rejected on the basis that CloseDate is not of the expected type. The proper way to actually map it is to generate a Java Date object, you can do so using Groovy expression evaluator as #[groovy:Date.parse("yyyy-MM-dd", "2011-12-13")].
type of record to be added record to be added to your organization headers to be send with requestParameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
x |
||
Record |
Object |
#[payload] |
|
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Delete
Deletes one or more records from your organization's data. Array of one or more IDs associated with the objects to delete. Salesforce Headers More Info
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Records To Delete Ids |
Array of String |
#[payload] |
|
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Delete Result |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Merge
Merge up to three records into one. A list of ids of the objects to be merged type of record to be merged Must provide the ID of the object that other records will be merged into. Optionally, provide the fields to be updated and their values. headers to be send with request
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Records To Merge Ids |
Array of String |
x |
||
Type |
String |
x |
||
Master Record |
Object |
#[payload] |
|
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Non Paginated Query
Executes a query against the specified object and returns data that matches the specified criteria. Salesforce Object Query Language (SOQL).
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Salesforce Query |
String |
Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see |
x |
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Object |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Query
Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are String and, if necessary, you can convert them to the apropiate type using for example Weave and Transform Message Salesforce Object Query Language (SOQL).
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Salesforce Query |
String |
Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see |
x |
|
Streaming Strategy |
Configure if repeatable streams should be used and their behaviour |
|
||
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Object |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Query All
Retrieves data from specified objects, whether or not they have been deleted. Salesforce Object Query Language (SOQL).
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Salesforce Query |
String |
Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see |
x |
|
Streaming Strategy |
Configure if repeatable streams should be used and their behaviour |
|
||
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Object |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Query Single
Executes a query against the specified object and returns the first record that matches the specified criteria. Salesforce Object Query Language (SOQL).
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Salesforce Query |
String |
Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see |
x |
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Object |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Retrieve
Retrieves one or more records based on the specified IDs. type of record to be retrieved Must provide the ID of the object that other records will be merged into. Optionally, provide the fields to be updated and their values. headers to be send with request
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
x |
||
Retrieve Request |
#[payload] |
|
||
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Object |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Update
Updates one or more existing records in your organization's data. type of record to be updated records to be added to your organization headers to be send with request
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
x |
||
Records |
Array of Object |
#[payload] |
|
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Save Result |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Update Single
Updates one record in your organization's data. type of the object to be updated record to be upserted into your organization headers to be send with request
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
x |
||
Record |
Object |
#[payload] |
|
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Upsert
Upserts a homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records. In most cases, prefer { #upsert(String, String, List, Map)} over { #create(String, List, Map)}, to avoid creating unwanted duplicate records. Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects. type of record to be upserted records to be added to your organization headers to be send with request
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
External Id Field Name |
String |
x |
||
Type |
String |
x |
||
Records |
Array of Object |
#[payload] |
|
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Upsert Result |
For Configurations.
Throws
-
SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Create Metadata
Create metadata: Adds one or more new metadata components to your organization The Metadata Type to be created a List of Map<String, Object> representing the metadatas to be created
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
x |
||
Metadata Objects |
Array of Object |
#[payload] |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Save Result |
For Configurations.
Throws
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Deploy Metadata
Deploy. File-based call to deploy XML components. Use this call to take file representations of components and deploy them into an organization by creating, updating, or deleting the components they represent. data needed by this operation
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Deploy Metadata Request |
#[payload] |
|
For Configurations.
Throws
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Describe Global
Retrieves a list of available objects for your organization's data. headers to be send with request
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Describe Sobject
Describes metadata (field list and object properties) for the specified object. Object. The specified value must be a valid object for your organization. For a complete list of objects, {see Standard Objects} headers to be send with request
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
x |
||
Headers |
Object |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
For Configurations.
Throws
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Update Metadata
Updates one or more metadata components in your organization. a List of Map<String, Object> representing the metadata to be updated The metadata type of the components updated
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Type |
String |
x |
||
Metadata Objects |
Array of Object |
#[payload] |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Save Result |
For Configurations.
Throws
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_REQUEST_DATA
-
SALESFORCE:INVALID_SESSION
-
SALESFORCE:CONNECTIVITY
Sources
Replay
Salesforce stores events for 24 hours and allows you to retrieve stored and new events. Subscribers can choose which events to receive by using replay options.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Topic |
String |
The name of the topic to connectBayeuxClientAndSubscribe to |
x |
|
Replay Option |
Enumeration, one of:
|
Enum with the following values: ONLY_NEW: -1 Subscriber receives new events that are broadcast after the client subscribes. ALL: -2 Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription. FROM_REPLAY_ID: Subscriber will receive only events with replay id value greater than specified replayId |
x |
|
Replay Id Param |
String |
Subscriber receives all events after the event specified by its replayId value. The value is ignored if replay option is set on ALL or ONLY_NEW. |
x |
|
Auto Replay Param |
Boolean |
if true, when source is started it will start to consume data from when it was left last time |
x |
|
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|
||
Streaming Strategy |
Configure if repeatable streams should be used and their behaviour |
|
||
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
Any |
Attributes Type |
For Configurations.
Subscribe
Subscribe to a topic. First the topic must be published and after that a subscription to that topic created. Attention: Salesforce lets you subscribe to an inexistent topic but won't send you notifications after the topic is created.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Topic |
String |
The name of the topic to subscribe to |
x |
|
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|
||
Streaming Strategy |
Configure if repeatable streams should be used and their behaviour |
|
||
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
Any |
Attributes Type |
For Configurations.
Types
Reconnect
| Field | Type | Default Value |
|---|---|---|
Frequency |
Number |
|
Count |
Number |
|
Blocking |
Boolean |
Reconnect Forever
| Field | Type | Default Value |
|---|---|---|
Frequency |
Number |
Redelivery Policy
| Field | Type | Default Value |
|---|---|---|
Max Redelivery Count |
Number |
|
Use Secure Hash |
Boolean |
|
Message Digest Algorithm |
String |
|
Id Expression |
String |
|
Object Store Ref |
String |
Repeatable In Memory Stream
| Field | Type | Default Value |
|---|---|---|
Initial Buffer Size |
Number |
|
Buffer Size Increment |
Number |
|
Max Buffer Size |
Number |
|
Buffer Unit |
Enumeration, one of:
|
Repeatable File Store Stream
| Field | Type | Default Value |
|---|---|---|
Max In Memory Size |
Number |
|
Buffer Unit |
Enumeration, one of:
|
Job Info
| Field | Type | Default Value |
|---|---|---|
Apex Processing Time |
Number |
|
Api Active Processing Time |
Number |
|
Api Version |
Number |
|
Assignment Rule Id |
String |
|
Concurrency Mode |
Enumeration, one of:
|
|
Content Type |
Enumeration, one of:
|
|
Created By Id |
String |
|
Created Date |
DateTime |
|
External Id Field Name |
String |
|
Fast Path Enabled |
Boolean |
|
Id |
String |
|
Number Batches Completed |
Number |
|
Number Batches Failed |
Number |
|
Number Batches In Progress |
Number |
|
Number Batches Queued |
Number |
|
Number Batches Total |
Number |
|
Number Records Failed |
Number |
|
Number Records Processed |
Number |
|
Number Retries |
Number |
|
Object |
String |
|
Operation |
Enumeration, one of:
|
|
State |
Enumeration, one of:
|
|
System Modstamp |
DateTime |
|
Total Processing Time |
Number |
Batch Info
| Field | Type | Default Value |
|---|---|---|
Apex Processing Time |
Number |
|
Api Active Processing Time |
Number |
|
Created Date |
DateTime |
|
Id |
String |
|
Job Id |
String |
|
Number Records Failed |
Number |
|
Number Records Processed |
Number |
|
State |
Enumeration, one of:
|
|
State Message |
String |
|
System Modstamp |
DateTime |
|
Total Processing Time |
Number |
Batch Info List
| Field | Type | Default Value |
|---|---|---|
Batch Info |
Array of Batch Info |
Batch Result
| Field | Type | Default Value |
|---|---|---|
Partial Result |
Boolean |
|
Result |
Array of Result |
Result
| Field | Type | Default Value |
|---|---|---|
Errors |
Array of Error |
|
Id |
String |
|
Success |
Boolean |
Error
| Field | Type | Default Value |
|---|---|---|
Fields |
Array of String |
|
Message |
String |
|
Status Code |
String |
Create Job Request
| Field | Type | Default Value |
|---|---|---|
External Id Field Name |
String |
|
Content Type |
Enumeration, one of:
|
|
Concurrency Mode |
Enumeration, one of:
|
Lead Convert Result
| Field | Type | Default Value |
|---|---|---|
Account Id |
String |
|
Contact Id |
String |
|
Errors |
Array of Error |
|
Lead Id |
String |
|
Opportunity Id |
String |
|
Success |
Boolean |
Save Result
| Field | Type | Default Value |
|---|---|---|
Errors |
Array of Error |
|
Id |
String |
|
Success |
Boolean |
Delete Result
| Field | Type | Default Value |
|---|---|---|
Errors |
Array of Error |
|
Id |
String |
|
Success |
Boolean |
Merge Result
| Field | Type | Default Value |
|---|---|---|
Errors |
Array of Error |
|
Id |
String |
|
Merged Record Ids |
Array of String |
|
Success |
Boolean |
|
Updated Related Ids |
Array of String |
Repeatable In Memory Iterable
| Field | Type | Default Value |
|---|---|---|
Initial Buffer Size |
Number |
|
Buffer Size Increment |
Number |
|
Max Buffer Size |
Number |
Repeatable File Store Iterable
| Field | Type | Default Value |
|---|---|---|
Max In Memory Size |
Number |
|
Buffer Unit |
Enumeration, one of:
|
Retrieve Request
| Field | Type | Default Value |
|---|---|---|
Fields |
Array of String |
|
Ids |
Array of String |
Upsert Result
| Field | Type | Default Value |
|---|---|---|
Created |
Boolean |
|
Errors |
Array of Error |
|
Id |
String |
|
Success |
Boolean |
Deploy Metadata Request
| Field | Type | Default Value |
|---|---|---|
Stream |
Binary |
|
Ignore Warnings |
Boolean |
false |
Purge On Delete |
Boolean |
false |
Rollback On Error |
Boolean |
true |
Describe Global Result
| Field | Type | Default Value |
|---|---|---|
Encoding |
String |
|
Max Batch Size |
Number |
|
Sobjects |
Array of Describe Global S Object Result |
Describe Global S Object Result
| Field | Type | Default Value |
|---|---|---|
Activateable |
Boolean |
|
Createable |
Boolean |
|
Custom |
Boolean |
|
Custom Setting |
Boolean |
|
Deletable |
Boolean |
|
Deprecated And Hidden |
Boolean |
|
Feed Enabled |
Boolean |
|
Key Prefix |
String |
|
Label |
String |
|
Label Plural |
String |
|
Layoutable |
Boolean |
|
Mergeable |
Boolean |
|
Mru Enabled |
Boolean |
|
Name |
String |
|
Queryable |
Boolean |
|
Replicateable |
Boolean |
|
Retrieveable |
Boolean |
|
Searchable |
Boolean |
|
Triggerable |
Boolean |
|
Undeleteable |
Boolean |
|
Updateable |
Boolean |
Describe S Object
| Field | Type | Default Value |
|---|---|---|
Action Overrides |
Array of Action Override |
|
Activateble |
Boolean |
|
Child Relationships |
Array of Child Relationship |
|
Compact Layoutable |
Boolean |
|
Createable |
Boolean |
|
Custom |
Boolean |
|
Custom Setting |
Boolean |
|
Deletable |
Boolean |
|
Deprecated And Hidden |
Boolean |
|
Feed Enabled |
Boolean |
|
Fields |
Array of Field |
|
Key Prefix |
String |
|
Label |
String |
|
Label Plural |
String |
|
Layoutable |
Boolean |
|
Mergeable |
Boolean |
|
Mru Enabled |
Boolean |
|
Name |
String |
|
Named Layout Infos |
Array of Named Layout Info |
|
Network Scope Field Name |
String |
|
Queryable |
Boolean |
|
Record Type Infos |
Array of Record Type Info |
|
Replicateable |
Boolean |
|
Retrieveable |
Boolean |
|
Search Layoutable |
Boolean |
|
Searchable |
Boolean |
|
Triggerable |
Boolean |
|
Undeletable |
Boolean |
|
Updateable |
Boolean |
|
Url Detail |
String |
|
Url Edit |
String |
|
Url New |
String |
Action Override
| Field | Type | Default Value |
|---|---|---|
Available In Touch |
Boolean |
|
From Factor |
String |
|
Name |
String |
|
Page Id |
String |
|
Url |
String |
Child Relationship
| Field | Type | Default Value |
|---|---|---|
Cascade Delete |
Boolean |
|
Child S Object |
String |
|
Deprecated And Hidden |
Boolean |
|
Field |
String |
|
Relation Ship Name |
String |
|
Relations Ship Name |
String |
Field
| Field | Type | Default Value |
|---|---|---|
Autonumber |
Boolean |
|
Byte Length |
Number |
|
Calculated |
Boolean |
|
Case Sensitive |
Boolean |
|
Controller Name |
String |
|
Createable |
Boolean |
|
Custom |
Boolean |
|
Default Value Formula |
String |
|
Defaulted On Create |
Boolean |
|
Dependent Pick List |
Boolean |
|
Deprecate And Hidden |
Boolean |
|
Digits |
Number |
|
Display Location In Decimal |
Boolean |
|
Encrypted |
Boolean |
|
Extra Type Info |
String |
|
Filterable |
Boolean |
|
Filtered Lookup Info |
||
Formula |
String |
|
Groupable |
Boolean |
|
High Scale Number |
Boolean |
|
Html Formatted |
Boolean |
|
Id Lookup |
Boolean |
|
Inline Help Text |
String |
|
Label |
String |
|
Length |
Number |
|
Mask |
String |
|
Mask Type |
String |
|
Name |
String |
|
Name Field |
Boolean |
|
Name Pointing |
Boolean |
|
Nullable |
Boolean |
|
Permissinable |
Boolean |
|
Picklist Values |
Array of Pick List Entry |
|
Polymorphic Foreign Key |
Boolean |
|
Precision |
Number |
|
Reference Target Field |
String |
|
Reference To |
Array of String |
|
Relationship Name |
String |
|
Relationship Order |
Number |
|
Restricted Picklist |
Boolean |
|
Scale |
Number |
|
Search Filterable |
Boolean |
|
Sortable |
Boolean |
|
Type |
Enumeration, one of:
|
|
Unique |
Boolean |
|
Updateable |
Boolean |
|
Write Requires Master Read |
Boolean |
Filtered Lookup Info
| Field | Type | Default Value |
|---|---|---|
Controlling Fields |
Array of String |
|
Dependent |
Boolean |
|
Optional Filter |
Boolean |
Pick List Entry
| Field | Type | Default Value |
|---|---|---|
Active |
Boolean |
|
Default Value |
Boolean |
|
Label |
String |
|
Valid For |
Binary |
|
Value |
String |
Named Layout Info
| Field | Type | Default Value |
|---|---|---|
Name |
String |
Record Type Info
| Field | Type | Default Value |
|---|---|---|
Available |
Boolean |
|
Default Record Type Mapping |
Boolean |
|
Id |
String |
|
Master |
Boolean |
|
Name |
String |