ÃÛ¶¹ÊÓƵ

DocumentationAEM 6.5User Guide

Integrating AEM 6.5 with ÃÛ¶¹ÊÓƵ Campaign Standard integrating-with-adobe-campaign-standard

Last update: Wed Apr 17 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin

By integrating AEM 6.5 with ÃÛ¶¹ÊÓƵ Campaign Standard (ACS), you can manage email delivery, content, and forms directly in AEM. Configuration steps in both ÃÛ¶¹ÊÓƵ Campaign Standard and AEM are needed to enable bidirectional communication between solutions.

This integration allows AEM and ÃÛ¶¹ÊÓƵ Campaign Standard to be used independently. Marketers can create campaigns and use targeting in ÃÛ¶¹ÊÓƵ Campaign, while content creators in parallel can work on content design in AEM. Using the integration, the content and design of the campaign created in AEM can be targeted and delivered by ÃÛ¶¹ÊÓƵ Campaign.

INFO
This document details how to integrate ÃÛ¶¹ÊÓƵ Campaign Standard with AEM 6.5. For other Campaign integrations see the document Integrating AEM 6.5 with ÃÛ¶¹ÊÓƵ Campaign.

Integration Steps integration-steps

The configuration of the integration between AEM and ÃÛ¶¹ÊÓƵ Campaign Standard requires several steps in both solutions.

  1. Configure the aemserver User in Campaign
  2. Verify the AEMResourceTypeFilter in Campaign
  3. Create an AEM-Specific Email Delivery Template in Campaign
  4. Configure the Campaign Integration in AEM
  5. Configure Replication to AEM Publish Instance
  6. Configure the AEM Externalizer
  7. Configure the campaign-remote User in AEM
  8. Configure the AEM External Account in Campaign

This document leads you through each of these steps in detail.

Prerequisites prerequisites

Configure the aemserver User in Campaign aemserver-user

ÃÛ¶¹ÊÓƵ Campaign Standard by default comes with an aemserver user that AEM uses to connect to ÃÛ¶¹ÊÓƵ Campaign. Assign an appropriate security group for this user and set its password.

  1. Log into ÃÛ¶¹ÊÓƵ Campaign as an administrator.

  2. Click the ÃÛ¶¹ÊÓƵ Campaign Logo at the top-left of the menu bar to open the global navigation, then select Administration > Users & Security > Users from the navigation menu.

  3. Click the aemserver user in the users console.

  4. Ensure that the aemserver user is assigned at a minimum to a security group that has the role deliveryPrepare assigned to it. By default the group Standard Users has this role.

    aemserver user in ÃÛ¶¹ÊÓƵ Campaign

  5. Click Save to save the changes.

Your aemserver user now has the necessary rights so that AEM can use it to communicate with ÃÛ¶¹ÊÓƵ Campaign.

However, before AEM can use the aemserver user, its password must be set. This cannot be done through ÃÛ¶¹ÊÓƵ Campaign. It must be carried out by an ÃÛ¶¹ÊÓƵ support engineer. Submit a ticket with ÃÛ¶¹ÊÓƵ Customer Care to request the reset of the aemserver password. Once you have the password from ÃÛ¶¹ÊÓƵ Customer Care, keep it in a secure location.

Verify the AEMResourceTypeFilter in Campaign resource-type-filter

The AEMResourceTypeFilter is an option in ÃÛ¶¹ÊÓƵ Campaign that is used to filter AEM resources that can be used in ÃÛ¶¹ÊÓƵ Campaign. Because AEM contains much content, this option acts as a filter that allows ÃÛ¶¹ÊÓƵ Campaign to retrieve only the AEM content of types specifically designed to be used in ÃÛ¶¹ÊÓƵ Campaign.

