This technical implementation guide provides information about the reference architecture, ​guidelines, configuration steps and tests that implementation specialists need to follow while integrating Adobe Experience Manager (AEM) with Adobe Campaign.

This technical integration guide is intended for Adobe Consultants, Adobe Partners, and other experienced implementation specialists. Configuring this integration requires a full understanding of the implementation process for each individual solution covered in this guide.

Adobe customers can contact Adobe Professional Services or an Adobe Partner to learn more about this integration. 

Integration Options

The following integrations are feasible for AEM:

  1. On premise solution 
  2. Adobe hosted solution

Solution planning and Integration Architecture

With the help of the solution planning phase, the consultant should be able to create the plan for the delivery or execution approach.

​Pre-requisites

This integration requires the following:

  • A fully provisioned Adobe Experience Manager authoring instance
  • A fully provisioned Adobe Experience Manager publishing instance.
  • An Adobe Campaign instance - including a client and a server

Adobe Campaign 6.1 is compatible with Adobe Experience Manager 5.6.1, 6.0, 6.1, 6.2 and 6.3. The following sections present an overview of the integration.

For more details, refer to the documentation provided for your version of Adobe Experience Manager:

 

​​Implementation Architecture

 The below pictures illustrates high level overview of AEM to Adobe Campaign integration.

AEM & Campaign integration System setup

1
2

Installation, Provisioning and Configuration

Configure Adobe Campaign

Configuring Adobe Campaign involves the following:

  1. Installing the AEM integration package in Adobe Campaign.
  2. Configuring an external account.
  3. Verifying that the AEMResourceTypeFilter is configured correctly.

In addition, there are advanced configurations that you can make, including :

  • Managing content blocks
  • Managing personalization fields

See Advanced Configurations.

To perform these operations, you must have the administration role in Adobe Campaign.

Note:

Operations detailed in the Configuring Adobe Campaign and Configuring Adobe Experience Manager sections are necessary for the integration functionalities between AEM and Adobe Campaign to work correctly.

Installing the AEM Integration Package

You must install the AEM Integration package in Adobe Campaign. To do this:

  1. Go to the Adobe Campaign instance that you would like to link with AEM.

  2. Select Tools > Advanced > Import package....

    3
  3. Click Install a standard package, then select the AEM Integration package.

    4
  4. Click Next, and then Start.

    This package contains the aemserver operator that will be used to connect the AEM server to Adobe Campaign.

    Note:

    By default, no security zone is configured for this operator. To connect to Adobe Campaign via AEM, you must select one. In the serverConf.xml file, the allowUserPassword attribute of the selected security zone must be set to true to authorize AEM to connect Adobe Campaign via login/password. We strongly recommend creating a security zone dedicated to AEM to avoid any security problems. For more on this, refer to the Installation guide.

    5

Configuring an AEM external account

You must configure an external account that allows you to connect Adobe Campaign to your AEM instance.

When installing the AEM Integration package, an external AEM account is created. You can configure the connection to your AEM instance from it or create a new one. In AEM, be sure that you set the password for the campaign-remote user. You need to set this password to connect Adobe Campaign with AEM. Log in as administrator and in the user administration console, search for the campaign-remote user and click Set Password.

To configure an external AEM account:

  • ​​Go to the Administration > Platform > External Accounts node.

  • Create a new external account and select the AEM type.

  • Enter the access parameters for your AEM authoring instance: the server address as well as the ID and password used to connect to this instance. The campaign-api user account password is the same as the campaign-remote user that you set a password for in AEM.

Note:

Make sure that the server address does not end in a trailing slash. For example, enter http://yourserver:4502 instead of http://yourserver:4502/

6

Make sure that the Enabled checkbox is selected.

Verifying the AEMResourceTypeFilter option

The AEMResourceTypeFilter option is used to filter types of AEM resources that can be used in Adobe Campaign. This allows Adobe Campaign to retrieve AEM contents that are specifically designed to be used in Adobe Campaign only.

