July 31, 2023

tMarketoCampaign – Docs for ESB Marketo 7.x

tMarketoCampaign

Retrieves campaign records, activity and campaign changes related data from
Marketo.

tMarketoCampaign Standard properties

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

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

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.

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

Secret key

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.

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

Action

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

  • get: Retrieves the details of
    a campaign, including Ids(Commas separated),
    Campaign(s) (Commas separated),
    Program(s)(Commas separated) and
    Workspace(s)(Commas separated).
  • getById: Retrieves the
    details of a campaign by campaign ID.
  • schedule: Plans a
    campaign.
  • trigger: Triggers a campaign by:

    • request: Request a campaign.
    • activate: Activates a campaign.
    • deactivate: Deactivates a
      campaign.
Process leads in batch

Select this check box to process the leads in batch.

This check box is available only when trigger is
selected from the Action drop-down list and
request is selected from the
Trigger drop-down list.

Batch size Specify the number of leads to be processed in a batch, with the
maximum size of 100 leads.

This field is available only when:

  • get is selected from the
    Action drop-down list, or
  • trigger is selected from the
    Action drop-down list and
    request is selected from the
    Trigger drop-down list.
Clone to ProgrameName Specify the program that you want to clone the campaign to.

This
field is available only when schedule is selected
from the Action drop-down list.

Run At Specify the time when you run the campaign.

This field is available
only when schedule is selected from the
Action drop-down list.

Tokens Add the tokens that you want to use in a program.

This field is
available only when schedule or
trigger is selected from the
Action drop-down 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 not available when CustomObject is
selected from the Operation list in the REST API
mode.

Die on error

Select the check box to stop the execution of the Job when an 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/.

Timeout

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

Max reconnection attempts

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


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