39
TIBCO ActiveMatrix BusinessWorks Plug-in for Marketo User's Guide Software Release 6.0 May 2014 Two-Second Advantage ®

TIBCO ActiveMatrix BusinessWorks Plug-in for Marketo User ... · PDF fileTIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide Software Release 6.0 May 2014 Two-Second

  • Upload
    ngonhu

  • View
    231

  • Download
    3

Embed Size (px)

Citation preview

TIBCO ActiveMatrix BusinessWorks™ Plug-infor Marketo User's GuideSoftware Release 6.0May 2014

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BusinessWorks, TIBCO Business Studio, andTIBCO Enterprise Administrator are either registered trademarks or trademarks of TIBCO SoftwareInc. in the United States and/or other countries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

Copyright © 2013-2014 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information

2

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Plug-in Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Web Service Description Language (WSDL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Creating a Marketo Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Designing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Debugging and Running a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Generating an EAR File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Marketo Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Marketo Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Retrieve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Input and Output for Single Lead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Input and Output for Multiple Leads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Input and Output for Lead Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Input and Output for Lead Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Input and Output for Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Input and Output for MObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Input and Output for ImportStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Upsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Input and Output for Leads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Input and Output for Multiple Leads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Input and Output for MObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Input and Output for Request Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

Input and Output for Schedule Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

Input and Output for Merge Leads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

Importing Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Configuring Shared Resource in the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Configuring in Marketo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Working with MObjectOperation Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Configurations for MObjectOperation Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Working with ScheduleCampaignOperation Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Configurations for ScheduleCampaignOperation Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Working with RemoveTestData Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

3

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Configurations for RemoveTestData Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Managing Logs in Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

4

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

TIBCO Documentation and Support Services

All TIBCO documentation is available in the TIBCO Documentation Library, which can be found here:

https://docs.tibco.com

Product-Specific Documentation

The following documents for this product can be found in the TIBCO Documentation Library:

● TIBCO ActiveMatrix BusinessWorks Plug-in for Marketo Installation● TIBCO ActiveMatrix BusinessWorks Plug-in for Marketo User's Guide● TIBCO ActiveMatrix BusinessWorks Plug-in for Marketo Release Notes

The following documents provide additional information and can be found in the TIBCODocumentation Library:

● TIBCO ActiveMatrix BusinessWorks Documentation● TIBCO Enterprise Administrator User's Guide

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact TIBCO Support asfollows:

● For an overview of TIBCO Support, and information about getting started with TIBCO Support,visit this site:

http://www.tibco.com/services/support

● If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name, you canrequest one.

How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is aplace to share and access the collective experience of the TIBCO community. TIBCOmmunity offersforums, blogs, and access to a variety of resources. To register, go to:

http://www.tibcommunity.com

5

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Plug-in Overview

This plug-in enables users to utilize the benefits of Marketo without any coding.

TIBCO ActiveMatrix BusinessWorks is an easy to use integration product suite for enterprise, web, andmobile applications. It uses the Eclipse graphical user interface (GUI) for defining business processesand process engine to execute them.

TIBCO ActiveMatrix BusinessWorks Plug-in for Marketo plugs into TIBCO ActiveMatrixBusinessWorks, which bridges TIBCO ActiveMatrix BusinessWorks with Marketo. It allowsActiveMatrix BusinessWorks users to connect to Marketo, leverage the Marketo data to createautomations, move data between Marketo and internal system.

The plug-in provides the following common functionalities for integrating Marketo:

● Access the objects such as leads, multiple leads, MObjects, lead activities, lead changes, campaign,and import status.

● Insert or update leads, multiple leads, merge lead, MObjects, request campaigns, and schedulecampaigns.

● Delete MObjects.● Import leads to a static list.

Web Service Description Language (WSDL)This plug-in uses the Marketo WSDL, which contains service and schema definitions, to defineactivities. All the input and output of activities are generated from the Marketo WSDL.

You can get and refresh the Marketo WSDL files by clicking Refresh/Apply in the Marketo Connection.See Marketo Connection for more information.

This manual applies to the version 2_3 of the Marketo WSDL. If you apply other WSDL versions to aproject, the input and output fields may be different from the fields described in Marketo Palette.

The plug-in generates schemas based on the Marketo WSDL definitions at design time and interactswith Marketo through the Marketo API at runtime. If there is a mismatch between the Marketo WSDLand API, for example, a case where the Marketo API only accepts a subset of the fields defined in theMarketo WSDL, data submitted to Marketo through the plug-in should conform to the Marketo API.See the Marketo API documentation for more information on the fields supported by the Marketo API.

6

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Getting Started

A typical workflow using the plug-in to achieve different goals includes creating a project, designing aprocess, and deploying the application.

TIBCO ActiveMatrix BusinessWorks enables users to create services and integrate applications, anddeploy them at runtime. It uses the Eclipse graphical user interface (GUI) for defining businessprocesses and process engine to execute them.

To design a process and deploy it at runtime, you need to complete the following tasks:

1. Creating a Project

2. Creating a Marketo Connection

3. Designing a Process

4. Debugging and Running a Process

5. Deploying an Application

Creating a ProjectBusinessWorks application modules are Eclipse projects that are created in TIBCO Business Studio,which contain various resources.

Procedure

1. Start TIBCO Business Studio.

2. Select File > New > BusinessWorks Resources.

3. Click the BusinessWorks Application Module resource in the BusinessWorks Resource wizard.Click Next.

4. Type a name for the project that you are creating in the Project name field.

5. Select the Create empty process check box and type a process name in the Name field.

6. Select the Create Application check box and type an application name in the Name field. ClickFinish.A project with the default settings is opened in the Project Explorer view.

Creating a Marketo ConnectionA Marketo Connection, which contains all the parameters for connecting to Marketo, is required whenusing the plug-in activities.

Prerequisites

The Marketo Connection is available at the Resources level. Before creating a Marketo Connection, youneed to create a project. See Creating a Project.

Procedure

1. Expand the created project in the Project Explorer view.

2. Right-click the Resources folder and select New > Marketo Connection.

3. Type a name for the Marketo Connection shared resource in the Marketo dialog. Click Finish.

4. Configure the Marketo Connection in the Marketo editor.See Marketo Connection regarding the configuration fields.

7

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

5. Click Test Connection to validate the connection.

6. Click Refresh/Apply to fetch the latest WSDL and metadata files.

Designing a ProcessProcesses capture and manage the flow of business information in an enterprise between different datasources and destinations. You can design a process by using activities and adding conditions.

By default, an empty process is created when creating a project with the Create empty process checkbox selected.

See TIBCO ActiveMatrix BusinessWorks Application Deployment for more details about creating processes.

Procedure

1. In the Process editor, select and drop an activity from the Palette view.

2. Click Link to create links between the activities.

3. Configure the added activities.

4. Click File > Save to save the process.

Debugging and Running a ProcessDebug the application you have configured to ensure that the application configuration is correct.

Procedure

1. Open the process you have configured in TIBCO Business Studio.

2. On the toolbar, click Run > Debug Configurations.

3. Click BusinessWorks Application > BWApplication in the left panel.

4. Ensure only the application you want to debug and run is selected in the Applications tab in theright panel.

5. Click the Advanced tab and click Browse to locate the logback file.By default, the log file resides in the TIBCO_HOME/bw/6.1/config/design/logback directory anderror logs are captured. See Managing Logs for more details.

6. Click Debug.TIBCO Business Studio changes to the Debug perspective. Logs are displayed in the Console view.

Deploying an ApplicationYou can manage BusinessWorks applications by using TIBCO Enterprise Administrator after deployingthe applications.

Prerequisites

The following tasks are required before deploying applications:

● Creating a Project.● Generating an EAR File.

A typical workflow of deployment includes:

1. Upload an EAR file.

8

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

2. Deploy an application.

3. Configure an application.

4. Start an application.

You can deploy an application EAR file by using the command-line mode with the bwadmin utility.See TIBCO ActiveMatrix BusinessWorks Administration for more details about how to deploy anapplication.

Generating an EAR FileApplication archives are enterprise archive (EAR) files that have been created in TIBCO BusinessStudio. An EAR file is required when deploying an application.

Prerequisites

An application project has already been created, as explained in Creating a Project.

There are many ways to generate an EAR file, the following is one method. See TIBCO ActiveMatrixBusinessWorks Administration for more information.

Procedure

1. Go to File Explorer and click Open Directory to Browse .

2. Select the folder where you want to generate the EAR file and click OK.The new folder is displayed in the File Explorer view

3. Drag the application from the Project Explorer to the new folder in the File Explorer.

The EAR file is generated with the name <application>_<version>.ear.

9

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Marketo Connection

The Marketo Connection shared resource contains all necessary parameters to connect to the Marketoserver. It is used by all the activities in the Marketo palette.

General

The General panel has the following fields.

FieldModuleProperty? Description

Package No The name of the package where the shared resource is located.

Name No The name for the shared resource.

Description No A short description for the shared resource.

Marketo Configuration

The Marketo Configuration panel has the following fields.

Values in the following fields are the SOAP API information of your Marketo account. See the Marketodocumentation for more information.

FieldModuleProperty? Description

Marketo URL Yes The endpoint to connect the Marketo SOAP API.

User ID Yes The user ID connecting the Marketo SOAP API.

Encryption Key Yes The encryption key to use SOAP API.

Test Connection Button

Click Test Connection to test whether the specified configuration fields result in a valid connection tothe Marketo server.

Refresh/Apply Button

Click Refresh/Apply to fetch the latest WSDL and metadata files from the URL specified in theMarketo URL field. The WSDL files are located in the wsdl folder in your project.

If you created custom fields in Marketo, you need to click Refresh/Apply to update the WSDL andmetadata files. The created custom fields will be displayed in the new activities using this sharedresource.

10

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Marketo Palette

The Marketo palette contains activities that can be added to your business processes.

The palette contains the following four activities:

● Delete● Import● Retrieve● Upsert

DeleteThe Delete activity is used to delete one or more MObjects and return the results of the operation.

General

The General tab has the following fields.

FieldModuleProperty? Description

Name No Specify the name for the activity.

Connection Yes Click to select a Marketo shared resource.

If no matching Marketo shared resources are found, click CreateShared Resource to create one. See Creating a Marketo Connectionfor more details.

Time Out Yes Specify the amount of time in milliseconds to wait for executing thedelete operation.

The value in this field must be in the range 0 to 2147483647. Avalue of 0 or negative indicates the default value, 10000milliseconds.

Delete Type No Specify the type of objects to be deleted.

Description

Provide a short description for the activity.

Input

The Input tab has the following fields.

Input Item Data Type Description

ParamsDeleteMObjects/mObjectList/mObject

11

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Input Item Data Type Description

type string The type of the MObject to be deleted.

Only some specific values are valid for this field, see theMarketo documentation for details.

id integer The ID of the MObject to be deleted.

externalKey string The external key of the MObject. An external key is associated with aname and a value.

createdAt dateTime The date and time when the MObject was created.

updatedAt dateTime The date and time when the MObject was updated.

attribList string A list of attributes that identify the MObject to be deleted. Anattribute is associated with a name and a value.

typeAttrib

List

string A list of type attributes that identify the MObject to be deleted. Atype attribute is associated with a name and a value.

association

List

complex A list of associated MObjects. Each mObjAssociation for anassociated MObject includes the following items:

● mObjType: The type of the associated MObject.

● id: The ID of the associated MObject.

● externalKey: The external key of the associated MObject. Anexternal key is associated with a name and a value.

Output

The Output tab has the following fields.

Output Item Data Type Description

SuccessDeleteMObjects/result/mObjStatusList/mObjStatus

id integer The ID of the MObject deleted during the operation.

externalKey string The external key of the MObject. An external key is associated witha name and a value.

status string The result of the delete operation.

error string An error message.

Fault

The Fault tab lists the exceptions that can be thrown by this activity.

12

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Exception Description

MarketoException The errors returned by Marketo.

MarketoPluginException The errors returned by the plug-in.

MarketoConnection

Exception

The errors occurred when establishing the web service connectionbetween the plug-in and Marketo.

ImportThe Import activity is used to import leads to an existing static list.

You can use the Retrieve activity the check the status of the import operation.

General

The General tab has the following fields.

FieldModuleProperty? Description

Name No Specify the name for the activity.

Connection Yes Click to select a Marketo shared resource.

If no matching Marketo shared resources are found, click CreateShared Resource to create one. See Creating a Marketo Connection formore details.

Time Out Yes Specify the amount of time in milliseconds to wait for executing theimport operation.

The value in this field must be in the range 0 to 2147483647. A value of0 or negative indicates the default value, 10000 milliseconds.

SyncMode No Select this check box to import leads synchronously.

CheckInterval

Yes Specify the time interval in milliseconds to check whether the importoperation is completed. The default value is 20000.

This field is displayed when the SyncMode check box isselected.

Description

Provide a short description for the activity.

Input

The Input tab has the following fields.

13

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Field Data Type Description

ParamsImportToList

program

Name

string The name of the program containing the static list that the leads areimported to.

importFile

Header

string The column headers for the leads to be imported, including leadattributes and my token names.

importFile

Rows

string The comma separated values of the leads to be imported. One rowper lead.

importList

Mode

string The mode for importing leads, UPSERTLEADS or LISTONLY.

● UPSERTLEADS: Creates or updates leads and add them to a staticlist.

● LISTONLY: Adds existing leads to a static list, skipping newleads.

listName string The name of the static list, which the leads are imported to.

clearList boolean Whether to clear the static list before importing leads, true orfalse.

● true: Clears the static list before importing leads.

● false: Appends the leads to the static list.

campaign

Name

string The name of the campaign where my token is used. The campaignmust be within the specified program.

Output

The Output tab has the following fields.

Output Item Data Type Description

SuccessGetImportToListStatus/result

status string The status of the import operation.

startedTime dateTime The start time of the import operation. The returned value canbe null.

endedTime dateTime The ended time of the import operation. The returned valuecan be null.

estimatedTime integer The elapsed time of the import operation. The returned valuecan be null.

14

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Output Item Data Type Description

estimatedRows integer The number of rows supposed to be imported during theoperation. The returned value can be null.

rowsImported integer The number of rows imported during the operation. Thereturned value can be null.

rowsFailed integer The number of rows failed to be imported during theoperation. The returned value can be null.

rowsIgnored integer The number of rows ignored during the operation. Thereturned value can be null.

import

Summary

string The summary of the import operation. The returned value canbe null.

Fault

The Fault tab lists the exceptions that can be thrown by this activity.

Exception Description

MarketoException The errors returned by Marketo.

MarketoPluginException The errors returned by the plug-in.

MarketoConnection

Exception

The errors that occurred when establishing the web serviceconnection between the plug-in and Marketo.

RetrieveThe Retrieve activity is used to retrieve leads, campaigns, and MObjects.

General

The General tab has the following fields.

FieldModuleProperty? Description

Name No Specify the name for the activity.

Connection Yes Click to select a Marketo shared resource.

If no matching Marketo shared resources are found, click Create SharedResource to create one. See Creating a Marketo Connection for moredetails.

15

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

FieldModuleProperty? Description

Time Out Yes Specify the amount of time in milliseconds to wait for executing theretrieve operation.

The value in this field must be in the range 0 to 2147483647. A value of 0or negative indicates the default value, 10000 milliseconds.

Object No Specify the type of objects to be retrieved.

Sub Type No Specify the type of the leads to be retrieved.

This field is displayed when Leads is selected in the Objectfield.

SelectorType

No Specify the type of lead selector.

This field is displayed when Multiple or Changes areselected in the Sub Type field.

Description

Provide a short description for the activity.

Input and Output

The input of the activity varies depending on the object type specified in the General tab.

● Input and Output for Single Lead● Input and Output for Multiple Leads● Input and Output for Lead Activity● Input and Output for Lead Changes● Input and Output for Campaign● Input and Output for MObjects● Input and Output for ImportStatus

Fault

The Fault tab lists the exceptions that can be thrown by this activity.

Exception Description

MarketoException The errors returned by Marketo.

MarketoPluginException The errors returned by the plug-in.

MarketoConnection

Exception

The errors that occurred when establishing the web serviceconnection between the plug-in and Marketo.

16

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Input and Output for Single LeadThe Input tab and the Output tab have the following fields for retrieving a single lead.

Input for Retrieving a Single Lead

Input Item Data Type Description

ParamsGetLead/leadKey

keyType string The key used to query a lead.

Only some specific values are valid for this field, see theMarketo documentation for details.

keyValue string The value of the key used to query a lead.

Output for Retrieving a Single Lead

Output Item Data Type Description

SuccessGetLead/result

count integer The number of lead records matching the input criteria.

leadRecord

List

string Attributes associated with the lead that has been retrieved.

Input and Output for Multiple LeadsThe Input tab and the Output tab have the following fields for retrieving multiple leads.

Input for Retrieving Multiple Leads

Input Item Data Type Description

ParamsGetMultipleLead

LeadKey

Selector

string The lead keys used to query multiple leads. The selector contains akey type and a key value.

● This field is displayed when LeadKeySelector isselected in the Selector Type field in the General tab.

● Only some specific values are valid for this field, seethe Marketo documentation for details.

17

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Input Item Data Type Description

LastUpdateAt

Selector

dateTime The timestamp to specify the query criteria, a date range. Theselector contains the following two items:

● latestUpdatedAt: To query all the leads updated until thespecified time.

● oldestUpdatedAt: To query all the leads updated since thespecified time.

This field is displayed when LastUpdateAtSelector isselected in the Selector Type field in the General tab.

StaticList

Selector

complex The ID or name of the static list to be queried.

This field is displayed when StaticListSelector isselected in the Selector Type field in the General tab.

lastUpdatedAt dateTime This field is deprecated.

streamPosition string The position reference to paginate through a large number ofleads. The value of the stream position is returned by the previousbatch.

batchSize integer The maximum number of leads to be queried each time.

include

Attributes

string A list of attributes of the leads to be queried.

Output for Retrieving Multiple Leads

Output Item Data Type Description

SuccessGetMultipleLeads/result

returnCount integer The number of leads that have been returned in this batch.

remaining

Count

integer The number of rest leads that have not been returned.

newStream

Position

string The new stream position for the next batch.

leadRecordList complex The attributes of the leads that have been queried.

18

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Input and Output for Lead ActivityThe Input tab and the Output tab have the following fields for retrieving lead activity.

Input for Retrieving Lead Activity

Input Item Data Type Description

ParamsGetLeadActivity

leadKey string The lead keys that are used to query the lead. The selector containsa key type and a key value.

Only some specific values are valid for this field, see theMarketo documentation for details.

activityFilter string Filters the activities for the lead identified by the provided leadkeys . The filter contains the following two items:

● includeAttributes: Lists the activity types to be returned only.

● excludeAttributes: Lists the activity types not to be returned.

● The includeAttributes and excludeAttributesitems cannot be specified within a query.

● If no values are given to this filter, it indicates that allthe activity types will be returned.

startPosition complex Paginates through a large number of returned activity types. All thevalues in this field are returned by the previous batch. It containsthe following items:

● latestCreatedAt

● oldestCreatedAt

● ActivityCreatedAt

● offset

batchSize integer The maximum number of leads to be queried each time.

Output for Retrieving Lead Activity

Output Item Data Type Description

SuccessGetLeadActivity

returnCount integer The number of activity types that have been returned in this batch.

remaining

Count

integer The number of activity types that have not been returned.

19

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Output Item Data Type Description

newStart

Position

string The new start position for the next batch.

activityRecord

List

N/A The activity types of the identified lead supposed to be returned.

Input and Output for Lead ChangesThe Input tab and the Output tab have the following fields for retrieving lead changes.

Input for Retrieving Lead Changes

Input Item Data Type Description

ParamsGetLeadChanges

startPosition complex Paginates through a large number of returned activity types. Allthe values in this field are returned by the previous batch. Itcontains the following items:

● latestCreatedAt

● oldestCreatedAt

● ActivityCreatedAt

● offset

activityFilter string This field is deprecated.

activityName

Filter

string The activities that the activity filters specified.

batchSize integer The maximum number of leads to be queried each time.

LeadKey

Selector

string The lead keys used to query multiple leads. The selector containskey types and key values.

● This field is displayed when LeadKeySelector isselected in the Selector Type field in the Generaltab.

● Only some specific values are valid for this field, seethe Marketo documentation for details.

20

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Input Item Data Type Description

LastUpdateAt

Selector

dateTime The timestamp to specify the query criteria, a date range. Theselector contains the following two items:

● latestUpdatedAt: Queries all the leads updated until thespecified time.

● oldestUpdatedAt: Queries all the leads updated since thespecified time.

This field is displayed when LastUpdateAtSelector isselected in the Selector Type field in the General tab.

StaticList

Selector

complex The ID of the static list to be queried.

This field is displayed when StaticListSelector isselected in the Selector Type field in the General tab.

Output for Retrieving Lead Changes

Output Item Data Type Description

SuccessGetLeadChanges

returnCount integer The number of activity types that have been returned in this batch.

remainingCount integer The number of activity types that have not been returned.

newStart

Position

string The new start position for the next batch.

activityRecord

List

complex The changes of the identified leads supposed to be returned.

Input and Output for CampaignThe Input tab and the Output tab have the following fields for retrieving Campaign.

Input for Retrieving Campaign

Input Item Data Type Description

ParamsGetCampaignsForSource

source string The source that categorized the campaigns. The value can be MKTOWSor SALES. The latter provides a list of campaigns available to salesinsight.

name string The name of the campaigns to be retrieved.

exactName string Indicates if the retrieved campaigns must have an exact match for thespecified name.

21

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Output for Retrieving Campaign

Output Item Data Type Description

SuccessGetCampaignsForSource/result

returnCount integer The number of campaigns that have been retrieved.

campaign

RecordList

complex The information of the retrieved campaigns. It contains the id, name,and description items.

Input and Output for MObjectsThe Input tab and the Output tab have the following fields for retrieving MObjects.

Input for Retrieving MObjects

Input Item Data Type Description

ParamsGetMObjects

type string The object type to be retrieved, Opportunity,OpportunityPersonRole or Program.

id integer The ID of the MObject to be retrieved .

externalKey string The external key of the MObject. An external key is associatedwith a name and a value.

mObjCriteria

List

dateTime The attribute filters.

Only some specific values are valid for this field, seethe Marketo documentation for details.

mObjAssociation

List

dateTime The associated object filters.

includeDetails string Indicates whether to return all the attributes for the retrievedMObjects. This item is only applicable for Program MObjects.

streamPosition string The position reference to paginate through a large number ofleads. The value of the stream position is returned by theprevious batch.

Output for Retrieving MObjects

Output Item Data Type Description

SuccessGetMObjects/result

resultCount integer The number of MObjects have been returned in this batch.

hasMore boolean Whether more MObjects have been retrieved or not.

22

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Output Item Data Type Description

newStream

Position

string The new stream position for next batch.

mObjectList complex The information of the retrieved MObjects.

Input and Output for ImportStatusThe Input tab and the Output tab have the following fields for retrieving import status.

Input for Retrieving ImportStatus

Input Item Data Type Description

ParamsGetImportToListStatus

programName string The name of the program containing the static list.

listName string The name of the static list to retrieve import status for.

Output for Retrieving ImportStatus

Output Item Data Type Description

SuccessGetImportToList/result

status string The status of the import operation.

startedTime dateTime The start time of the import operation. The returned value can benull.

endedTime dateTime The ended time of the import operation. The returned value canbe null.

estimatedTime integer The elapsed time of the import operation. The returned value canbe null.

estimatedRows integer The number of rows supposed to be imported during theoperation. The returned value can be null.

rowsImported integer The number of rows imported during the operation. The returnedvalue can be null.

rowsFailed integer The number of rows that failed to be imported during theoperation. The returned value can be null.

rowsIgnored integer The number of rows ignored during the operation. The returnedvalue can be null.

import

Summary

string The summary of the import operation. The returned value can benull.

23

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

UpsertThe Upsert activity is used to insert and update leads and MObjects. It also allows to request andschedule campaigns.

General

The General tab has the following fields.

FieldModuleProperty? Description

Name No Specify the name for the activity.

Connection Yes Click to select a Marketo shared resource.

If no matching Marketo shared resources are found, click CreateShared Resource to create one. See Creating a Marketo Connectionfor more details.

Time Out Yes Specify the amount of time in milliseconds to wait for executing theupsert operation.

The value in this field must be in the range 0 to 2147483647. A valueof 0 or negative indicates the default value, 10000 milliseconds.

Objects No Specify the type of objects to be upserted.

CheckInterval

Yes Specify the interval time that checks the status of the upsertoperation.

This field is displayed when ScheduleCampaign isselected in the Objects field.

Description

Provide a short description for the activity.

Input and Output

The input and ouput of the activity varies depending on the object type specified in the General tab.

● Input and Output for Upserting Leads● Input and Output for Upserting Multiple Leads● Input and Output for Upserting Merge Leads● Input and Output for Upserting Request Campaign● Input and Output for Upserting Schedule Campaign● Input and Output for Upserting Merge Leads

Fault

The Fault tab lists the exceptions that can be thrown by this activity.

24

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Exception Description

MarketoException The errors returned by Marketo.

MarketoPluginException The errors returned by the plug-in.

MarketoConnection

Exception

The errors that occurred when establishing the web serviceconnection between the plug-in and Marketo.

Input and Output for LeadsThe Input tab and the Output tab have the following fields for upserting leads.

Input for Upserting Leads

Input Item Data Type Description

ParamsSyncLead

leadRecord complex The keys to identify the existing lead. Each leadRecord containsthe following items:

● Id: The Marketo ID of the lead. It takes precedence over theother keys.

● Email: The email address associated with the lead.

● ForeignSysPersonId: The foreign system ID associated withthe lead.

● ForeignSysType: The type of the foreign system, CUSTOM,SFDC, or NETSUITE.

● leadAttributeList: Attributes associated with the lead.

returnLead boolean Whether to return the complete updated lead, true or false.

marketoCookie string The Munchkin java script cookie.

Output for Upserting Leads

Output Item Data Type Description

SuccessSynLead/result

leadId integer The Marketo ID of the updated or created lead.

25

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Output Item Data Type Description

syncStatus complex The status of the upsert operation.

● leadId: The Marketo ID of the updated or created lead.

● status: The status of the lead.

● error: Whether an error has occurred during the operation.The returned value can be null.

leadRecord string Attributes associated with the lead.

The email address of the lead is returned in the EMAIL fieldrather than the Email field in leadAttributeList.

Input and Output for Multiple LeadsThe Input tab and the Output tab have the following fields for upserting multiple leads.

Input for Upserting Multiple Leads

Input Item Data Type Description

ParamsSyncMultipleLead

leadRecordList complex The keys to identify the existing leads. Each leadRecord containsthe following items:

● Id: The Marketo ID of the lead. It takes precedence over otherkeys.

● Email: The email address associated with the lead.

● ForeignSysPersonId: The foreign system ID associated withthe lead.

● ForeignSysType: The type of the foreign system, CUSTOM,SFDC, NETSUITE.

● leadAttributeList: Attributes associated with the lead.

dedupEnabled boolean Whether to create duplicates in Marketo. A value of falseindicates to create duplicates.

Output for Upserting Multiple Leads

Output Item Data Type Description

SuccessSynLead/result/syncStatusList/syncStatus

leadId integer The Marketo ID of the updated or created lead.

status string The status of the lead.

26

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Output Item Data Type Description

error string Whether an error occurred during the operation. The returnedvalue can be null.

Input and Output for MObjectsThe Input tab and the Output tab have the following fields for Upserting MObjects.

Input for Upserting MObjects

Input Item Data Type Description

ParamsSyncMObjects/mObjectList/mObject

type string The type of the MObject.

Only some specific values are valid for this field, see theMarketo documentation for details.

id integer The ID of the MObject.

externalKey string The external key of the MObject. An external key is associated with aname and a value.

createdAt dateTime The date and time when the MObject was created.

updatedAt dateTime The date and time when the MObject was updated.

attribList string A list of attributes that identify the MObject to be upserted. Anattribute is associated with a name and a value.

Only some specific values are valid for this field, see theMarketo documentation for details.

typeAttrib

List

string A list of type attributes that identify the MObject to be upserted. Anattribute is associated with a name and a value.

Only some specific values are valid for this field, see theMarketo documentation for details.

association

List

complex A list of associated MObjects. Each mObjAssociation for anassociated MObject includes the following items:

● mObjType: The type of the associated MObject.

● id: The ID of the associated MObject.

● externalKey: The external key of the associated MObject. Anexternal key is associated with a name and a value.

operation string The operation to be executed, INSERT, UPDATE, or UPSERT.

27

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Output for Upserting MObjects

Output Item Data Type Description

SuccessSyncMObjects/result/mObjStatusList/mObjStatus

id integer The ID of the MObject that has been upserted.

externalKey string The external key of the MObject. An external key is associated with aname and a value.

status string The result of the upsert operation, DELETED, UNCHAGED, or FAILED.

error string Error messages.

Input and Output for Request CampaignThe Input tab and the Output tab have the following fields for upserting request campaign.

Input for Upserting Request Campaign

Input Item Data Type Description

ParamsRequestCampaign

source string The campaign source.

campaignId integer The ID of the campaign.

leadList string A list of lead keys. Each leadKey contains the following fields:

● keyType: The attributes used to query the lead.

● keyValue: The value of the attribute.

Only some specific values are valid for this field, seethe Marketo documentation for details.

programName string The name of the program.

campaignName string The name of the campaign.

programToken

List

string A list of tokens to be used in the campaign. Each attribute isassociated with a name and a value.

Output for Upserting Request Campaign

Output item Data Type Description

SuccessRequestCampaign/result

success boolean Whether the operation is successful.

28

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Input and Output for Schedule CampaignThe Input tab and the Output tab have the following fields for upserting schedule campaign.

Input for Upserting Schedule Campaign

Input Item Data Type Description

ParamsRequestCampaign

leadList string A list of lead keys.

ParamsScheduleCampaign

programName string The name of the program that contains the campaign.

campaignName string The name of the campaign.

campaignRunAt dateTime The time when to run the scheduled campaign.

programToken

List

string The value of the associated token name.

Output for Upserting Schedule Campaign

Output Item Data Type Description

SuccessScheduleCampaign/result

success boolean Whether the operation is successful.

Input and Output for Merge LeadsThe Input tab and the Output tab have the following fields for upserting merge leads.

Input for Upserting Merge Leads

Input Item Data Type Description

ParamsMergeLeads

The winningLeadKeyList and losingLeadKeyList can contain only one attribute. Thevalue of attribute name can be IDNUM, EMAIL, and SFDCLEADID.

winningLeadKey

List

string An attribute used to identify the winning lead. The attribute isassociated with a name, a type, and a value.

Only some specific values are valid for this field, seethe Marketo documentation for details.

losingLeadKey

List

string An attribute used to identify the losing leads. The attribute isassociated with a name, a type, and a value.

29

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Output for Upserting Merge Leads

Output Item Data Type Description

SuccessMergeLeads/result/mergeStatus

winningLeadId integer The ID of the winning lead. The returned value can be null.

losingLeadIdList integer The ID of the losing leads. The returned value can be null.

status string The status of the operation.

error string The error message. The returned value can be null.

30

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Sample Project

Working through the sample project helps you understand how TIBCO ActiveMatrix BusinessWorksPlug-in for Marketo works.

TIBCO ActiveMatrix BusinessWorks Plug-in for Marketo packages one sample project, which containstwo sample processes and one tool process, located in the TIBCO_HOME\bw6\bw\palettes\marketo\6.0\samples directory:

● The MObjectOperation sample process shows how to use TIBCO ActiveMatrix BusinessWorks Plug-in for Marketo to upsert, retrieve, and delete MObject. See Working with MObjectOperationProcess.

● The ScheduleCampaignOperation sample process shows how to use TIBCO ActiveMatrixBusinessWorks Plug-in for Marketo to import leads to a static list, update leads, and run acampaign. See Working with ScheduleCampaignOperation Process.

● The RemoveTestData tool process is used to delete the lead imported by theScheduleCampaignOperation process. See Working with RemoveTestData Process.

Importing Sample ProjectOnly one sample project is packaged with the plug-in. Before running the project, you need to importthe project to TIBCO Business Studio.

Procedure

1. Navigate to the TIBCO_HOME\bw\palettes\marketo\6.0\samples\GeneralSample directory andunzip the MarketoSample.zip file to the directory.

2. Start TIBCO Business Studio.

3. Click File > Import.

4. In the Import dialog, expand the General folder and select Existing Studio Projects intoWorkspace. Click Next.

5. Click Browse next to the Select root directory field to locate the samples. Click Finish.

Result

The sample project is imported to TIBCO Business Studio.

31

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Configuring Shared Resource in the Sample ProjectYou need to configure the shared resource in the sample project with the SOAP API information ofyour Marketo account.

Prerequisites

Before configuring the shared resource, you need to import the sample project to TIBCO BusinessStudio. See Importing Sample Project.

Procedure

1. Expand MarketoSample > Resources > marketosample and double-clickNewMarketoResource.marketoResource.

2. Configure the shared resouce.See Marketo Connection for more information.

Configuring in MarketoYou need to create some objects in Marketo with your Marketo account.

Procedure

1. Log in to Marketo with your account.

2. Create a folder for the sample.

3. Create a program named SampleProgram in the folder.

4. Create the following objects in the SampleProgram program.

● A campaign that has a Campaign is Requested trigger with Web Service API source. Theflow of the campaign is Delete Lead.

● A campaign named SampleCampaign.

● A static list named SampleList.

Working with MObjectOperation ProcessThis sample process shows how to upsert, retrieve, and delete MObject.

Prerequisites

Before running the project, you need to import the sample project to TIBCO Business Studio andconfigure the shared resource in the sample. See Importing Sample Project and Configuring SharedResource in the Sample Project.

Procedure

1. Expand the MarketoSamples project in Project Explorer.

2. Click Processes > marketosamples > MObjectOperation.bwp.

3. Expand Module Descriptors and double-click Components.

4. Ensure only the marketosamples.MObjectOperation component is selected in the ComponentConfigurations area.

5. Click Run > Run Configurations.

32

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

6. Expand BusinessWorks Application and click BWApplication.

7. Ensure only the MarketoSamples.application is selected in the Applications tab.

8. Click Run.

9. Click Terminate to stop the process.

Result

The MObject is upserted, retrieved, and deleted.

Configurations for MObjectOperation ProcessThe MObjectOperation process contains the following activities.

Activity Description

Timer Start the process at a specific time.

Upsert Upserts an Opportunity type of MObject, which is namedSampleOppty.

Retrieve Retrieves an Opportunity type of MObject that is named SampleOppty.

Delete Deletes the Opportunity type of MObject retrieved by the Retrieveactivity.

Working with ScheduleCampaignOperation ProcessThis sample process shows how to import leads to a static list, update leads, and run a campaign.

Prerequisites

Before running the project, you need to complete the following tasks:

● Importing Sample Project● Configuring Shared Resource in the Sample Project● Configuring in Marketo

33

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Procedure

1. Expand the MarketoSample project in Project Explorer.

2. Click Processes > marketosample > MObjectOperation.bwp.

3. Expand Module Descriptors and double-click Components.

4. Ensure only the marketosample.ScheduleCampaignOperation component is selected in theComponent Configurations area.

5. Click Run > Run Configurations.

6. Expand BusinessWorks Application and click BWApplication.

7. Ensure only the MarketoSamples.application is selected in the Applications tab.

8. Click Run.

9. Click Terminate to stop the process.

Result

Leads are imported to the SampleCampaign list and updated. The SampleCampaign campaign is set torun.

Configurations for ScheduleCampaignOperation ProcessThe ScheduleCampaignOperation process contains the following activities.

Activity Description

Timer Starts the process at a specific time.

Import Imports leads to the SampleList list in the SampleProgram program.Tokens are used in the SampleCampaign campaign.

UpdateLead Updates the imported leads .

ScheduleCampaign Runs the SampleCampaign campaign.

34

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Working with RemoveTestData ProcessThis tool process is used to delete the lead imported by the ScheduleCampaignOperation process.

Prerequisites

This process should be run after the ScheduleCampaignOperation process has been completedsuccessfully.

Procedure

1. Expand the MarketoSample project in Project Explorer.

2. Click Processes > marketotool > RemoveTestData.bwp.

3. Expand Module Descriptors and double-click Components.

4. Ensure only the marketotool.RemoveTestData component is selected in the ComponentConfigurations area.

5. Click Run > Run Configurations.

6. Expand BusinessWorks Application and click BWApplication.

7. Ensure only the MarketoSamples.application is selected in the Applications tab.

8. Click Run.

9. Click Terminate to stop the process.

Configurations for RemoveTestData ProcessThe RemoveTestData process contains the following activities.

Activity Description

Timer Starts the process at a specific time.

RequestCampaign Runs the DeleteSampleLead campaign in the SampleProgram programto delete a lead.

35

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Managing Logs

Logs are used to trace and troubleshoot exceptions.

You can configure the logback.xml file which is located in the TIBCO_HOME\bw\6.1\config\design\logback directory to manage logs:

● Managing Logs in Console.● Exporting Logs to a File.

Log LevelsThe plug-in can capture logs at different levels.

Log Level Description

Info Indicates normal plug-in operations. No action is needed. A tracing messagetagged with Info indicates that a significant processing step has been reachedand logged for tracking or auditing purposes. Only info messages preceding atracking identifier are considered as significant steps.

Warn An abnormal condition has been found. Processing will continue, but specialattention from an administrator is recommended.

Error An unrecoverable error has occurred. Depending on the error severity, theplug-in may continue with the next operation or may stop altogether.

Debug A developer-defined tracing message.

Managing Logs in ConsoleThe plug-in logs are written to Console by default.If neither the plug-in log or the BusinessWorks log is configured in the logback.xml file, the error logsof the plug-in will be displayed in Console.

If the plug-in log is not configured but the BusinessWorks log is configured in the logback.xml file, theconfiguration for BusinessWorks log is implemented by the plug-in.

Procedure

1. Navigate to the TIBCO_HOME\bw\6.1\config\design\logback directory and open thelogback.xml file.

2. Add the following node in the Console Appender area to specify the plug-in log.<logger name="com.tibco.bw.palette.marketo"> <level value="DEBUG"/></logger>

The level tag defines the log level and the value can be Error or Debug.

If you want to check the activity output in Console, you need to set level to Debug.

3. Save the file.

36

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Exporting Logs to a FileYou can export logs to a file by modifying the logback.xml file.

Procedure

1. Navigate to the TIBCO_HOME\bw\6.1\config\design\logback directory and open thelogback.xml file.

When deploying an application in TIBCO Enterprise Administrator, you need tonavigated to the TIBCO_HOME\bw\domains\mydomain\appnodes\myspace\mynodedirectory to find the logback.xml file.

2. Add the following node to specify the file location.<appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>c:/bw6-marketo.log</file> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}-%msg%n</pattern> </encoder></appender>

