ÃÛ¶¹ÊÓƵ

DocumentationAEM 6.5User Guide

Integrating AEM 6.5 with ÃÛ¶¹ÊÓƵ Campaign Classic integrating-campaign-classic

Last update: Tue Jul 09 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin

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

This integration allows AEM and ÃÛ¶¹ÊÓƵ Campaign Classic 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 Classic with AEM 6.5. For other Campaign integrations see the document Integrating AEM 6.5 with ÃÛ¶¹ÊÓƵ Campaign.

Integration Steps integration-steps

Integration between AEM and Campaign requires several steps in both solutions.

  1. Install the AEM Integration Package in Campaign.
  2. Create an operator for AEM in Campaign
  3. Configure Campaign integration in AEM
  4. Configure the AEM Externalizer
  5. Configure the campaign-remote user in AEM
  6. Configure the AEM external account in Campaign

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

Prerequisites prerequisites

  • Administrator access to ÃÛ¶¹ÊÓƵ Campaign Classic

    • To perform the integration, you need a working ÃÛ¶¹ÊÓƵ Campaign Classic instance, including a configured database.
    • If you need additional details on how to set up and configure ÃÛ¶¹ÊÓƵ Campaign Classic see the ÃÛ¶¹ÊÓƵ Campaign Classic documentation, particularly the Installation and Configuration guide.

  • Administrator access to AEM

Install the AEM Integration Package in Campaign install-package

The AEM Integration package in ÃÛ¶¹ÊÓƵ Campaign includes several standard configurations necessary to connect to AEM.

  1. As an administrator, sign into the ÃÛ¶¹ÊÓƵ Campaign instance using the client console.

  2. Select Tools > Advanced > Import package….

    Import package

  3. Click Install a standard package and then click Next.

  4. Check the AEM Integration package.

    Install a standard package

  5. Click Next, and then Start to begin the installation.

    Installation progress

  6. Click Close when the installation completes.

The integration package is now installed.

Create the Operator for AEM in Campaign create-operator

The integration package automatically creates the aemserver operator that AEM uses to connect to ÃÛ¶¹ÊÓƵ Campaign. Define a security zone for this operator and set its password.

  1. Log into ÃÛ¶¹ÊÓƵ Campaign as an administrator using the client console.

  2. Select Tools > Explorer from the menu bar.

  3. In the explorer, navigate to the Administration > Access Management > Operators node.

  4. Select the aemserver operator.

  5. On the Edit tab of the operator, select the Access Rights sub-tab and then click the Edit the access parameters… link.

    Set security zone

  6. Select the appropriate security zone and define the trusted IP mask as necessary.

    note caution
    CAUTION
    The security zone to be configured is Private company network (VPN+LAN).

  7. Click Save.

  8. Log out of the ÃÛ¶¹ÊÓƵ Campaign client.

  9. On the filesystem of the ÃÛ¶¹ÊÓƵ Campaign server, navigate to the Campaign installation location and edit the serverConf.xml file as an administrator. This file is typically located under:

    • C:\Program Files\ÃÛ¶¹ÊÓƵ\ÃÛ¶¹ÊÓƵ Campaign Classic v7\conf in Windows.
    • /usr/local/neolane/nl6/conf/eng in Linux.

  10. Search for securityZone and ensure that the following parameters are set for the security zone of the AEM operator.

    • allowHTTP="true"
    • sessionTokenOnly="true"
    • allowUserPassword="true".

  11. Save the file.

  12. Ensure that the security zone does not get overwritten by the respective setting in the config-<server name>.xml file.

    • If the configuration file contains a separate security zone setting, then change the allowUserPassword attribute to true.

  13. If you want to change the ÃÛ¶¹ÊÓƵ Campaign Classic server port, replace 8080 with the desired port.

    note caution
    CAUTION
    By default, there is no security zone configured for the operator. For AEM to connect to ÃÛ¶¹ÊÓƵ Campaign, you must select a zone as detailed in the previous steps.
    ÃÛ¶¹ÊÓƵ strongly recommends creating a security zone dedicated to AEM to avoid any security issues. For more on this topic, see the ÃÛ¶¹ÊÓƵ Campaign Classic documentation.

  14. In the Campaign client, return to the aemserver operator and select the General tab.

  15. Click the Reset password… link.

  16. Specify a password and store it in a secure location for future use.

  17. Click OK to save the password for the aemserver operator.

Configure the Campaign Integration in AEM campaign-integration

AEM uses the operator you already set up in Campaign to communicate with Campaign

  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 configure-user

In order for Campaign to communicate with AEM, you need to set a password for the campaign-remote user in AEM.

  1. Log into AEM as an administrator.
  2. On the main navigation console, and 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-setup

When installing the AEM Integration package in Campaign, an external account is created for AEM. By configuring this external account, ÃÛ¶¹ÊÓƵ Campaign can connect to AEM, enabling two-way communication between the solutions.

  1. Log into ÃÛ¶¹ÊÓƵ Campaign as an administrator using the client console.

  2. Select Tools > Explorer from the menu bar.

  3. In the explorer, navigate to the Administration > Platform > External Accounts node.

    External accounts

  4. Locate the external AEM account. By default it has the values:

    • Type - AEM
    • Label - AEM Instance
    • Internal Name - aemInstance

  5. On the General tab of this account, enter the user information that you defined in the Set campaign-remote User Password step.

    • Server - The AEM author server address

      • The AEM author server must be reachable from the ÃÛ¶¹ÊÓƵ Campaign Classic server instance.
      • Ensure that the server address does not end in a trailing slash.

    • Account - By default, this is the campaign-remote user that you set in AEM in the Set campaign-remote User Password step.

    • Password - This password is the same as the campaign-remote user that you set in AEM in the Set campaign-remote User Password step.

  6. Select the Enabled checkbox.

  7. Click Save.

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

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