August 15, 2023

tMarketoOutput – Docs for ESB 6.x

  2. Talend for ESB Docs
  3. Docs 6.x
  4. tMarketoOutput – Docs for ESB 6.x

tMarketoOutput

Writes lead records or custom object records from the incoming data flow into
Marketo.

tMarketoOutput Standard properties

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

The Standard
tMarketoOutput component belongs to
two
families: Business and
Cloud.

The component in this framework is generally available.

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 whose connection details will be used
to set up the connection to Marketo from the drop-down list.
Endpoint address

Enter the API Endpoint URL of the Marketo Web Service. The API
Endpoint URL can be found on the Marketo Admin > Web Services panel.
Client access ID

Enter the client Id for the access to the Marketo Web
Service.

The client Id and client secret can be found on the Marketo Admin > LaunchPoint panel, by clicking View Details for the service to be
accessed. You can also contact Marketo Support via support@marketo.com for further
information.
Secret key

Enter the client secret for the access to the Marketo Web
Service.

To enter the secret key, click the […] button next to
the secret key field, and then in the pop-up dialog box enter the password between double
quotes and click OK to save the settings.
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. The schema is either Built-In or stored remotely in the Repository.

  • Built-In: You create and store the
    schema locally for this component only. Related topic: see
    Talend Studio

    User Guide.

  • Repository: You have already created
    the schema and stored it in the Repository. You can reuse it in various projects and
    Job designs. Related topic: see
    Talend Studio

    User Guide.

The schema of this component is predefined and it will be
different according to the API mode selected, the operation chosen or the custom object
specified.

Note that when the API mode is changed, you need to refresh the
schema columns manually by switching back and forth the components in the
Connection Component drop-down list (only when reusing the connection
created by a tMarketoConnection component) and changing the operation
to be performed in the Operation drop-down list.

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.

Note that the dynamic schema feature for this
component is only supported in the REST API mode.
Operation

Select an operation that allows you to synchronize data
between Marketo and another external system.

  • syncLead: Insert or update (upsert) a
    single lead record.

  • syncMultipleLeads: Insert or update
    (upsert) multiple lead records.

  • deleteLeads (for REST only): Delete a list
    of leads.

  • syncCustomObjects (for REST only): Insert,
    update, or upsert custom object records to the target
    instance.

  • deleteCustomObjects (for REST only):
    Delete a set of custom object records.
Operation type

Select a type of sync operation to be performed from the drop-down
list.

  • createOnly: creates new leads.

  • updateOnly: updates existing leads.

  • createOrUpdate: creates new leads, or
    updates the leads if they already exist.

  • createDuplicate: creates new leads. If
    they already exist, then creates duplicated leads.

This list is available only in the REST API mode when
syncLead or
syncMultipleLeads is selected from the
Operation list.
Lookup field

Select the lookup field that will be used to find the duplicate.

This list is available only in the REST API mode when
syncLead or
syncMultipleLeads is selected from the
Operation list.
Mappings

Complete this table to map the column names of the component schema
with the column names in Marketo. By default, the column names in Column
name fields are the same as what they are in the schema.

Note that because some column names in Marketo may contain blank
space, which is not allowed in the component schema, you need to specify the corresponding
column fields in the Marketo column name column. If the defined column
names in schema are the same as column names in Marketo, it is not necessary to set the
columns mapping.

This table is available only in the SOAP API mode.
Dedupe prospects record using the email address

Select this check box to de-duplicate records using email address.

Clear this check box to create another record which contains the same
email address.
Delete leads in batch

Select this check box to delete the leads in batch.

This check box is available only when deleteLeads
is selected from the Operation list.
Batch Size

Specify the number of records to be processed in each batch.

This field is available when:

  • syncMultipleLeads is selected from the
    Operation list, or
  • deleteLeads is selected from the
    Operation list and the Delete
    leads in batch     check box is selected.
Sync method

Select a type of sync operation to be performed from the drop-down
list.

This list is available only when syncCustomObjects
is selected from the Operation list.
Dedupe by

Specify the field on which the records will be deduplicated.

This field is available only when
syncCustomObjects is selected from the
Operation list.
Delete by

Select the field by which the delete operation will be performed.

This list is available only when
deleteCustomObjects is selected from the
Operation list.
Custom object name

Specify the name of the custom object.

This field is available only when
syncCustomObjects or
deleteCustomObjects is selected from the
Operation list.
Die on error

Select the check box to stop the execution of the Job when an error
occurs.

Clear the check box to skip any rows on error and complete the
process for error-free rows.

When errors are skipped, you can collect the
rows on error using a Row > Reject connection. But note that no error rows can be collected
when syncing or deleting leads in batch.

Advanced settings

API Mode

Select the Marketo API mode, either REST API
(default) or SOAP API.

For more information about the Marketo REST API, see http://developers.marketo.com/documentation/rest/.

For more information about the Marketo SOAP API, see http://developers.marketo.com/documentation/soap/.
Timeout

Enter the timeout value (in milliseconds) for the connection to the
Marketo Web Service before terminating the attempt.
Max reconnection attemps

