tSalesforceConnection Standard properties - 7.3

Property Type

Select the way the connection details will be set.

• Built-In: The connection details will be set locally for this component. You need to specify the values for all related connection properties manually.

• Repository: The connection details stored centrally in Repository > Metadata will be reused by this component. You need to click the [...] button next to it and in the pop-up Repository Content dialog box, select the connection details to be reused, and all related connection properties will be automatically filled in.

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.

• Basic: select this option to access Salesforce by entering your Salesforce username and password.

• OAuth: select this option to access Salesforce using OAuth (Open Authorization) 2.0 protocol to authenticate the user. From the Oauth2 flow type drop-down list displayed, you need to choose an OAuth 2.0 authentication flow type, either Json Web Token Flow or Implicit Flow (Deprecated) (User Agent Flow). This way, you need to create a connected app in Salesforce to configure a Salesforce authentication provider.

  For more information about the OAuth authentication flow, see Authenticate Apps with OAuth.

  For more information about how to create a connected app in Salesforce, see Create a Connected App.

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 Json Web Token Flow type is selected.

Subject

The Salesforce username.

This property is available only when the OAuth Json Web Token Flow type is selected.

Audience

Json Web Token audience.

You can set your own Json Web Token audience.

This property is available only when OAuth is selected from the Connection type drop-down list and Json Web Token Flow is selected from the Oauth2 flow type drop-down list.

Expiration time (in seconds)

The expiration time of the assertion (in seconds) within five minutes.

This property is available only when the OAuth Json Web Token Flow 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 Json Web Token Flow type is selected.

Key store password

The keystore password.

This property is available only when the OAuth Json Web Token Flow type is selected.

Certificate alias

The unique name of the certificate signed by Salesforce.

This property is available only when the OAuth Json Web Token Flow type is selected.

Client Id

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 Implicit Flow type is selected.

Client Secret

The OAuth Consumer Secret, 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 Implicit Flow type is selected.

Callback Host

The host value in the OAuth authentication callback URL that is defined during the creation of a connected app and will be shown in the API (Enable OAuth Settings) area of the connected app detail page in Salesforce.

This property is available only when the OAuth Implicit Flow type is selected.

Callback Port

The port value in the OAuth authentication callback URL that is defined during the creation of a connected app and will be shown in the API (Enable OAuth Settings) area of the connected app detail page in Salesforce.

This property is available only when the OAuth Implicit Flow type is selected.

Token File

The path to the token file that stores the refresh token used to get the access token without authorization.

This property is available only when the OAuth Implicit Flow type is selected.

Salesforce URL

The Webservice URL required to connect to Salesforce.

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.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

ERROR_MESSAGE

The error message generated by the component when an error occurs. This is an After variable and it returns a string.

Usage rule

This component is more commonly used with other Salesforce components.