This option should come pre-configured; however, if you change this option, it may lead to a non-functioning integration.

To verify the AEMResourceTypeFilter option is configured:

  • Go to Platform >Options.

  • In the AEMResourceTypeFilter option, check that the paths are correct. This field must contain the value: 

    mcm/campaign/components/newsletter,mcm/campaign/components/campaign_newsletterpage,mcm/neolane/components/newsletter

    Or in some cases, the value is as follows: 

    mcm/campaign/components/newsletter

7

Configure Adobe Experience Manager

To configure AEM, you must do the following:

  • Configure replication between instances.
  • Connect AEM to Adobe Campaign via Cloud Services.
  • Configure the externalizer.

Configuring replication between AEM instances

Content created from the AEM authoring instance is first sent to the publishing instance. You need to publish so that the images in the newsletter are available on the publish instance and to newsletter recipients. The replication agent must therefore be configured to replicate from the AEM authoring instance to the AEM publishing instance.

For instructions see Replication.

Note:

If you do not want to use the replication URL but instead use the public-facing URL, you can set the Public URL in the following configuration setting in the OSGi (AEM logo Tools icon Operations > Web Console > OSGi Configuration > AEM Campaign Integration - Configuration)

Connecting AEM to Adobe Campaign

Before you can use AEM and Adobe Campaign together, you must establish the link between both solutions so that they can communicate.

See Integrating with Adobe Campaign 6.1.

​​Configuring the externalizer

You need to configure the externalizer in AEM on your author instance. The Externalizer is an OSGi service that lets you transform a resource path into an external and absolute URL. This service provides a central place to configure those external URLs and build them.

See Configure the externalizer.

For the Adobe Campaign integration, make sure you configure the publish server at http://<host>:<port>/system/console/configMgr/com.day.cq.commons.impl.ExternalizerImpl not point to localhost:4503 but to a server that is reachable by the Adobe Campaign console.

If it points to localhost:4503 or another server that Adobe Campaign cannot reach, your images will not appear on the Adobe Campaign console.

 

13

Implementation Delivery

Use case 1: Create an Experience Manager newsletter

You can use Experience Manager to build the newsletter that is used within Adobe Campaign as part of an email campaign. You build the newsletter by dragging and dropping components like other Experience Manager pages. For example, you can add an image to the newsletter by dragging and dropping the image component. To create an AEM newsletter, perform these tasks:

  1. Login into Experience Manager.

  2. Click Adobe Experience Manager in the upper left side.

  3. Click SitesCampaignsGeometrixx OutdoorsMaster AreaEmail Campaigns.

    14

    AEM Email Campaign Templates.

  4. Click the Create button.

  5. Create an Experience Manager page based on any of the Adobe Campaign templates (for example, no column, 2 columns, 3 columns).

  6. Run through wizard, name the template and click Create.

    Note:

    Adobe Campaign components are added to the page in a later step.

Assign Cloud Service information to the newsletter

To successfully create an Experience Manager/Adobe Campaign newsletter use case, add Cloud Service information to the page that you created. To add this information to the page, you use Page Properties, as shown in the following illustration.

The following shows the Cloud Services connection information (AEM Campaign) that you created earlier in this article.

15

Under the Email tab, you can enter the Subject and body information that is sent along with the Experience Manager page, as shown in the following illustration.

16

Under the Adobe Campaign tab, is the template picker where you can search for templates. It is enabled in properties in authoring. You use the template picker to select an Adobe Campaign template, which affects the set of metadata variables that are available from Adobe Campaign. There is a plain text button (you can specify both what's in plain text and what's in HTML). The metadata picker picks from the metadata that's available.

In this example, notice that the template named Email with AEM Content is selected.

17

Note:

This dropdown control is populated with templates available with Adobe Campaign. If there are no templates displayed, you need to create an Adobe Campaign template, as discussed later in this article.

Edit the Experience Manager newsletter