The file tag defines the location to which the log is to be exported and the value is the absolutepath of the file that is detailed to the file name.

3. Add the following node to the root node at the bottom of the logback.xml file to enable exportinglogs to a file. <appender-ref ref="FILE" />

<root level="DEBUG"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" /></root>

4. Save the file.

37

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Error Messages

The error messages for each shared resource and activities are listed with a corresponding descriptionand resolution.

Error Code Role Messages Resolution

TIBCO-BW-PALETTE-MARKETO-200001

debugRole Start to operate [ {0} ]. Process Id\:[ {1} ]. Engine Name\: [ {2} ].

No.

TIBCO-BW-PALETTE-MARKETO-200002

debugRole The end of the [ {0} ] activity. No.

TIBCO-BW-PALETTE-MARKETO-200003

debugRole The {0} operation is being called. No.

TIBCO-BW-PALETTE-MARKETO-200004

debugRole The {0} operation is executedsuccessfully.

No.

TIBCO-BW-PALETTE-MARKETO-200005

debugRole Current configuration for activity[ {0} ] is: {1}.

No.

TIBCO-BW-PALETTE-MARKETO-500002

errorRole There was a problem with yourrequest. Marketo returned error code.{0}

Check theconfiguration.

TIBCO-BW-PALETTE-MARKETO-500003

