tMarketoListOperation - 6.3

Talend Open Studio for Big Data Components Reference Guide

EnrichVersion
6.3
EnrichProdName
Talend Open Studio for Big Data
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Function

The tMarketoListOperation component adds/removes one or more leads to/from a list in the Marketo DB; It also verifies if one or more leads exist in a list in Marketo DB.

Purpose

The tMarketoListOperation component allows you to add/remove one or more leads to/from a list in the Marketo DB on a Web server. Also, you can verify the existence of one or more leads in a list in the Marketo DB.

tMarketoListOperation Properties

Component family

Business/Cloud

 

Basic 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.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

Click Sync columns to retrieve the schema from the previous component connected in the Job.

The schema of this component is read-only. You can click Edit schema to view the schema.

 

 

Built-in: No property data is stored centrally.

 

 

Repository: Select the Repository file where Properties are stored.

 

Endpoint address

The URL of the Marketo Web server for the SOAP API calls to.

 

Secret key

Encrypted authentication code assigned by Marketo.

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.

Note

Contact Marketo Support via for further information.

 

Client Access ID

A user ID for the access to Marketo web service.

Note

Contact Marketo Support via for further information.

 

Operation

Options in this list allow you carry out the adding/deletion one or more leads to/from a list in the Marketo DB; Also you can verify the existence of single or multiple leads in a list in the Marketo DB.

addTo: This operation adds one or more leads to a list in the Marketo DB.

isMemberOf: This operation checks the Marketo DB to judge whether the specific leads exist in the list.

removeFrom: This operation removes one or more leads from a list in the Marketo DB.

 

Add or remove multiple leads

Select this check box to add multiple leads to or remove multiple leads from a list in the Marketo DB.

Note

This check box appears only when you select addTo or removeFrom from the Operation list.

 

Die on error

This check box is selected by default. Clear the check box to skip the row on error and complete the process for error-free rows. If needed, you can retrieve the rows on error via a Row > Reject connection.

 

Timeout (milliseconds)

Type in the query timeout (in milliseconds) on the Marketo Web service.

Note

The Job will stop when Timeout exception error occurs.

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/.

 

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_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. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

This component is usually used as an intermediate component, and it requires an input component and an output component.

Limitation

n/a

Scenario: Adding a lead record to a Marketo list using SOAP API

The following scenario describes a three-component Job that adds a lead record into a specified list in the Marketo database using SOAP API.

Setting up the Job

  1. Create a new Job and add a tFixedFlowInput component, a tMarketoListOperation component, and a tLogRow component by typing their names in the design workspace or dropping them from Palette.

  2. Double-click the tMarketoListOperation component to open its Basic settings view on the Component tab, and in the API Mode area make sure the SOAP API mode is selected.

  3. Connect tFixedFlowInput to tMarketoListOperation using a Row > Main connection. In the pop-up dialog box, click Yes to get the schema from the target component.

  4. Connect tMarketoListOperation to tLogRow using a Row > Main connection.

Configuring the components

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

  2. Click the [...] button next to Edit schema to view its schema.

  3. In the Mode area, select Use Inline Table, and then click the [+] button to add one row and fill the row with respective values. In this example, these values are: MKTOLISTNAME for ListKeyType, Test_Comp_QA for ListKeyValue, IDNUM for LeadKeyType and 9300203 for LeadKeyValue.

  4. Double-click the tMarketoListOperation component to open its Basic settings view.

  5. In the Endpoint address field, enter the Marketo SOAP API endpoint URL that can be found on the Marketo Admin -> Web Services panel.

    In the Client Access ID and Secret key fields, enter the user ID and encryption key required to access Marketo.

  6. From the Operation list, select addTo to add the lead with the ID 9300203 into the list Test_Comp_QA.

  7. Double-click the tLogRow component to open its Basic settings view.

  8. Click the Sync columns button to synchronize the schema with the input schema.

  9. In the Mode area, select Table (print values in cells of a table) for better readability of the result.

Saving and executing the Job

  1. Press Ctrl + S to save the Job.

  2. Press F6 or click Run on the Run tab to run the Job.