tMarketoInput Standard properties - 7.3

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.

Select the component whose connection details will be used to set up the connection to Marketo from the drop-down list.

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

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

The client ID and client secret key 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.

Enter the client secret key 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.

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.

• Built-In: You create and store the schema locally for this component only.

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

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.

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.

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

• getLead: This operation retrieves a single lead record.
• getMultipleLeads: This operation retrieves a batch of lead records that match the specified lead selector search condition.
• getLeadActivity: This operation retrieves the activity history that matches the specified search condition.
• getLeadChanges: This operation retrieves data value changes and new lead activities after a given time.
• CustomObject: Select this item to perform specific action on a custom object. This item is available only in the REST API mode.
• Company: This operation retrieves the company. also referred to as an account, that a person belongs to.
• Opportunity: This operation retrieves the opportunity that is associated with a lead or contact and a company.
• OpportunityRole: This operation retrieves the specific role within an opportunity.

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 not available when CustomObject is selected from the Operation list in the REST API mode.

Select one of the following lead selector types from the drop-down 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 are members of the given static list. With this option selected, you need to specify the static list by its name or id. To do this, select STATIC_LIST_NAME or STATIC_LIST_ID from the List param drop-down list and then enter the key value of the name or id in the List param value field.
• LastUpdateAtSelector: Select this type to retrieve lead records that were updated on specific dates. This item is available only in the SOAP API mode.

This list is available only when getMultipleLeads is selected from the Operation list.

Select a field by which you want to query the lead from the drop-down list. 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.

Specify the value of the field by which you want to query the lead. 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, or
• getMultipleLeads is selected from the Operation list and LeadKeySelector is selected from the Lead Selector list.

Select this check box and in the Activity table displayed, specify the types of activity you want to retrieve by clicking the [+] button to add as many rows as needed, each row for an activity type, then clicking the right side of each cell and selecting an activity type from the drop-down list. This check box is available when:

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

Select this check box and in the Activity table displayed, specify the types of activity you do not want to retrieve by clicking the [+] button to add as many rows as needed, each row for an activity type, then clicking the right side of each cell and selecting an activity type from the drop-down list. This check box is available when:

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

Specify 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 in the SOAP API mode when getMultipleLeads is selected from the Operation list and LastUpdateAtSelector is selected from the Lead selector list.

Specify 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 in the SOAP API mode when getMultipleLeads is selected from the Operation list and LastUpdateAtSelector is selected from the Lead selector list.

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 in the SOAP API mode when getLeadChanges is selected from the Operation list.

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 in the SOAP API mode when getLeadChanges is selected from the Operation list.

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

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.

Specify the timestamp used to filter results to only include leads with activity since then.

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

Select the operation to be performed on the specified custom object.

• describe: Returns the metadata regarding a given custom object.
• list: Returns a list of custom object types available in the target instance, along with id and deduplication information for each type. With this option selected, you need to specify a comma-separated list of names to filter types in the CustomObject names field.

  This property is available only when CustomObject is selected from the Operation drop-down list.

• get: Retrieves a list of custom objects records based on filter and set of values.

This field is available only when CustomObject, Company, Opportunity or OpportunityRole is selected from the Operation drop-down list.

Click this button to retrieve the schema of the specified custom object.

This button is available only when CustomObject is selected from the Operation list and get is selected from the Action list.

Specify the field to filter on. Searchable fields can be retrieved by performing a describe action with the custom object.

This field is available only when CustomObject is selected from the Operation list and get is selected from the Action list.

Specify a comma-separated list of field values to match against.

This field is available only when CustomObject is selected from the Operation list and get is selected from the Action list.

Specify the number of records to be processed in each 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.

• CustomObject is selected from the Operation list and get is selected from the Action list.

Die on error

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

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

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

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

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

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

The number of calls. This is an After variable and it returns an integer.

The error message generated by the component when an error occurs. This is an After variable and it returns a string.

Usage rule

This component is usually used as a start component of a Job or subJob and it always needs an output link.