errorRole There was problem with inputs.Marketo returned. {0}

Check the inputs.

TIBCO-BW-PALETTE-MARKETO-500004

errorRole The connection has timed out. Pleasecheck your connection. {0}

Check the connectionbetween plug-in andMarketo.

TIBCO-BW-PALETTE-MARKETO-500005

errorRole The Marketo Shared Resource ismissing. Please add shared resourcein configuration.

Add a configuredMarketo sharedresource.

TIBCO-BW-PALETTE-MARKETO-500006

errorRole Internal Error Occured. Please checkerror details. {0}

Check error details.

TIBCO-BW-PALETTE-MARKETO-500007

errorRole The host cannot be determined.Please check your connection. {0}

Check theconfigurations inMarketo Connection.

TIBCO-BW-PALETTE-MARKETO-500008

errorRole There was a problem with servicerequest or network. Please checkerror. {0}

Check the servicerequest and network.

38

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide

Error Code Role Messages Resolution

TIBCO-BW-PALETTE-MARKETO-500009

errorRole There was problem with importactivity. Marketo returned. {0}

Check theconfiguration in theImport activity.

TIBCO-BW-PALETTE-MARKETO-500010

errorRole Problem with generating requestsignature, check Marketo connectionfields. Detailed error. {0}

Check theconfigurations inMarketo Connection.

39

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Marketo User's Guide