tSalesforceOutput Properties - 6.1

Talend Components Reference Guide

EnrichVersion
6.1
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Component family

Business/Cloud

 

Function

tSalesforceoutput writes in an object of a Salesforce database via the relevant Web service.

Purpose

Allows to write data into a Salesforce DB.

Basic settings

Property type

Either Built-in or Repository.

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

 

 

Built-in: No property data is stored centrally.

 

 

Repository: Select the Repository file where Properties are stored. The fields that follow are pre-filled in using fetched data.

 

Use an existing connection

Select this check box and in the Component List click the relevant connection component to reuse the connection details you already defined.

Note

When a Job contains the parent Job and the child Job, Component List presents only the connection components in the same Job level.

 

Login Type

Two options are available:

Basic: select this option to log in to Salesforce.com by entering your Username/Password on tSalesforceConnection.

OAuth2: select this option to access Salesforce.com by entering your Consumer key/Consumer Secret on tSalesforceConnection. This way, your Username/Password will not be exposed to tSalesforceConnection but extra work is required:

 

Salesforce Webservice URL

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

 

Salesforce Version

Enter the Salesforce version you are using.

 

Username and Password

Enter your Web service authentication details.

To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

 

Consumer Key and Consumer Secret

Enter your OAuth authentication details. Such information is available in the OAuth Settings area of the Connected App that you have created at Salesforce.com.

To enter the consumer secret, click the [...] button next to the consumer secret field, and then in the pop-up dialog box enter the consumer secret between double quotes and click OK to save the settings.

For what a Connected App is, see Connected Apps. For how to create a Connected App, see Defining Remote Access Applications.

 

Callback Host and Callback Port

Enter your 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

Enter the token file name. It stores the refresh token that is used to get the access token without authorization.

 

Timeout (milliseconds)

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

 

Action

You can do any of the following operations on the data of the Salesforce object:

Insert: insert data.

Update: update data.

Delete: delete data.

Upsert: update and insert data.

 

Upsert Key Column

Specify the key column for the upsert operation.

Available when Upsert is selected from the Action list.

 

Module

Select the relevant module in the list.

Note

If you select the Use Custom module option, you display the Custom Module Name field where you can enter the name of the module you want to connect to.

 

Schema and Edit Schema

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. The schema is either Built-In or stored remotely in the Repository.

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

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • View schema: choose this option to view the schema only.

  • Change to built-in property: choose this option to change the schema to Built-in for local changes.

  • Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the [Repository Content] window.

This component offers the advantage of the dynamic schema feature. This allows you to retrieve unknown columns from source files or to copy batches of columns from a source without mapping each column individually. For further information about dynamic schemas, see Talend Studio User Guide.

This dynamic schema feature is designed for the purpose of retrieving unknown columns of a table and is recommended to be used for this purpose only; it is not recommended for the use of creating tables.

Advanced settings

Extended Output

This check box is selected by default. It allows to transfer output data in batches. You can specify the number of lines per batch in the Rows to commit field.

 

Die on error

This check box is selected by default. Clear the check box to skip the row on error and complete the process for error-free rows. If needed, you can retrieve the rows on error via a Row > Reject link.

Note

The Reject link is available only when you have deselected the Extended Output and Die on error check boxes.

 

Error logging file

If you want to create a file that holds all error logs, click the three-dot button next to this field and browse to the specified file to set its access path and its name.

 

Use Socks Proxy

Select this check box if you want to use a proxy server. Once selected, you need enter the connection parameters that are the host, the port, the username and the passerword of the Proxy you need to use.

 

Ignore NULL fields values

Select this check box to ignore NULL values in Update or Upsert mode.

 

Use Soap Compression

Select this check box to activate the SOAP compression.

Note

The compression of SOAP messages optimizes system performance.

 

Retrieve inserted ID

Select this check box to allow Salesforce.com to return the salesforce ID produced for a new row that is to be inserted. The ID column is added to the processed data schema in Salesforce.com.

Note

This option is available only when you have chosen insert action yet not in batch mode, not in the Extended Output option.

 

tStatCatcher Statistics

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

 

Client ID

Set the ID of the real user to differentiate between those who use the same account and password to access the salesforce website.

 

Relationship mapping for upsert (for upsert action only)

Click the [+] button to add lines as needed and specify the external ID fields in the input flow, the lookup relationship fields in the upsert module, the lookup module as well as the external id fields in the lookup module.

Column name of Talend schema: external ID field in the input flow.

Field name: the name of the lookup field. It refers to the lookup field of the module specified in the Module list in the Basic settings view. This column needs to be specified when there are NULL input values and the Ignore NULL fields values check box is cleared.

Lookup field name: lookup relationship fields in the upsert module.

Module name: name of the lookup module.

External id name: external ID field in the lookup module.

Note

  • Column name of Talend schema refers to the fields in the schema of the component preceding tSalesforceOutput. Such columns are intended to match against the external id fields specified in the External id name column, which are the fields of the lookup module specified in the Module name column.

  • Lookup field name refers to the lookup relationship fields of the module selected from the Module list in the Basic settings view. They are intended to establish relationship with the lookup module specified in the Module name column.

  • For how to define the lookup relationship fields and how to provide their correct names in the Lookup field name field, go to the Salesforce website and launch the Salesforce Data Loader application for proper actions and information.

Global Variables

NB_LINE: the number of rows read by an input component or transferred to an output component. This is an After variable and it returns an integer.

NB_SUCCESS: the number of rows successfully processed. This is an After variable and it returns an integer.

NB_REJECT: the number of rows rejected. This is an After variable and it returns an integer.

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

Used as an output component. An Input component is required.

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

n/a