This option comes pre-configured. However, you may need to update it if you have customized the Campaign components of AEM. To verify that the AEMResourceTypeFilter option is configured, follow these steps.

  1. Log into ÃÛ¶¹ÊÓƵ Campaign as an administrator.

  2. Click the ÃÛ¶¹ÊÓƵ Campaign Logo at the top-left of the menu bar to open the global navigation, then select Administration > Application Settings > Options from the navigation menu.

  3. Click the AEMResourceTypeFilter in the options console.

  4. Confirm the configuration of the AEMResourceTypeFilter. The paths are delimited with commas and by default contain:

    • mcm/campaign/components/newsletter
    • mcm/campaign/components/campaign_newsletterpage
    • mcm/neolane/components/newsletter

    AEMResourceTypeFilter

  5. Click Save to save the changes.

Your AEMResourceTypeFilter is now configured to retrieve the correct content from AEM.

Create an AEM-Specific Email Delivery Template in Campaign aem-email-delivery-template

By default, AEM is not enabled in ÃÛ¶¹ÊÓƵ Campaign’s email templates. Configure a new email delivery template that can be used to create emails using AEM content. To create an AEM-specific email delivery template, follow these steps.

  1. Log into ÃÛ¶¹ÊÓƵ Campaign as an administrator.

  2. Click the ÃÛ¶¹ÊÓƵ Campaign Logo at the top-left of the menu bar to open the global navigation, then select Resources > Templates > Delivery templates from the navigation menu.

  3. In the delivery templates console, locate the default email template Send via email (mail) and hover the mouse over the card (or line) representing it to reveal the options. Click Duplicate element.

    Duplicate element

  4. In the Confirmation dialog, click Confirm to duplicate the template.

    Confirmation dialog

  5. The template editor opens with your copy of the Send via email (mail) template. Click the Edit properties icon at the top-right of the window.

    Template editor

  6. In the properties window, change the Label field to be descriptive of your new AEM template.

  7. Click the Content heading to expand it and select ÃÛ¶¹ÊÓƵ Experience Manager in the Content source drop-down.

  8. This reveals the ÃÛ¶¹ÊÓƵ Experience Manager account field. Use the drop-down to select ÃÛ¶¹ÊÓƵ Experience Manager instance (aemInstance) user. This is the default external user for the AEM integration.

Configure template properties

  1. Click Confirm to save the changes to the properties.

  2. In the template editor, click Save to save your modified copy of the email template for use with AEM.

You now have an email template that can use AEM content.

Configure the Campaign Integration in AEM campaign-integration

AEM communicates with ÃÛ¶¹ÊÓƵ Campaign using a built-in integration and the aemserver user you configured in ÃÛ¶¹ÊÓƵ Campaign. Follow these steps to configure this integration.

  1. Sign into to your AEM authoring instance as an administrator.

  2. From the global navigation side rail, select Tools > Cloud Services > Legacy Cloud Services > ÃÛ¶¹ÊÓƵ Campaign, then click Configure Now.

    Configure ÃÛ¶¹ÊÓƵ Campaign

  3. In the dialog, create a Campaign service configuration by entering a Title and click Create.

    Configure Campaign dialog

  4. A new window and dialog opens to edit the configuration. Provide the necessary information.

    Configure ÃÛ¶¹ÊÓƵ Campaign in AEM

  5. Select Connect to ÃÛ¶¹ÊÓƵ Campaign to verify the connection and then click OK.

AEM can now communicate with ÃÛ¶¹ÊÓƵ Campaign.

NOTE
Make sure that your ÃÛ¶¹ÊÓƵ Campaign server is reachable via the internet. AEM cannot access private networks.

Configure Replication to AEM Publish Instance replication

Campaign content is created by content authors on the AEM authoring instance. This instance is typically only available internally at your organization. For content such as images and assets to be accessible to the recipients of your campaign, you need to publish that content.

The replication agent is responsible for publishing your content from the AEM author instance to the publish instance and must be set up for the integration to work properly. This step is also necessary to replicate certain authoring instance configurations into the publishing instance.

To configure replication from your AEM author instance to the publish instance:

  1. Sign into to your AEM authoring instance as an administrator.

  2. From the global navigation side rail, select Tools > Deployment > Replication > Agents on author, then click Default agent (publish).

    Configure replication agent

  3. Click Edit then select the Transport tab.

  4. Configure the URI field by replacing the default localhost value with the IP address of the AEM publishing instance.

    Transport tab

  5. Click OK to save the changes to the agent settings.

