tSalesforceConnection - 6.3

Talend Open Studio for Big Data Components Reference Guide

EnrichVersion
6.3
EnrichProdName
Talend Open Studio for Big Data
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Function

tSalesforceConnection opens a connection to a Salesforce system in order to carry out a transaction.

Purpose

The component enables connection to a Salesforce.

tSalesforceConnection properties

Component family

Business/Cloud

Basic settings

Property Type

Either Built-In or Repository.

  • Built-In: No property data stored centrally.

  • Repository: Select the repository file where the properties are stored.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

 

Connection type

Select the type of the connection from the drop-down list, either Basic or OAuth.

  • Basic: select this option to access Salesforce.com by entering your user ID and password. With this option selected, you need to specify the following properties:

    • User Id: the ID of the user in Salesforce.

    • Password: the password associated with the user ID.

    • Security Key: the security token.

  • OAuth: select this option to access Salesforce.com by entering your consumer key and consumer secret. This way, your user name and password will not be exposed, but extra work is required:

    With this option selected, you need to specify the following properties:

    • Client Id and Client Secret: the OAuth consumer key and consumer secret, which are available in the OAuth Settings area of the Connected App that you have created at Salesforce.com.

    • Callback Host and Callback Port: the OAuth authentication callback URL. This URL (both host and port) is defined during the creation of a Connected App and will be shown in the OAuth Settings area of the Connected App.

    • Token File: the path to the token file that stores the refresh token used to get the access token without authorization.

Advanced settings

Salesforce URL

Enter the Webservice URL required to connect to the Salesforce database.

 

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 check box is available only when Basic is selected from the Connection type drop-down list.

 

Need compression

Select this check box to activate SOAP message compression, which can result in increased performance levels.

 

Trace HTTP message

Select this check box to output the HTTP interactions on the console.

This check box is available only when the Bulk Connection check box is selected.

 

Use HTTP Chunked

Select this check box to use the HTTP chunked data transfer mechanism.

This check box is available only when the Bulk Connection check box is cleared.

 

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 (milliseconds)

Enter the intended number of query timeout in Salesforce.com.

 

Use Proxy

Select this check box to use a proxy server, and in the Host, Port, User Id, and Password fields displayed, specify the connection parameters of the 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.

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. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

This component is more commonly used with other Salesforce components.

Log4j

If you are using a subscription-based version of the Studio, the activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Limitation

Due to license incompatibility, one or more JARs required to use this component are not provided. You can install the missing JARs for this particular component by clicking the Install button on the Component tab view. You can also find out and add all missing JARs easily on the Modules tab in the Integration perspective of your studio. For details, see the article Installing External Modules on Talend Help Center (https://help.talend.com) how to configure the Studio in the Talend Installation and Upgrade Guide.

Scenario: Using OAuth2 to log in to Salesforce.com

In this scenario, the OAuth2 (Open Authorization 2.0) method is adopted to authorize tSalesforceConnection to access the Salesforce.com resources. This way, better security is achieved as users do not need entering their Salesforce username/password directly on tSalesforceConnection, which is required by the Basic login type instead.

Setting up the Job

  1. Drop a tSalesforceConnection component, a tFixedFlowInput component and a tSalesforceOutput component onto the workspace.

  2. Link the tFixedFlowInput component to the tSalesforceOutput component using a Row > Main connection.

  3. Link the tSalesforceConnection component to the tFixedFlowInput component using a Trigger > OnSubjobOk connection.

Configuring the components

  1. Double-click the tSalesforceConnection component to open its Basic settings view.

  2. In the Connection type list, select OAuth.

    In the Client Id and Client Secret fields, enter the key and secret used by the consumer to access Salesforce respectively.

    In the Callback Host and Callback Port fields, enter the callback host and port information respectively.

    In the Token File field, browse to or enter the path to the token file that stores the refresh token used by the OAuth-enabled connected app to obtain new sessions without requiring the user to provide their credentials.

  3. Double-click the tFixedFlowInput component to open its Basic settings view.

  4. Click the [...] button next to Edit schema and in the pop-up schema dialog box, define the schema by adding one column Name of String type.

    Click OK to save the changes and close the dialog box.

  5. In the Mode area, select Use Inline Content (delimited file). Then in the Content field displayed, enter the data to be written into Salesforce. For example,

    Talend
  6. Double-click the tSalesforceOutput component to open its Basic settings view.

  7. In the drop-down list next to the Property Type drop-down list, select the tSalesforceConnection component to reuse the connection created by it.

  8. Click the [...] button next to the Module Name field and in the pop-up dialog box, select the object you want to access. In this example, it is Account.

  9. Click the [...] button next to Edit schema to open the schema dialog box.

    On the right side of the panel, remove all the columns except the Name column.

    Click OK to save the changes and close the dialog box.

Executing the Job

  1. Press Ctrl + S to save the Job.

  2. Press F6 to run the Job. The Studio console gives the URL (in yellow) for OAuth authorization.

  3. Copy the URL to the browser's address bar. The Salesforce.com login page appears.

  4. Fill up the username and password and click Log in to Salesforce.

    The authorization response is then shown on the browser at the callback host.