Compose the content of the email and use the personalization fields from Campaign:

  1. Click on “Drag components here” and wait for the “+” to appear.

    18
  2. Click on "Text & Personalization (Campaign)".

    19
  3. Click on the pencil icon.

    20
  4. Through the Adobe Campaign button you can select fields from the Profile (these will be replaced during the sending by ACS).

    21
    22

Approve the Newsletter using the AEM Campaign workflow

The email can be approved on AEM before processing. This is done via the Workflow-tab, and to select the workflow "Approve for Adobe Campaign".

23
24
  1. Click on "View in Admin".

    25
  2. Click on the bell which shows notifications. This gets you through a number of steps, whereby in the final step you need to Approve the email.

    27
    26
  3. Post the approval you can see an indicator as below.

    28

Deliver the content using Adobe Campaign

To synchronize content created in AEM with a delivery from Adobe Campaign:

  1. Create a delivery or add a delivery activity to a campaign workflow by selecting the Email delivery with AEM content (mailAEMContent) delivery template.

  2. Select Synchronize in the toolbar to access the list of contents available in AEM.

    If the Synchronize option does not appear in the delivery's toolbar, check that the Content editing mode field is correctly configured in AEM by selecting Properties > Advanced.

  3. Select the content you would like to synchronize with your delivery.

    This list specifies:

    • The label of the content in AEM.
    • The approval status of the content in AEM. If the content is not approved, you can synchronize the content but it will have to be approved before the delivery is sent. However, you can execute certain operations such as sending a BAT or the preview test.
    • The date of the last modification to the content.
    • Any content already linked to a delivery.

    By default, the content that is already synchronized with a delivery is hidden. However, you can display it and use it. For example, if you want to use content as a template for several deliveries.

  4. Specify the other parameters of your delivery (target, etc.).

  5. If necessary, start the delivery approval process in Adobe Campaign. Content approval in AEM is necessary in addition to approvals configured in Adobe Campaign (budget, target, etc.). Content approval in Adobe Campaign is only possible if the content is already approved in AEM.

  6. Execute the delivery. During the delivery analysis, the most up-to-date version of the AEM content is recovered.

    Note:

    • After the delivery and content are synchronized, the delivery content in Adobe Campaign becomes read only. The email subject as well as its content can no longer be modified.
    • If the content is updated in AEM while it is linked to a delivery in Adobe Campaign, it is automatically updated in the delivery during the delivery analysis. The synchronization can also be executed manually using the Refresh content now button.
    • You can cancel synchronization between a delivery and AEM content using the Desynchronize button. This is only available if a content is already synchronized with the delivery. To synchronize a different content with a delivery, you must cancel the current content synchronization before being able to establish a new link.
    • If desynchronized the local content is kept and becomes editable in Adobe Campaign. If you resynchronize the content after having modified it, you will lose all your changes.
    • For recurring and continuous deliveries, synchronization with AEM content is stopped every time the delivery is executed.

Use case 2: Creating Adobe Campaign Forms in AEM

​AEM lets you create and use forms that interact with Adobe Campaign on your website. Specific fields can be inserted into your forms and mapped to the Adobe Campaign database.

You can manage new contact subscriptions, unsubscriptions, and user profile data, all while integrating their data into your Adobe Campaign database.

To use Adobe Campaign forms in AEM, you need to follow these steps, described in this document:

  1. Make a template available.
  2. Create a form.
  3. Edit form content.

Three types of forms, specific to Adobe Campaign, are available by default:

  • Save a profile
  • Subscribe to a service
  • Unsubscribe from a service

These forms define a URL parameter that accepts the encrypted primary key of an Adobe Campaign profile. Based on this URL parameter, the form updates the data of the associated Adobe Campaign profile.

Although you create these forms independently, in a typical use case, you generate a personalized link to a form page inside the newsletter content, so that recipients can open the link and make adjustments to their profile data (whether unsubscribing, subscribing, or updating their profile).

The form automatically updates based on the user.

Making a Template Available

Before being able to create forms that are specific to Adobe Campaign, you must make the different templates available in your AEM application.

To do this, see the product documentation for Templates documentation.

Creating a Form

First of all, check the connection between the author and publish instances and Adobe Campaign is working.

Make sure the acMapping property on the page's jcr:content node is set to mapRecipient or profile when using Adobe Campaign 6.1.x or Adobe Campaign Standard, respectively

You can create forms in both the classic and touch-optimized UI.

To create a form in the touch-optimized UI:​

  1. In AEM, in Sites​​, navigate to where you want to create a new page.

  2. Create a page and select Adobe Campaign Profile (AC 6.1) and click Next.

    29
  3. In the Name field, add the name of the page. It must be a valid JCR name.

  4. In the Title field, enter a title and click Create.

  5. Open the page and select Open Properties and in Cloud Services add the Adobe Campaign configuration and select the checkmark to save your changes.

    30

    On the page, in the Form Start component, select the type of form it is - Subscribe, Unsubscribe, or Save Profile. You can only have one type per form. You can now edit the form's content.

To create a form in the classic UI:

  1. In Adobe Experience Manager, in Sites, if necessary, switch to Classic UI mode.

    31
  2. Scroll through the tree structure to get to the place you would like to create the form in your chosen website.

  3. Select New > New page....

  4. Select either Adobe Campaign Profile (AC 6.1) or Adobe Campaign Profile (ACS) template and enter the page properties.

  5. Click Create to create the form.

    32

    You can then edit and configure your form's content.

Editing Form Content

Forms dedicated to Adobe Campaign have specific components. These components have an option to allow you to link each field of the form to a field in the Adobe Campaign database.

Editing Form Content in the Touch-optimized UI:

  1. Select Open Properties and in Cloud Services add the Adobe Campaign configuration and select the checkmark to save your changes.

    33
    34
  2. On the page, in the Form Start component, click the Configuration icon.

  3. Click the Advanced tab and select the type of form it is - Subscribe, Unsubscribe, or Save Profile and click OK. You can only have one type per form.

    • Adobe Campaign: Save profile: lets you create or update a recipient in Adobe Campaign (default value).
    • Adobe Campaign: Subscribe to Services: lets you manage the subscriptions of a recipient in Adobe Campaign.
    • Adobe Campaign: Unsubscribe from Services: lets you cancel the subscriptions of a recipient in Adobe Campaign. 
  4. You must have an Encrypted Primary Key component on each form. This component defines which URL parameter will be used to accept the encrypted primary key of an Adobe Campaign profile. In Components, select Adobe Campaign so only those components are visible. 

  5. Drag the component Encrypted Primary Key to the form (anywhere) and click or tap the Configuration icon. In the Adobe Campaign tab, specify any name for the URL parameter. Click or tap the check mark to save your changes. Generated links to this form need to use this URL parameter and assign it the encrypted primary key of an Adobe Campaign profile. The encrypted primary key must be properly URL (percent) encoded.

    35
  6. Add components to the form as needed, such as a Text field, Date field, Checkbox field, Option field, and so on.

  7. Click the Configuration icon to open the component. For example, in Text Field (Campaign) component, change the title and text. 

  8. Click Adobe Campaign to map the form field to an Adobe Campaign metadata variable. When you submit the form, the mapped field is updated in Adobe Campaign. Only fields with matching types are available in the variable picker (for example, string variables for text fields). 

    36

    You can add/remove fields that are displayed in the recipient table by following the instructions here: http://blogs.adobe.com/experiencedelivers/experience-management/aem-campaign-integration/ 

  9. Click Publish Page. The page is activated on your site. You can view it by going to your AEM publication instance. You can also test a form.

    You need to provide read permissions to the anonymous user on the cloud service to use forms on publish. However, be aware of the potential security issues with providing read permissions to the anonymous user and be sure to mitigate it by, for example, configuring the dispatcher.

Editing Form Content in the Classic UI

