tSalesforceInput Standard properties - 6.5

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 whose connection details will be used to set up the connection.

Connection type

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

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 field 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).

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

This button 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.

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 button 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 check box is available only when Query is selected from the Query Mode drop-down list.

Salesforce URL

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

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 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 check box 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.

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

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.

Batch Size

Enter the number of registrations in each processed batch.

This field 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 field 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 field is available only when Query is selected from the Query Mode drop-down list.

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.

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 check box 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 read by an input component or transferred to an output component. 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 rule

This component is usually used as a start component of a Job or Subjob and it always needs an output link.