tSalesforceConnection Standard properties
These properties are used to configure tSalesforceConnection running in the Standard Job framework.
The Standard tSalesforceConnection component belongs to the Business and the Cloud families.
The component in this framework is available in all Talend products.
Basic settings
|
Property Type |
Select the way the connection details will be set.
|
|
Connection type |
Select the type of the connection from the drop-down list. The connection properties will vary according to the connection type you choose.
|
|
User Id |
The Salesforce username. This property is available only when the Basic connection type is selected. |
|
Password |
The Salesforce password associated with the username. This property is available only when the Basic connection type is selected. |
|
Security Token |
The Salesforce security token. For more information, see Reset Your Security Token. This property is available only when the Basic connection type is selected. |
|
Issuer |
The OAuth Consumer Key, generated when your connected app is created and shown in the connected app detail page in Salesforce. For more information, see Create a Connected App. This property is available only when the OAuth connection type is selected. |
|
Subject |
The Salesforce username. This property is available only when the OAuth connection type is selected. |
|
Audience |
Json Web Token audience. You can set your own Json Web Token audience. This property is available only when the OAuth connection type is selected. |
|
Expiration time (in seconds) |
The expiration time of the assertion (in seconds) within five minutes. This property is available only when the OAuth connection type is selected. |
|
Key store |
The path to the keystore file in Java Keystore (JKS) format. The keystore file can be generated by creating a certificate signed by Salesforce and then exporting it to keystore. For more information, see Generate a Self-Signed Certificate. This property is available only when the OAuth connection type is selected. |
|
Key store password |
The keystore password. This property is available only when the OAuth connection type is selected. |
|
Certificate alias |
The unique name of the certificate signed by Salesforce. This property is available only when the OAuth connection type is selected. |
|
Mutual authentication |
Select this option to enable mutual authentication for establishing connections to Salesforce. For more information about mutual authentication in Salesforce, see Set Up a Mutual Authentication Certificate. If you are using this option:
By default, this option is not selected. |
|
Mutual auth keystore (Deprecated) |
Enter the path to the mutual authentication keystore file, a password protected file containing keys and certificates. This option is deprecated, it is recommended to use a tSetKeystore component to provide the mutual authentication keystore and keystore password. This option is available when both the Basic connection type and the Mutual authentication check box are selected. |
|
Mutual auth keystore password |
Enter the password for the mutual authentication keystore file. This option is available when both the Basic connection type and the Mutual authentication check box are selected. |
Advanced settings
|
Salesforce URL |
The Webservice URL required to connect to Salesforce. Information noteWarning: Due to a breaking change in the latest versions of
Salesforce, if you use the Basic connection type with
mutual authentication, you need to adjust the endpoint to prevent errors while
running the Job. Example:
https://MyDomainName.my.salesforce.com:8443/services/Soap/u/57.0
|
|
API version |
The Salesforce API version. This property is available only when the OAuth connection type is selected. |
|
Bulk Connection |
Select this check box if you need to use bulk data processing function. |
|
Use or save the connection session |
Select this check box and in the Session directory field displayed, specify the path to the connection session file to be saved or used. This session file can be shared by different Jobs to retrieve a connection session as long as the correct user ID is provided by the component. This way, you do not need to connect to the server to retrieve the session. When an expired session is detected, if the correct connection information (the user ID, password, and security key) is provided, the component will connect to the server to retrieve the new session information and update the connection session file. This property is available only when the Basic connection type is selected. |
|
Need compression |
Select this check box to activate SOAP message compression, which can result in increased performance levels. |
|
Use Http Chunked |
Select this check box to use the HTTP chunked data transfer mechanism. This property is available only when the Bulk Connection check box is cleared. |
|
Trace HTTP message |
Select this check box to output the HTTP interactions on the console. This property is available only when the Bulk Connection check box is selected. |
|
Client Id |
Enter the ID of the real user to differentiate between those who use the same account and password to access the Salesforce website. |
|
Timeout |
Enter the intended number of query timeout in milliseconds in Salesforce. |
|
Use Proxy |
Select this check box to use a SOCKS proxy server, and in the Host, Port, User Id, and Password fields displayed, specify the connection parameters of the SOCKS proxy server. Information noteNote: To use a proxy of any allowed type (including HTTP proxy, HTTPS proxy, and
SOCKS proxy), use the tSetProxy component.
|
|
tStatCatcher Statistics |
Select this check box to gather the Job processing metadata at the Job level as well as at each component level. |
Global Variables
|
ERROR_MESSAGE |
The error message generated by the component when an error occurs. This is an After variable and it returns a string. |
Usage
|
Usage rule |
This component is more commonly used with other Salesforce components. |