July 31, 2023

tSalesforceConnection – Docs for ESB Sales Force 7.x

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

tSalesforceConnection

Opens a connection to Salesforce.

tSalesforceConnection Standard properties

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

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

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.

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.

Bulk Connection

Select this check box if you need to use bulk data processing
function.

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.

Use Http Chunked

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

This property
is available only when the Bulk Connection check box is
cleared.

Trace HTTP message

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

This
property is available only when the Bulk Connection
check box is selected.

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

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 more commonly used with other Salesforce components.

Connecting to Salesforce using OAuth implicit flow to authenticate the user
(deprecated)

In this scenario, the OAuth2 (Open
Authorization 2.0) method is adopted to authorize tSalesforceConnection to access the Salesforce resources. This way, better
security is achieved as users do not need entering their Salesforce username/password directly
on tSalesforceConnection, which is required by the
Basic login type instead.

tSalesforceConnection_1.png

Setting up the Job

  1. Drop a tSalesforceConnection component, a
    tFixedFlowInput component and a tSalesforceOutput component onto the
    workspace.
  2. Link the tFixedFlowInput component to the
    tSalesforceOutput component using a
    Row > Main
    connection.
  3. Link the tSalesforceConnection component to
    the tFixedFlowInput component using a Trigger > OnSubjobOk
    connection.

Configuring the components

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

    tSalesforceConnection_2.png

  2. Select OAuth from the
    Connection type drop-down list and Implicit
    Flow     from the Oauth2 flow type drop-down
    list.
  3. In the Client Id and Client Secret
    fields, enter the key and secret used by the consumer to access Salesforce
    respectively.
  4. In the Callback Host and Callback
    Port     fields, enter the callback host and port information
    respectively.
  5. In the Token File field, browse to or enter
    the path to the token file that stores the refresh token used by the OAuth-enabled
    connected app to obtain new sessions without requiring the user to provide their
    credentials.
  6. Double-click the tFixedFlowInput component to open its Basic settings view.

    tSalesforceConnection_3.png

  7. Click the […] button next
    to Edit schema and in the pop-up schema dialog
    box, define the schema by adding one column Name of String
    type. When done, click OK to save the changes
    and close the dialog box.

    tSalesforceConnection_4.png

  8. In the Mode area, select
    Use Inline Content (delimited file). Then
    in the Content field displayed, enter the data
    to be written into Salesforce. For example, Talend.
  9. Double-click the tSalesforceOutput component to open its Basic settings view.

    tSalesforceConnection_5.png

  10. Select the tSalesforceConnection component from the Connection
    Component     drop-down list to reuse the connection created by it.
  11. 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.
  12. Click the […] button next
    to Edit schema to open the schema dialog box.
    On the right side of the panel, remove all the columns except the column
    Name. When done, click OK to save
    the changes and close the dialog box.

    tSalesforceConnection_6.png

Executing the Job

  1. Press Ctrl + S to save the Job.
  2. Press F6 to run the Job. The Studio console
    gives the URL (in yellow) for OAuth authorization.

    tSalesforceConnection_7.png

  3. Copy the URL to the browser’s address bar. The Salesforce.com login page
    appears.

    tSalesforceConnection_8.png

  4. Fill up the username and password and click Log in to
    Salesforce    .

    The authorization response is then shown on the browser at the callback
    host.
    tSalesforceConnection_9.png

  5. Now is the time for the Job to continue running.

    tSalesforceConnection_10.png

    As shown above, the Job is successfully executed.
  6. Go to the Salesforce.com and check the Account object. You can find that the
    account whose name is Talend is
    inserted.

    tSalesforceConnection_11.png

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