TIBCO Scribe® Connector For Marketo SOAP
Use the TIBCO Scribe® Connector for Marketo SOAP to replicate data for outside analysis or to integrate lead data into Marketo ® and begin marketing activities.
Refer to TIBCO Scribe® Online Connectors For Marketo for information on when to use the Marketo SOAP Connector and when to use the Marketo Connector.
Connector Specifications
This Connector supports Marketo SOAP API version 3.1.
Supported | |
---|---|
Agent Types |
|
On Premise | X |
Cloud | X |
Replication Services |
|
Source | X |
Target | |
Integration Services |
|
Source | X |
Target | X |
Migration Services |
|
Source | X |
Target | X |
Maps |
|
Integration | X |
Request-Reply | X |
Message |
Note: This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.
Supported Entities
TIBCO Scribe® Online currently supports the following entities and operations for the Marketo SOAP Connector. Select a linked entity name for additional information on using that entity with TIBCO Scribe® Online. For a list of additional operations by entity see Special Operations.
Standard Operations
Entity | Query | Create |
Update | Delete | Upsert |
---|---|---|---|---|---|
X |
|
|
|
|
|
X |
|
|
|
|
|
X |
|
|
|
X |
|
|
|
|
|
|
|
X |
X |
X |
X |
X |
|
X |
X |
X |
X |
X |
The list of ActivityTypes varies based on your Marketo configuration. TIBCO Scribe® Online displays any ActivityType available via the Marketo SOAP API. If you do not see an ActivityType, refresh metadata for the Connection.
Special Operations
Entity | Operations |
---|---|
List |
-Add -Remove |
Setup Considerations
Marketo Spark Edition is not supported.
The complete URL for the SOAP API Connection to Marketo is required.
Note: Find the credentials for your TIBCO Scribe® Online Connector for Marketo on the Marketo Web Services page:
- Select Admin from the Marketo toolbar.
- In the left-hand pane, select Web Services from the Integration section of the Admin tree.
Selecting An Agent Type For Marketo SOAP
Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.
Connecting To Marketo SOAP
Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.
- Select More > Connections from the menu.
- From the Connections page select Add to open the Add a New Connection dialog.
- Select the Connector from
the drop-down list in the Connection Type field, and then enter the following information for this Connection:
- Name — This can be any meaningful name, up to 25 characters.
- Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
- Marketo URL— The complete URL (SOAP endpoint) for this account.
- User ID — The User ID associated with this Marketo SOAP Connection.
- Encryption Key — The encryption key associated with this Marketo SOAP Connection.
Note: The SOAP URL, User ID, and Encryption Key can be found in Marketo under Admin > Integration > Web Services in the SOAP API section.
- To mark deleted entities during replication, select the Deletion Tracking (RS) tab. See Deletion Tracking (RS) below for more information.
- Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
- Select OK/Save to save the Connection.
Metadata Notes
Boolean Fields
When using Marketo as a source, if a Boolean is requested but is not returned from the Marketo SOAP API, TIBCO Scribe® Online assumes that the value is false.
Querying
Use filters when querying data to reduce the total amount of data being accessed and increase overall performance.
When a datetime is configured on the Query Block on the Block Properties Net Change Tab to query for new and updated records, that configuration is treated as an additional filter. The Net Change datetime filter is applied as an AND after any other filters specified on the Block Properties Filter Tab. TIBCO Scribe® Online builds a query combining both the Net Change filter and the filters on the Filter tab. See Net Change And Filters for an example.
Some Connectors for TIBCO Scribe® Online only support one filter. For those Connectors you can use either Net Change or one filter on the Filter tab, not both.
Note: The Net Change date is ignored when previewing data on the Preview tab. Filters on the Block Properties Filters tab are used to filter the data on the Preview tab.
Marketo SOAP Connector As RS Source
Recommended Entities
In a Marketo Replication Solution, TIBCO Scribe® Online replicates the following entities when you select the Recommended Entities option. To replicate additional entities, select the All Entities option or the Selected Entities option. See Selecting Source Entities For Replication Solutions.
Recommended Marketo Entities | ||
---|---|---|
ActivityRecord |
CreateTask |
RemoveFromList |
AddToList |
DeleteLeadFromSFDC |
RemoveFromSFDCCampaign |
AddToOpportunity |
EmailBounced |
RequestCampaign |
AddToSFDCCampaign |
EmailBouncedSoft |
SalesEmailBounced |
ChangeDataValue |
EmailDelivered |
SendAlert |
ChangeLeadPartition |
FillOutForm |
SendEmail |
ChangeOwner |
InterestingMoment |
SendSalesEmail |
ChangeScore |
LeadRecord |
SFDCActivity |
ChangeSegment |
MergeLeads |
SFDCActivityUpdated |
ChangeStatusinProgression |
NewLead |
SFDCMergeLeads |
ChangeStatusInSFDCCampaign |
OpenEmail |
SyncLeadToSFDC |
ClickEmail |
OpenSalesEmail |
SyncLeadUpdatesToSFDC |
ClickLink |
Opportunity |
UnsubscribeEmail |
ClickSalesEmail |
ReceiveSalesEmail |
UpdateOpportunity |
ConvertLead |
RemoveFromFlow |
VisitWebpage |
Deletion Tracking (RS)
When configuring a Marketo SOAP Connection, you can select entities that are tracked for deletion during replication. When an entity is deleted in Marketo, the deletion is tracked and during replication the same data is marked as deleted in the target datastore.
- On the Edit Connection dialog for the Marketo SOAP Connection select the Deletion Tracking (RS) tab.
- Add a check mark in the check box next to any entity you want to track as deleted. If the list of entities is long, select the Filter icon to reduce the number of entities displayed. See Using The Filter Dialog.
- Select Test to ensure that the Agent can connect to your Marketo database.
- Select OK to save.
Marketo SOAP Connector As IS/MS Source
Net Change
When querying the Marketo API, records are not returned in order by date. If the Net Change option is enabled on the Query Block to return only new and updated records, the Marketo Connector must request all records, sort them by date, and then locate only the new and updated records. This process takes place in memory and affects Agent memory requirements. If you are using an On-Premise Agent and the server where that Agent is installed does not have enough memory, it may appear that there is a memory leak due to the volume of records being sorted.
Filtering
Only certain filtering criteria are supported for each Marketo entity. These criteria affect any filtering, including the following Block Properties tabs: Filter, Lookup Criteria, and Matching Criteria.
Depending on the Marketo entity, the following rules apply:
Entity | Field | Valid Operators | Notes |
---|---|---|---|
ActivityRecord |
activityDateTime |
is greater than, is greater than or equal to |
You can only specify one activityDateTime. You can specify a single AND operator to include one or more activityTypes. |
activityType |
equals, is not equal to |
Use OR to specify multiple activityTypes. Use the Information slider to see a list of activityTypes. |
|
activityType entities |
activityDateTime |
is greater than, is greater than or equal to |
You can only specify one activityDateTime. |
LeadRecord |
|
equals |
For Email and ID fields, you can only specify a single equals operation (And/OR are not supported). |
ID |
equals |
|
|
LastUpdatedAt |
is greater than |
Use LastUpdatedAt with is greater than to specifiy the last modified date. |
|
StaticListName |
equals |
|
|
Opportunity and OpportunityPersonRole |
All fields |
All operators except is like and is not like. |
You can specify one or more AND operations. However, OR operations are not supported. |
Note: Filtering criteria error messages do not display until you Preview source data, run Debug, or execute the Solution.
Important: Filtering on Decimal values for Opportunity is not fully supported and can generate errors.
Relationships
- Hierarchical relationships, such as grandparent, parent, grandchild relationships are not supported. See Hierarchical Data for examples.
- Parent/child relationships are only supported for the ActivityRecord entity.
- Only inner joins on Activity Types are supported. Attempting an outer join can cause a time out if a large number of records are returned. Use filters to reduce the number of records returned. See Joins.
Note: For this Connector, only one level of relationship, Parent/Child, is supported for the entity selected in the Query or Fetch Block. For records with multiple levels of relationships, such as Parent, Child, Grandchild, only the selected Parent entity and related Child entities can be retrieved. Additional levels beneath Child entities, such as Grandchildren, cannot be accessed for this Connector using the Include tab. See Block Properties Include Tab — Relational Data.
Known Limitations
- Marketo Smart Lists are not supported. However, to use your Marketo data with TIBCO Scribe® Online, you can convert a Smart List to a Static List.
- If the integration between Marketo and Salesforce has been implemented, activities generated by that integration cannot be accessed via the API and are not included in search results. These activities do display in the Marketo Activity Log and are marked as skipped. Affected activities include:
- AddtoSFDCCampaign
- ChangeStatusInSFDCCampaign
- RemoveFromSFDCCampaign
Marketo SOAP Connector As IS/MS Target
When using the Marketo SOAP Connector as a target, you may encounter the following issues:
- When associating an Opportunity with a Lead in Marketo, the Role field in the OpportunityPersonRole entity is required. The Role field is not marked as required, but if it is not mapped, an error is generated.
Note: Role can be mapped to any field or formula, including a constant, such as 3.
- If the length of a target field is shorter than the length of the source field you are trying to insert or update, Marketo truncates the field you are inserting or updating without issuing a truncation error.
- When using Marketo with Batch Processing, Marketo allows batches of up to 100 records. If you request processing in batches of 1000, TIBCO Scribe® Online creates 10 batches of 100 records each.
- If you choose only one match criterion when using a Remove operation on a List, an input error is generated, but there is no information in the message indicating that there are not enough match fields. Include additional match criteria and execute the Map again.
- If you try to Upsert data into Marketo where the source contains the Marketo Lead ID, the operation fails with the following error:
Error description: Operation failed. Label: Upsert LeadRecord, Name: LeadRecordUpsert, Message: 20103 - Lead not found
Upsert
When using an Upsert operation for a Marketo entity, you must use an ID. If you do not include an ID, a new record is created, which could result in duplicate records.
If you include an ID, and the ID does not match an existing record, the Upsert fails because Marketo needs to generate an ID for the new record being inserted. Use a Lookup operation first to determine whether or not the ID exists. If the ID exists, use an Upsert operation containing the ID to update the existing record. If the ID does not exist, use an Upsert operation with no mapped ID field to insert the new record.
If you try to Upsert data into Marketo where the source contains the Marketo Lead ID, the operation fails with the following error:
Error description: Operation failed. Label: Upsert LeadRecord, Name: LeadRecordUpsert, Message: 20103 - Lead not found
Notes On Standard Entities
ActivityRecord
- Contains fields from Marketo Activity data along with some related fields.
- You can specify multiple related entities. However, for any Query, all related entities must be either an inner or outer join.
ActivityTypes
- The list of ActivityTypes varies based on your Marketo configuration. TIBCO Scribe® Online displays any ActivityType available via the Marketo API.
- Reset the metadata for the Marketo Connection to display new ActivityType entities in TIBCO Scribe® Online.
DeleteLead
- This ActivityType cannot be accessed through the API. When you delete a lead, all associated activity is also deleted.
DeleteLeadFromSFDC
- DeleteLeadFromSFDC is the display name for DeleteLeadFromSales.
LeadRecord
- Contains fields from Marketo Lead data along with some related fields.
List
Use the List entity to add and remove Leads from Marketo Lists.
- You cannot Query on a List because the List entity is not available from the Query Block.
- LeadKeyValue is the ID of the lead you want to add to or remove from the list. If the Lead ID does not exist, a record error occurs.
- ListKeyValue field must be the name of the list you want to process. If the list name does not exist, a record error occurs.
- Use the Add Block to add Leads to an existing list.
Note: The Add Block is similar to a Create Block. See Create Block for information about configuring and using Add.
- Use the Remove Block to remove Leads from an existing list.
Note: The Remove Block is similar to a Delete Block. See Delete Block for information about configuring and using Remove.
Important: If you create a Map with a Remove Block that contains only one of the two necessary match fields, an error is generated when the Map executes. Make sure that Remove Blocks contain both LeadKeyValue and ListKeyValue.
Opportunity
- Contains Marketo Opportunity data.
OpportunityPersonRole
- Provides the relationship between an Opportunity and a Lead.
SyncLeadToSFDC
- SyncLeadToSFDC is the display name for PushLeadToSales.
SyncLeadUpdatesToSFDC
- SyncLeadUpdatesToSFDC is the display name for PushLeadUpdatesToSales.
UpdateOpportunity
- UpdateOpportunity is the display name for UpdateOpprtntyInSales.
Marketo Custom Objects
Accessing Custom Objects through TIBCO Scribe® Online is not supported.
TIBCO Scribe® Online API Considerations
To create connections with the TIBCO Scribe® Online API, the Marketo Connector requires the following information:
Connector Name |
Marketo SOAP |
Connector ID |
D48878BB-3265-41A3-B014-736DACD01E80 |
TIBCO Scribe® Online Connection Properties
In addition, this Connector uses the Connection properties shown in the following table.
Note: Connection property names are case-sensitive.
Name | Data Type | Required | Secured | Usage |
---|---|---|---|---|
Url |
String |
Yes |
No |
|
UserId |
String |
Yes |
No |
|
EncryptionKey |
String |
Yes |
Yes |
|
DeletionTrackingEntities |
String |
Yes |
No |
Enter each item on a new line delimited by tabs to track for deletion. Example: True — ActivityRecord False — LeadRecord False — Opportunity True — AddToList |
More Information
For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.