Marketo Connector

The Marketo connector enables synchronization between IDM managed users and a Marketo leads database.

This connector forms part of ForgeRock's support for customer data management (CDM). You can synchronize any managed user to Marketo—those who have been added directly to the IDM repository, and those who have registered themselves through one of the Social Identity Providers described in Social Registration.

The Marketo connector is an implementation of the Scripted Groovy Connector Toolkit, and enables you to interact with leads in a Marketo database, using Groovy scripts for the ICF operations.

To use the Marketo connector, you need the following:

To obtain these details from Marketo, see the Marketo documentation.

A sample connector configuration file is available, at /path/to/openidm/samples/example-configurations/provisioners/provisioner.openicf-marketo.json. To test the Marketo connector, copy that file to your project's conf/ directory, and edit at least the configurationProperties to provide the REST API URL, client ID and client secret.

Set the enabled property in the connector configuration to true. IDM encrypts the client secret on startup. Optionally, you can specify the listName to which leads should be added when they are synchronized from IDM. The following excerpt from the sample connector configuration file shows the properties that you must set:

{
    "displayName" : "MarketoConnector",
    "description" : "Connector used to sync users to Marketo leads",
    "author" : "ForgeRock",
    "enabled" : true,
    "connectorRef" : {
        "bundleName" : "org.forgerock.openicf.connectors.marketo-connector",
        "bundleVersion" : "1.5.3.0",
        "connectorName" : "org.forgerock.openicf.connectors.marketo.MarketoConnector"
    },
    ...
    "configurationProperties" : {
        "instance" : "<INSTANCE_FQDN>",
        "clientId" : "<CLIENT_ID>",
        "clientSecret" : "<CLIENT_SECRET>",
        "leadFields" : null,
        "partitionName" : null,
        "listName" : "<LEAD_LIST_NAME>",
        ...
    },
    ...
}

You can also configure the Marketo connector through the Admin UI. Select Configure > Connectors > New Connector and select Marketo Connector - 1.5.20.11 as the Connector Type. Configuration properties correspond to those described in the previous list. For details of all the configuration properties, see "Marketo Connector Configuration".

When your connector is configured correctly, you can test its status by running the following command:

curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--request POST \
"http://localhost:8080/openidm/system?_action=test"
[
  {
    "name": "marketo",
    "enabled": true,
    "config": "config/provisioner.openicf/marketo",
    "objectTypes": [
      "__ALL__",
      "account"
    ],
    "connectorRef": {
      "bundleName": "org.forgerock.openicf.connectors.marketo-connector",
      "connectorName": "org.forgerock.openicf.connectors.marketo.MarketoConnector",
      "bundleVersion": "1.5.20.11"
    },
    "displayName": "Marketo Connector",
    "ok": true
  }
]

A status of "ok": true indicates that the connector can reach your Marketo database.

"validSource" : {
    "type" : "text/javascript",
    "globals" : {
        "preferences" : [
            "marketing"
        ]
    },
    "file" : "ui/preferenceCheck.js"
}

Marketo Connector Configuration

The Marketo Connector has the following configurable properties.

Configuration properties

Property	Type	Default	Encrypted [a]	Required [b]
customSensitiveConfiguration	GuardedString	null
Custom Sensitive Configuration script for Groovy ConfigSlurper
customConfiguration	String	null
Custom Configuration script for Groovy ConfigSlurper
instance	String	null
The Marketo-assigned FQDN for your instance
clientId	String	null
Your OAuth2 client ID
clientSecret	GuardedString	null
Your OAuth2 client secret
leadFields	String	null
Comma-delimited list of lead fields to fetch; Leave empty for default set
partitionName	String	null
Name of the partition in which to create and update leads; May be left empty
listName	String	null
Name of the Marketo static list the connector will use to manage leads
accessToken	String	null
The access token for the application
tokenExpiration	Long	null
The expiration token for the application
[a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations.

Operation Script Files

Property	Type	Default	Encrypted [a]	Required [b]
createScriptFileName	String	CreateMarketo.groovy		Create
The name of the file used to perform the CREATE operation.
customizerScriptFileName	String	null
The script used to customize some function of the connector. Read the documentation for more details.
authenticateScriptFileName	String	null		Authenticate
The name of the file used to perform the AUTHENTICATE operation.
scriptOnResourceScriptFileName	String	null		Script On Resource
The name of the file used to perform the RUNSCRIPTONRESOURCE operation.
deleteScriptFileName	String	DeleteMarketo.groovy		Delete
The name of the file used to perform the DELETE operation.
resolveUsernameScriptFileName	String	null		Resolve Username
The name of the file used to perform the RESOLVE_USERNAME operation.
searchScriptFileName	String	SearchMarketo.groovy		Get Search
The name of the file used to perform the SEARCH operation.
updateScriptFileName	String	UpdateMarketo.groovy		Update
The name of the file used to perform the UPDATE operation.
schemaScriptFileName	String	SchemaMarketo.groovy		Schema
The name of the file used to perform the SCHEMA operation.
testScriptFileName	String	TestMarketo.groovy		Test
The name of the file used to perform the TEST operation.
syncScriptFileName	String	null		Sync
The name of the file used to perform the SYNC operation.
[a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations.

Groovy Engine configuration

Property	Type	Default	Encrypted [a]	Required [b]
targetDirectory	File	null
Directory into which to write classes.
warningLevel	int	1
Warning Level of the compiler
scriptExtensions	String[]	['groovy']
Gets the extensions used to find groovy files
minimumRecompilationInterval	int	100
Sets the minimum of time after a script can be recompiled.
scriptBaseClass	String	null
Base class name for scripts (must derive from Script)
scriptRoots	String[]	null
The root folder to load the scripts from. If the value is null or empty the classpath value is used.
tolerance	int	10
The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted.
debug	boolean	false
If true, debugging code should be activated
classpath	String[]	[]
Classpath for use during compilation.
disabledGlobalASTTransformations	String[]	null
Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled.
verbose	boolean	false
If true, the compiler should produce action information
sourceEncoding	String	UTF-8
Encoding for source files
recompileGroovySource	boolean	false
If set to true recompilation is enabled
[a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations.