# tSalesforceInput Retrieves data from a Salesforce object based on a query. Information noteNote: This component is not shipped with your Talend Studio by default. You need to install it using the Feature Manager. For more information, see [Installing features using the Feature Manager](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/install-features-to-talend-studio). ## tSalesforceInput Standard properties 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 | Properties | Description | | --- | --- | | Property Type | Select the way the connection details
will be set.



This property is not available when other connection component is selected from
the Connection Component dropdown list. | | Component list | 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.

| | 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](https://help.salesforce.com/articleView?id=user_security_token.htm&type=5).

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](https://help.salesforce.com/articleView?id=connected_app_create.htm&type=5).

This property is available only when
the OAuth connection type is selected. | | Subject | The Salesforce username.

This property is available only when
the OAuth connection type is selected. | | Audience | Json Web Token audience.

You can set your own Json Web Token audience.

This property is available only when
the OAuth connection 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 connection 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](https://help.salesforce.com/articleView?id=security_keys_creating.htm&type=5).

This property is available only when
the OAuth connection type is selected. | | Key store password | The keystore password.

This property is available only when
the OAuth connection type is selected. | | Certificate alias | The unique name of the certificate signed by Salesforce.

This property is available only when
the OAuth connection type is selected. | | Mutual authentication | Select this option to enable mutual authentication for establishing connections to
Salesforce. For more information about mutual authentication in Salesforce, see
[Set Up a Mutual Authentication
Certificate](https://help.salesforce.com/s/articleView?id=sf.security_keys_uploading_mutual_auth_cert.htm&type=5).

If you are using this option:



By default, this option is not selected. | | Mutual auth keystore (Deprecated) | Enter the path to the mutual authentication keystore file, a password protected
file containing keys and certificates.

This option is deprecated, it is recommended to use a [tSetKeystore](https://help.qlik.com/talend/r/en-US/8.0/components/keystore/tsetkeystore) component to provide the mutual
authentication keystore and keystore password.

This option is available when both the Basic connection
type and the Mutual authentication check box are
selected. | | Mutual auth keystore password | Enter the password for the mutual authentication keystore file.

This option is available when both the Basic connection
type and the Mutual authentication check box are
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:



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 [Dynamic schema](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/dynamic-schema).

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: Query,
Bulk, or
BulkV2.

| | 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)](https://developer.salesforce.com/docs/atlas.en-us.200.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm). | | Guess schema | Click this button to generate the schema columns based on
the query specified in the Full SOQL query
string field. If you are using a network proxy, this
function works with a SOCKS proxy only. You can create a SOCKS proxy by
selecting the Use Proxy option
and providing the related parameters in the Advanced settings view.

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. Refer to the Known 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](https://help.qlik.com/talend/en-US/components/8.0/salesforce/how-to-set-schema-for-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. Refer to the Known 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. | ## Advanced settings | Properties | Description | | --- | --- | | Salesforce URL | The Webservice URL required to connect to Salesforce.

Information noteWarning: Due to a [breaking change](https://help.salesforce.com/s/articleView?id=release-notes.rn_security_mutual_authentication.htm&release=246&type=5) in the latest versions of
Salesforce, if you use the Basic connection type with
mutual authentication, you need to adjust the endpoint to prevent errors while
running the Job. Example:
https://MyDomainName.my.salesforce.com:8443/services/Soap/u/version | | 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 option 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 SOCKS proxy server, and in the
Host, Port, User
Id, and Password fields displayed, specify
the connection parameters of the SOCKS proxy server.

Information noteNote: To use a proxy of any allowed type (including HTTP proxy, HTTPS proxy, and
SOCKS proxy), use the tSetProxy component. | | 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.

Select column name delimiter carefully to avoid conflicts between the
resulting column names. For example, if a parent Salesforce object named
*Case* has two columns *Region\_c* and
*Case\_Region\_c*, and the character *\_* is used
as the column name delimiter, the query will fail to retrieve data from
the *Case\_Region\_c* column. This is because
*Case\_Region\_c* identifies the *Region\_c*
column in this case.

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 longer than 100,000 characters. By default, this
check box is selected to prevent excessive memory usage.

This property is available when Bulk or BulkV2 is selected from the Query Mode drop-down list. | | All return null if value is
empty | Select this option to return null for empty values.

This property is available when Bulk or BulkV2 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](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_concepts_limits.htm).

This property is available when Bulk or BulkV2 is selected from the Query Mode drop-down list. | | Split query results into
small sets | Select this option to split the query results into data sets. You can set the
maximum number of records a dataset can hold in the Maximum number
of records per set field.

This option is available when you select BulkV2 from the Query Mode drop-down list in the
Basic settings view. | | 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.



For more information, see [Use PK Chunking to Extract Large Data Sets from
Salesforce](https://developer.salesforce.com/blogs/engineering/2015/03/use-pk-chunking-extract-large-data-sets-salesforce.html).

This option is available
only when Bulk is selected from the Query Mode drop-down list. | | Use UTC time for datetime | Select this option to use the UTC time for datetime type data. If this option is cleared, the
local time is used. | | tStatCatcher Statistics | Select this checkbox to gather the Job processing metadata at the Job level
as well as at each component level. | ## Global Variables | Variables | Description | | --- | --- | | 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 guidance | Description | | --- | --- | | **Usage
rule** | This component is usually used as a start component of a Job or
subJob and it always needs an output link. | **Related concepts** * [Upserting Salesforce data based on external IDs](https://help.qlik.com/talend/en-US/components/8.0/salesforce/tsalesforceinput-tsalesforceconnection-tlogrow-upserting-salesforce-data-based-on-external-ids-standard-component-the-job "Here is an example of using Talend components to insert and update Salesforce Contact object data based on the mapping relationship with external IDs of the Account object.")