tSalesforceInput 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 tSalesforceInput running in the Standard Job framework.

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

In this component the schema is related to the Module selected.

To retrieve a column from a linked module it is necessary to define the column in a particular manner in the Edit schema view, otherwise the relationship query will not work. The correct syntax is: NameofCurrentModule_Nameof-

LinkedModule_NameofColumnofInterest.

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.

Query Mode

Select the query mode from the drop-down list, either Query or Bulk.

  • Query: the ordinary query.

  • Bulk: the bulk query used to query large data sets efficiently and reduce the number of API requests.

Condition

Enter the query used to select the data to be extracted between double quotation marks, for example, "name='Talend'" or "name like '%talend_user%'".

This property is not available when the Manual Query check box is selected.

Manual Query

Select this check box and in the Full SOQL query string field displayed, enter the full SOQL (Salesforce Object Query Language) statement used to select the data to be retrieved between double quotation marks. For more information about the SOQL, see Salesforce Object Query Language (SOQL).

Guess schema

Click this button to generate the schema columns based on the query specified in the Full SOQL query string field.

This property is available only when the Manual Query check box is selected.

Note that there are some limitations you should be aware of when using this feature. Please refer to the Know Limitations section in Release Notes for more detailed information.

Guess query

Click this button to generate the query in the Full SOQL query string field based on the defined module and schema.

For more information about how to set the module and schema correctly when generating the SOQL queries, see How to set schema for the guess query feature of tSalesforceInput.

This property is available only when the Manual Query check box is selected.

Note that there are some limitations you should be aware of when using this feature. Please refer to the Know Limitations section in Release Notes for more detailed information.

Include deleted records

Select this check box to query all the records, including the deleted ones.

This property is available only when Query is selected from the Query Mode drop-down list.

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.

Trace HTTP message

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

This property is available only when Bulk is selected from the Query Mode drop-down list.

Use HTTP Chunked

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

This property is available only when Query is selected from the Query Mode drop-down list.

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.

Batch Size

Enter the number of registrations in each processed batch.

This property is available only when Query is selected from the Query Mode drop-down list.

Normalize Delimiter

Enter the characters, strings or regular expressions used to normalize the data that is collected by queries set on different hierarchical Salesforce objects.

This property is available only when Query is selected from the Query Mode drop-down list.

Column Name Delimiter

Enter the characters, strings or regular expressions used to separate the name of the parent object from the name of the child object when you use a query on the hierarchical relations among the different Salesforce objects.

This property is available only when Query is selected from the Query Mode drop-down list.

Safety Switch

Clear this check box if the length of any column of the module to be queried is greater than 100,000 characters. By default, this check box is selected to prevent excessive memory usage.

This property is available only when Bulk is selected from the Query Mode drop-down list.

Complete Job timeout

The timeout value, in seconds, within which your bulk query Job must be completed. By default, the value is set to 0, which means there is no time limit for your Job to complete.

Salesforce has its own limit for bulk query. If it takes time longer than Salesforce's timeout limit to process a batch, the batch will be placed in a queue and processed later, and thus it might take too much time for the Job to execute. In this case, you can define the Complete Job timeout value to make your Job end in advance. For more information about Salesforce's own limit, see Bulk API Limits - Batch processing time.

This property is available only when Bulk is selected from the Query Mode drop-down list.

Enable PK Chunking

Select this check box to enable PK (Primary Key, i.e., the object’s record ID) chunking when extracting large amounts of records or when the query consistently times out. In the Chunk size field displayed, specify the number of records within the ID boundaries for each chunk. For more information, see Use PK Chunking to Extract Large Data Sets from Salesforce.

This property is available only when Bulk is selected from the Query Mode drop-down list.

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.

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 usually used as a start component of a Job or Subjob and it always needs an output link.