tSalesforceOutput Standard properties - 7.0

Salesforce

author
Talend Documentation Team
EnrichVersion
7.0
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 ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance > Third-party systems > Business applications > Salesforce components
Data Quality and Preparation > Third-party systems > Business applications > Salesforce components
Design and Development > Third-party systems > Business applications > Salesforce components
EnrichPlatform
Talend Studio

These properties are used to configure tSalesforceOutput running in the Standard Job framework.

The Standard tSalesforceOutput 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.

  • 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.

This property is not available when other connection component is selected from the Connection Component drop-down list.

Connection Component

Select the component that opens the database connection to be reused by this component.

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.

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.

Module Name

Click the [...] button next to the field and in the dialog box displayed, select the module that will be used or select the Use custom object check box and specify the module name in the Object Name field.

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. When you create a Spark Job, avoid the reserved word line when naming the fields.

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.

Click Sync columns to retrieve the schema from the previous component connected in the Job.

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 module and is recommended to be used for this purpose only; it is not recommended for the use of creating modules.

Output Action

Select one of the following operations to be performed from the drop-down list.

  • INSERT: insert one or more new records into Salesforce.

  • UPDATE: update one or more existing records in Salesforce.

  • UPSERT: create new records and update existing records. In the Upsert Key Column field displayed, specify the key column for the upsert operation.

  • DELETE: delete one or more records in Salesforce.

Advanced settings

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.

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.

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 proxy server, and in the Host, Port, User Id, and Password fields displayed, specify the connection parameters of the proxy server.

Relationship mapping for upsert

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: the name of the external ID field in the input flow. It refers to the fields in the schema of the preceding component. 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: the name of the lookup field. It refers to the lookup field of the module specified in the Module Name field in the Basic settings view. This column needs to be specified when there are NULL input values for it and the Ignore Null check box is cleared.

  • Lookup relationship field name: the name of the lookup relationship field. It refers to the lookup relationship fields of the module specified in the Module Name field in the Basic settings view and is intended to establish relationship with the lookup module specified in the Module name column in this table. For how to define the lookup relationship fields and how to provide their correct names in the Lookup relationship field name field, go to the Salesforce website and launch the Salesforce Data Loader application for proper actions and information.

  • Module name: the name of the lookup module.

  • External id name: the name of the external ID field in the lookup module specified in the Module name column.

This property is available only when UPSERT is selected from the Output Action drop-down list.

Extend Insert

Select this check box to transfer the output data in batches. In the Commit Level field displayed, specify the number of lines per batch.

Cease on Error

Select the check box to stop the execution of the Job when an error occurs.

Clear the check box to skip any rows on error and complete the process for error-free rows. When errors are skipped, you can collect the rows on error using a Row > Reject link.

The Extend Insert check box needs to be cleared when using the Row > Reject link to collect the erroneous rows.

Retrieve Id

Select this check box to allow Salesforce to return the Salesforce ID for the inserted or updated records.

This check box is available only when INSERT or UPSERT is selected from the Output Action drop-down list and the Extend Insert check box is cleared.

When this check box is selected and the tSalesforceOutput component is linked to another component via a Row > Main connection, the following column(s) will be added to the schema of the data flow:

  • salesforce_id: the Salesforce ID of the created or updated record.

  • salesforce_upsert_status (only for UPSERT): the status of the upsert action to indicate whether the record is created or updated.

Ignore Null

Select this check box to ignore NULL values.

This property is available only when UPDATE or UPSERT is selected from the Output Action drop-down list.

Log File Name

Specify the path to the log file that holds all error logs.

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

NB_LINE

The number of rows processed. 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.

Usage

Usage rule

This component can be used as an end component or an intermediate component of a Job or Subjob and it always needs an input link.