You have configured replication to the AEM publish instance so your campaign recipients can access your content.

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 via OSGi
From the global navigation side rail, select Tools > Operations > Web Console > OSGi Configuration and search for AEM Campaign Integration - Configuration. Edit the configuration and change the field Public URL (com.day.cq.mcm.campaign.impl.IntegrationConfigImpl#aem.mcm.campaign.publicUrl).

Configure the AEM Externalizer externalizer

The Externalizer is an OSGi service in AEM that transforms a resource path into an external and absolute URL, which is necessary for AEM to serve content that Campaign can use. Configure it so that the Campaign integration works.

  1. Sign into the AEM authoring instance as an administrator.

  2. From the global navigation side rail, select Tools > Operations > Web Console > OSGi Configuration and search for Day CQ link Externalizer.

  3. By default the last entry in the Domains field is intended for the publish instance. Change the URL from the default http://localhost:4503 to your publicly available publish instance.

    Configuring the Externalizer

  4. Click Save.

You have configured the Externalizer and ÃÛ¶¹ÊÓƵ Campaign can now access your content.

NOTE
The publish instance must be reachable from the ÃÛ¶¹ÊÓƵ Campaign server. If it points to localhost:4503 or another server that ÃÛ¶¹ÊÓƵ Campaign cannot reach, images from AEM will not appear in the ÃÛ¶¹ÊÓƵ Campaign console.

Configure the campaign-remote User in AEM campaign-remote-user

Just as you need a user in ÃÛ¶¹ÊÓƵ Campaign that AEM can use to communicate with ÃÛ¶¹ÊÓƵ Campaign, ÃÛ¶¹ÊÓƵ Campaign also needs a user in AEM for communication with AEM. By default the Campaign integration creates the campaign-remote user in AEM. Follow these steps to configure this user.

  1. Log into AEM as an administrator.
  2. On the main navigation console, click Tools in the left rail.
  3. Then click Security > Users to open the user administration console.
  4. Locate the campaign-remote user.
  5. Select the campaign-remote user and click Properties to edit the user.
  6. In the Edit User Settings window, click Change Password.
  7. Provide a new password for the user and note the password in a secure location for future use.
  8. Click Save to save the password change.
  9. Click Save & Close to save the changes to the campaign-remote user.

Configure the AEM External Account in Campaign acc-external-user

When you created an AEM-specific email delivery template, you specified that the template should use the aemInstance external account to communicate with AEM. To enable two-way communication between both solutions, you need to configure this account in ÃÛ¶¹ÊÓƵ Campaign.

  1. Log into ÃÛ¶¹ÊÓƵ Campaign as an administrator.

  2. Click the ÃÛ¶¹ÊÓƵ Campaign Logo at the top-left of the menu bar to open the global navigation, then select Administration > Application settings > External accounts from the navigation menu.

  3. Click the ÃÛ¶¹ÊÓƵ Experience Manager instance (aemInstance) user in the users console.

  4. Ensure that the user has ÃÛ¶¹ÊÓƵ Experience Manager as the Type.

  5. In the Connection section, define the following fields:

    1. Server: This is the URL of your AEM authoring server. This should not end in a slash.
    2. Account: This is the campaign-remote user you previously configured in AEM.
    3. Password: This is the password for the campaign-remoteuser you previously configured in AEM.

    Editing the aemInstance user

  6. Ensure that the Enabled checkbox is selected and then click Save to save your changes.

Congratulations! You have completed the integration between AEM and ÃÛ¶¹ÊÓƵ Campaign Standard!

Next Steps next-steps

With both ÃÛ¶¹ÊÓƵ Campaign Classic and AEM configured, the integration is now complete.

You can now learn how to create a newsletter in ÃÛ¶¹ÊÓƵ Experience Manager by continuing with this document.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2