July 31, 2023

tSalesforceGetDeleted – Docs for ESB Sales Force 7.x

  2. Talend for ESB Docs
  3. Docs 7.x
  4. tSalesforceGetDeleted – Docs for ESB Sales Force 7.x

tSalesforceGetDeleted

Collects data deleted during a specific period of time from a Salesforce
object.

tSalesforceGetDeleted Standard properties

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

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

Audience

Json Web Token audience.

You can set your own Json Web Token
audience.

This property is available only
when OAuth is selected from the Connection type
drop-down list and Json Web Token Flow is selected from the the
Oauth2 flow type drop-down list.

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

Start Date

Click the […] button
next to the field and in the calendar dialog box displayed, select the date and
time to collect only the data deleted since the specified time.

Note that you can collect only the data deleted in the past 30
days.

End Date

Click the […] button
next to the field and in the calendar dialog box displayed, select the date and
time to collect only the data deleted before the specified time.

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.

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.

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.

Recovering deleted data from Salesforce

This scenario describes a two-component Job that collects the account data
deleted over the past five days from Salesforce.

tSalesforceGetDeleted_1.png

Setting up the Job for recovering deleted data from Salesforce

  1. Create a new Job and add a tSalesforceGetDeleted component and a tLogRow component by typing their names on the design workspace
    or dropping them from the Palette.
  2. Connect the tSalesforceGetDeleted component
    to the tLogRow component using a Row > Main
    connection.

Configuring the Job for recovering deleted data from Salesforce

  1. Double-click the tSalesforceGetDeleted component to open its Basic settings view.

    tSalesforceGetDeleted_2.png

  2. In the User Id, Password and Security
    Key     fields, enter the user authentication information required
    to access Salesforce.
  3. Click the […] button
    next to the Module Name field and in the
    pop-up dialog box, select the object you want to access. In this example, it is
    Account. When done, click OK
    to save the settings and close the dialog box.

    tSalesforceGetDeleted_3.png

  4. Click the […] button
    next to the Start Date field and in the
    pop-up calendar dialog box, set the value of the start date and time to collect
    only the data deleted since the specified time. In this example, it is
    2016-06-08 00:00:00.

    tSalesforceGetDeleted_4.png

  5. Do the same to set the value of the end date and time in the End Date field to collect only the data deleted
    before the specified time. In this example, it is 2016-06-13
    00:00:00    .
  6. Double-click the tLogRow
    component to open its Basic settings
    view.

    tSalesforceGetDeleted_5.png

  7. Click Sync columns to
    retrieve the schema from the preceding component.
  8. In the Mode area, select
    Vertical (each row is a key/value
    list)     to display the results in a tabular form on the
    console.

Executing the Job to recover deleted data from Salesforce

  1. Press Ctrl + S to save your Job.
  2. Press F6 to run your
    Job.

    tSalesforceGetDeleted_6.png

    As shown above, the data deleted during the past five days is collected and
    displayed in a tabular form on the console.

Document get from Talend https://help.talend.com
Thank you for watching.
Docs 7.x
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x