Enter the maximum number of reconnect attempts to the
Marketo Web Service before giving up.
Attempt interval time

Enter the time period (in milliseconds) between subsequent
reconnection attempts.

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

NUMBER_CALL

The number of calls. 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 an end component of a Job or Subjob and it
always needs an input link.

Data transmission with Marketo using REST API

Here is an example of using Talend components to connect to
Marketo, insert several lead records into Marketo, then retrieve these records from Marketo
and display them on the console.

Use_Case_tMarketoOutput1.png

Setting up the Job for data transmission with Marketo using REST
API

  1. Add a tMarketoConnection component, two
    tFixedFlowInput components, a
    tMarketoOutput component, a tMarketoInput component, and a tLogRow component by typing their names on the
    design workspace or dropping them from the Palette.
  2. Make sure REST is selected from the
    API Mode drop-down list on the Advanced
    settings     view of tMarketoOutput and
    tMarketoInput.
  3. Connect the first tFixedFlowInput component to the tMarketoOutput component using a Row > Main connection.
    In the pop-up dialog box, click Yes so
    that the first tFixedFlowInput component
    can get the schema from the target tMarketoOutput component.
  4. Connect the second tFixedFlowInput component to the tMarketoInput component using a Row > Main
    connection. In the pop-up dialog box, click No and the second tFixedFlowInput component will not get the schema from the
    target tMarketoInput component.
  5. Connect the tMarketoInput component to the tLogRow component using a Row > Main
    connection.
  6. Connect the tMarketoConnection component to the first
    tFixedFlowInput component using a
    Trigger > On Subjob Ok
    connection.
  7. Do the same to connect the first tFixedFlowInput component to the second tFixedFlowInput component.

Connecting to Marketo using REST API

Before connecting to Marketo using the REST API endpoint, you need to make sure a
custom service, which provides credentials to authenticate with Marketo and allows
you to access the data in Marketo, has been created and associated with a single
API-only user by your Marketo administrator. For more information about the Marketo
Custom Service, see Custom Services.

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

    tmarketooutput_scenario_tmarketoconnection.png

  2. In the Endpoint address
    field, enter the REST API endpoint URL that can be found on the Marketo
    Admin > Web Services panel.
  3. In the Client Access ID and Secret key fields, enter the client Id and
    client secret required to access Marketo.

    The client Id and client secret can be found on the Marketo Admin > LaunchPoint panel, by clicking View Details for
    the service to be accessed.

Inserting lead records into Marketo using REST API

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

    Use_Case_tMarketoOutput2.png

  2. Click the […] button
    next to Edit schema to open the schema
    dialog box.

    Use_Case_tMarketoOutput3.png

  3. In the schema dialog box, select the id
    and Status columns that don’t need input values and click
    the button_remove_selected_items.png button to remove them. Then click OK to save the settings and close the schema
    dialog box.
  4. In the Mode area, select
    Use Inline Content(delimited file)
    and enter the following input data in the Content field.

  5. Double-click the tMarketoOutput component to open its Basic settings view.

    Use_Case_tMarketoOutput4.png

  6. From the Connection Component drop-down list, select the
    component whose connection details will be used to set up the connection to
    Marketo, tMarketoConnection_1 in this example.
  7. From the Operation
    drop-down list, select SyncMultipleLeads
    to insert multiple lead records.
  8. From the Operation type drop-down list, select
    createDuplicate to allow duplicated
    leads to be created.

Retrieving lead records from Marketo using REST API

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

    Use_Case_tMarketoOutput5.png

  2. Click the components-button_three_dot.png
    button next to Edit schema and in the
    schema dialog box displayed, define the schema by adding one column
    mail of String
    type. Then click OK to save the changes
    and close the schema dialog box.

    Use_Case_tMarketoOutput6.png

  3. In the Mode area, select
    Use Inline Table. Then click the
    Button_Plus.png button twice
    below the table displayed to add two rows and fill each row with respective
    values. In this example, two email values dev@talend.com
    and doc@talend.com are added so that the lead records
    identified by these email values can be retrieved.
  4. Double-click the tMarketoInput component to open its Basic settings view.

    Use_Case_tMarketoOutput7.png

  5. From the Connection Component drop-down list, select the
    component whose connection details will be used to set up the connection to
    Marketo, tMarketoConnection_1 in this example.
  6. Select getMultipleLeads
    from the Operation drop-down list to
    retrieve a batch of lead records.
  7. Select LeadKeySelector from the Lead
    selector     drop-down list, and select email
    from the Lead key type list and
    email from the Lead key values
    list to retrieve the leads identified by the email values passed from the second
    tFixedFlowInput component.
  8. Double-click the tLogRow
    component to open its Basic settings
    view.
  9. In the Mode area, select
    Table (print values in cells of a
    table)     for better readability of the result.

Executing the Job to transmit data with Marketo using REST API

  1. Press Ctrl + S to save the Job.
  2. Press F6 to execute the
    Job.

    Use_Case_tMarketoOutput9.png

    As shown above, the inserted lead records in Marketo are retrieved and
    displayed on the console.

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