Setting up the Connector for Marketo

The setup process for the Connector for Marketo includes adding the connector itself to your Tridion Sites implementation as well as a few additional steps to enable the integration.

Before you begin

Before beginning the connector setup process, be sure you have the following:

  • An account with Adobe Marketo Engage
  • Connector Add-on package has been provided by SDL Customer Support.
  • SDL Tridion Sites 9.5 or later, is installed and fully operational .
  • The Multichannel Delivery extension (multi-channel-delivery-deployer-extension) for the Tridion Integration Framework is installed to the Content Deployer.
  • The PCA extension (connector-framework-pca-extension) is installed to the Content Service.
  • The .NET Runtime version 3.1 is installed on the host machine of the Content Service and on all Content Manager server machines where the connector will be used. Download the .NET Core Runtime for either Windows or Linux from the following location: https://dotnet.microsoft.com/download/dotnet-core/3.1

About this task

This topic describes the general process for setting up the Connector for Marketo. For details on certain individual steps, refer to the linked topics.

Procedure

  1. In the Adobe Marketo Engage user interface, set up OAuth authorization for Marketo.
    1. Get the REST API endpoint for your Marketo instance from Marketo's administration module.
    2. Set up an API user and note the client ID and client secret. For details, refer to the Marketo documentation. They will be needed in a subsequent step for configuring the connector.
  2. In Content Manager Explorer, define one or more Publications for publishing to each external channel. We recommend that you use a dedicated publication for each channel, similar to how you might create dedicated Publications for different websites.
    1. Create a new Publication and make sure you inherit from an existing Publication in the Blueprint structure.
    2. If no business process types are inherited from the parent Publication, set up a new one now for the new Publication. Make sure your topology is configured accordingly.
    3. In the Publication's properties, set up publishing by selecting a business process type and path mapping for the type. (The path mapping is not used, so it can be set to any value)
  3. For each Publication that you defined for the external channel, configure the Schemas and Multimedia Schemas for templateless, data-only publishing (of "headless" publishing):
    1. For each Schema that will be used in publishing content to the external channel, ensure that the following options are selected on the Schema's General tab:
      • Enable each Schema field to be made publishable when authors publish an item based on this Schema
      • Enable each Schema field to be made searchable for website visitors
    2. On the Schema's Design tab, ensure that the following options are selected for individual fields to be published:
      • Publish this field when you publish an item that uses this Schema
      • Make this field searchable for website visitors
    3. For each Multimedia Schema you want to use for publishing images to the external system, select the same two options on the General tab as you did for the Schemas.
  4. If you will be using images links in your Components, go to Administration > Link Resolver Settings increase the value for the Link Resolver Recursion Depth to something greater than zero.
  5. In each Publication where you want to expose the Marketo content in Content Manager, prepare one or more stub Folders as follows:
    1. Under the Building Blocks node, create a new Folder to contain the stub items for the external system.
    2. Click Save, but keep it open for now.
    3. Go to the Info tab and note the value of the Item URI field, such as tcm:1-10-512. You will need to add this information to your connector's configuration.
    4. Click Save and Close.
    Repeat these steps for additional stub Folders, as needed.
  6. Using the Add-ons feature, upload the Connector for Marketo's ZIP package.
  7. Create a JSON configuration that includes appropriate settings for this connector and your environment.
    To support multichannel delivery, this connector's configuration file defines two connector deployments:
    • MarketoConnector — defines the connector for Content Manager environment, including all user interfaces
    • MarketoDeployConnector — defines the connector for all Content Delivery
    For descriptions of all properties, refer to the related topic on connector configuration properties.
  8. Upload the connector's JSON configuration file to the Add-ons Service.
  9. To complete and verify the connector setup for Content Manager, go to the user interface and select the Refresh option (or F5).
    In Content Manager Explorer, the connector should appear as a new External Content Library (ECL) mount point, as in the following example:
  10. Create, package and upload deployer templates. At a high level, this includes the following steps:
    1. Create an HTML deployer template for each Tridion Sites Schema or Content Type.
    2. Package the templates into one or more folders.
    3. Create a template manifest.
    4. Package the folder structure and manifest into a ZIP file with the manifest in the root folder.
    5. Create a JSON configuration file for each template to connect all dots.
    For more information, refer to the related topic on multichannel delivery templates.
  11. To complete and verify the connector setup for Content Delivery, do the following:
    1. Restart the Content Service.
      The Content Service should automatically pick up the connector package and configuration and deploy the connector. To verify the setup, open the GraphQL console at [Content Service URL]/cd/api/graphiql and verify the presence of appropriate GraphQL types for this connector.
    2. Restart the Content Deployer.
      The Content Deployer should automatically pick up the connector package and configuration and deploy the connector.