To edit form content in the classic UI:

  1. Navigate to the form you want to edit.

  2. In the toolbox, select Page > Page Properties... then go to the Cloud Services tab of the pop-up window.

  3. Add the Adobe Campaign service by clicking Add service, and then selecting the configuration that corresponds to your Adobe Campaign instance in the service's drop down list. This configuration is carried out when setting up the connection between your instances.
    If necessary, unlock the configuration by clicking the padlock icon to be able to add the Adobe Campaign service.

    37
  4. Access the form's general parameters using the Edit button found at the start of the form. The Form tab allows you to select a thank you page to which the user will be redirected after having validated the form.

    The Advanced form allows you to select the type of form. The Post Options field gives you the choice between three types of Adobe Campaign forms:

    • Adobe Campaign: Save profile: lets you create or update a recipient in Adobe Campaign (default value).
    • Adobe Campaign: Subscribe to Services: lets you manage the subscriptions of a recipient in Adobe Campaign.
    • Adobe Campaign: Unsubscribe from Services: lets you cancel the subscriptions of a recipient in Adobe Campaign.

    The Action Configuration field lets you specify whether or not you would like to create the recipient profile in the Adobe Campaign database if it does not yet exist. To do this, check the Create user if not existing option.

  5. Add your selected components by dragging them from the toolbox and dropping them into the form.

    38
  6. Configure the added fields by double clicking them. The Adobe Campaign tab lets you link the field to a field in the Adobe Campaign recipient table. You can also specify whether the field is part of the reconciliation key which allows recipients that are already present in the Adobe Campaign database to be recognized.

    The Element Name must be different for each form field. Change it if necessary.

    Each form must contain an Encrypted Primary Key component in order to correctly manage recipients in the Adobe Campaign database.

  7. Activate the page by selecting Page > Activate Page in the toolbox. The page is activated on your site. You can view it by going to your AEM publication instance. The data in the Adobe Campaign database is updated once a form is validated.

Testing a Form

After you create a form and edit form content, you may want to manually test that the form is working as expected.

You must have an Encrypted Primary Key component on each form. In Components, select Adobe Campaign so only those componente are visible. 

Although in this procedure you enter the epk number manually, in practice, users would get a link to this page (whether to unsubscribe, subscribe, or update your profile) within a newsletter. Based on the user, the epk automatically updates.

To create that link, you use the variable Main resource identifier (Adobe Campaign Standard) or Encrypted identifier (Adobe Campaign 6.1) (for example, in a Text & Personalization (Campaign) component), which links to the epk in Adobe Campaign.

To do this, you need to manually get the EPK of an Adobe Campaign profile and then append it to the URL:

  1. To get the encrypted primarly key (EPK) of an Adobe Campaign profile

    - In Adobe Campaign Standard - Navigate to Profiles and Audiences > Profiles, which lists the existing profiles. Make sure the table displays the Main Resource Identifier field in a column (This can be configured by clicking/tapping Configure list). Copy the main resource identifier of the desired profile.
    - In Adobe Campaign 6.11, go to Profiles and Targets Recipients, which lists the existing profiles. Make sure the table displays the Encrypted identifier field in a column (This can be configured by right-clicking on an entry and selecting Configure list...). Copy the encrypted identifier of the desired profile.
  2. In AEM, open the form page on the publish instance and append the EPK from step 1 as a URL parameter: use the same name that you previously defined in the EPK component when authoring the form (for example: ?epk=...)
  3. The form can now be used to modi​fy the data and subscriptions associated to the linked Adobe Campaign profile. After you modify some fields and submit the form, you can verify inside Adobe Campaign that the appropriate data has been updated.

The data in the Adobe Campaign database is updated once a form is validated.

Email Marketing

Integration with Assets Core Service

When editing an email delivery or a landing page, you can insert images from your Adobe Marketing Cloud (Assets core service or Assets On Demand) or Adobe Experience Manager libraries​. Details on the integration can be found here: A​ssets core service​

Troubleshooting​

FAQs

Useful links/ Documents​

Best Practices

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy