tMarketoInput Properties - 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

Component family

Business/Cloud

 

Basic settings

Endpoint address

Enter the API Endpoint URL of the Marketo Web server.

 

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.

Contact Marketo Support via to get this information.

 

Client Access ID

A user ID for the access to Marketo web service.

Contact Marketo Support via to get this information.

 

Operation

Select one of the following operations to be performed from the drop-down list.

  • getLead: This operation retrieves basic information of leads and lead activities in Marketo DB.

  • getMultipleLeads: This operation retrieves lead records in batch.

  • getLeadActivity: This operation retrieves the history of activity records for a single lead identified by the provided key.

  • getLeadChanges: This operation checks the changes on Lead data in Marketo DB.

 

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.

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

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.

 

Columns Mapping

You can set the mapping conditions by making changes in Edit Schema. By default, column names in Column fields are the same as what they are in the schema.

Note

Because some column names in Marketo database may contain blank space, which is not al­lowed in the component schema, you need to specify the corresponding column fields in the Columns in Marketo field. If the defined column names in schema are the same as column names in Marketo data­base, it is not necessary to set the columns mapping.

 

Lead Selector

Select one of the following lead selector types from the list:

  • LeadKeySelector: Select this type to retrieve lead records that are identified by the specified lead key.

  • StaticListSelector: Select this type to retrieve lead records that match the specified static list.

    With this option selected, you need to specify a static list by selecting List Name or List ID from the list displayed and enter the value in the field next to the list.

  • LastUpdateAtSelector: Select this type to retrieve lead records that were updated on specific dates.

This list is available only when getMultipleLeads is selected from the Operation list, and LastUpdateAtSelector is available only in the SOAP API mode.

 

LeadKey type

The data types of LeadKey supported by Marketo DB.

This list is available when:

  • getLead is selected from the Operation list, or

  • getMultipleLeads is selected from the Operation list and LeadKeySelector is selected from the Lead Selector list, or

  • getLeadActivity is selected from the Operation list in the SOAP API mode.

 

LeadKey value

The value of LeadKey.

This field is available when:

  • getLead is selected from the Operation list, or

  • getLeadActivity is selected from the Operation list in the SOAP API mode.

 

LeadKey values

Specify the values of the LeadKey by selecting a column from the input flow that holds the LeadKey values.

This list is available only when getMultipleLeads is selected from the Operation list and LeadKeySelector is selected from the Lead Selector list.

 

Set Include Types

Select this check box to include the types of LeadActivity content to be retrieved. Click the plus button under the Include Types area to select in the list types to add.

This field is available when:

  • getLeadActivity is selected from the Operation list, or

  • getLeadChanges is selected from the Operation list in the SOAP API mode.

 

Set Exclude Types

Select this check box to exclude the types of LeadActivity content to be retrieved. Click the plus button under the Exclude Types area to select in the list types to add.

This field is available when:

  • getLeadActivity is selected from the Operation list, or

  • getLeadChanges is selected from the Operation list in the SOAP API mode.

 

Oldest Updated At

Type in the time of the earliest update to retrieve only the leads updated since the specified time.

It supports the time format that Marketo supports. For the supported time format, see http://developers.marketo.com/documentation/soap/getmultipleleads/.

This field is available only when getMultipleLeads is selected from the Operation list and LastUpdateAtSelector is selected from the Lead Selector list in the SOAP API mode.

 

Last Updated At

Type in the time of the latest update to retrieve only the leads updated before the specified time.

It supports the time format that Marketo supports. For the supported time format, see http://developers.marketo.com/documentation/soap/getmultipleleads/.

This field is available only when getMultipleLeads is selected from the Operation list and LastUpdateAtSelector is selected from the Lead Selector list in the SOAP API mode.

 

Oldest create date

Type in the time of the earliest creation to retrieve only the data since the specified time. It supports the time format that Marketo supports.

This field is available only when getLeadChanges is selected from the Operation list in the SOAP API mode.

 

Latest create date

Type in the time of the latest creation to retrieve only the data before the specified time. It supports the time format that Marketo supports.

This field is available only when getLeadChanges is selected from the Operation list in the SOAP API mode.

Oldest create date and Latest create date can be specified together or separately.

 

Fields (Separated by commas)

Enter the comma separated list of field names.

This field is available when getLeadChanges is selected from the Operation list in the REST API mode.

 

Since DateTime

Enter the time to retrieve only the data created since the specified time.

This field is available when getLeadActivity or getLeadChanges is selected from the Operation list in the REST API mode.

 

Batch Size

The maximum batch size in retrieving lead data in batch.

This field is available when:

  • getMultipleLeads is selected from the Operation list and StaticListSelector or LastUpdateAtSelector is selected from the Lead Selector list.

  • getLeadActivity or getLeadChanges is selected from the Operation list.

 

Timeout (milliseconds)

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

The Job will stop when Timeout exception error occurs.

 

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.

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

 

Max number of reconnection attempts

Specify the maximum number of times to reconnect to the Marketo Web server in case of loss of connection.

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 a start component of a Job or Subjob and it always needs an output link.

Limitation

n/a