tSalesforceBulkExec Standard properties - Cloud - 8.0

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 with the Json Web Token Flow OAuth 2.0 authentication flow type. To use this option, 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 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.

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.

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 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:

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

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.

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 or update existing records. In the Upsert Key Column field displayed, specify the key column for the upsert operation. By selecting Output upsert column, a column named UpsertColumnValue will be added to the output schema. The column holds upsert key values and thus can be used to monitor the upsert key. You can select Output upsert column if the upsert key is a variable.

• DELETE: delete one or more records in Salesforce.

Bulk File Path

Specify the path to the file that stores the data to be processed.

Content type

Select the format of the file to load data from. Currently, two file formats are supported: JSON and CSV. Because Bulk API 2.0 does not support JSON format, do not select the Bulk API V2 option in the Advanced settings view if you want to load data from a JSON file.

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.

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.

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.

Bulk API V2

Select this checkbox to create a Bulk API V2 Job, and then select a type of field delimiter from the Column Delimiter drop-down list and a way of line ending from the Line Ending drop-down list respectively for CSV data.

Compared with Bulk API V1, Bulk API v2 simplifies the way of processing data.

This property is available only when the OAuth connection type is selected.

Concurrency Mode

Select the concurrency mode for the Job.

• Parallel: process batches in parallel mode.

• Serial: process batches in serial mode.

Rows to Commit

Specify the number of lines per data batch to be processed.

Bytes to Commit

Specify the number of bytes per data batch to be processed.

Wait Time Check Batch State

Specify the wait time (in milliseconds) for checking whether the batches in a Job have been processed until all batches are finally processed.

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.

tStatCatcher Statistics

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

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 rule

This component is more commonly used with the tSalesforceOutputBulk component. Used together, they gain performance while feeding or modifying information in Salesforce.