Integration with Adobe Target using IMS integration-with-adobe-target-using-ims

The integration of AEM with Adobe Target via the Target Standard API requires the configuration of Adobe IMS (Identity Management System) using the Adobe Developer Console.

Support for the Adobe Target Standard API is new in AEM 6.5. The Target Standard API uses IMS authentication.
Using the Adobe Target Classic API in AEM is still supported for backward compatibility. The Target Classic API uses user credentials authentication.
The API selection is driven by the authentication method used for AEM/Target integration.
See also the Tenant ID and Client Code section.

Prerequisites prerequisites

Before starting this procedure:

  • Adobe Support must provision your account for:

    • Adobe Console
    • Adobe Developer Console
    • Adobe Target and
    • Adobe IMS (Identity Management System)
  • Your organization’s System Administrator should use the Admin Console to add the required developers in your organization to the relevant product profiles.

    • This provides the specific developers with permissions to enable integrations within the Adobe Developer Console.
    • See Manage Developers.

Configuring an IMS Configuration - Generating a Public Key configuring-an-ims-configuration-generating-a-public-key

The first stage of the configuration is to create an IMS Configuration in AEM and generate the Public Key.

  1. In AEM open the Tools menu.

  2. In the Security section, select Adobe IMS Configurations.

  3. Select Create to open the Adobe IMS Technical Account Configuration.

  4. Using the drop-down under Cloud Configuration, select Adobe Target.

  5. Activate Create new certificate and enter a new alias.

  6. Confirm with Create certificate.

    Adobe IMS Technical Account Configuration wizard

  7. Select Download (or Download Public Key) to download the file to your local drive, so that it is ready for use when configuring IMS for Adobe Target integration with AEM.

    note caution
    Keep this configuration open; it is needed again when Completing the IMS Configuration in AEM.

    Information message to add certificate on Adobe I/O

Configuring IMS for Adobe Target integration with AEM configuring-ims-for-adobe-target-integration-with-aem

Using the Adobe Developer Console, create a Project (integration) with Adobe Target that AEM can use, then assign the required privileges.

Creating the Project creating-the-project

To create a Project with Adobe Target that AEM can use, open the Adobe Developer Console:

Currently, Adobe only supports the Adobe Developer Console’s Service Account (JWT) credential type.
Do not use the OAuth Server-to-Server credential type, which will be supported in the future.
  1. Open the Adobe Developer Console for Projects:

  2. Any projects that you have are shown. Select Create New Project - the location and usage depend on the following:

    • If you do not have any project yet, Create new project is center, bottom.
      Create New Project - First Project
    • If you already have existing projects, these are listed and Create new project is on the upper right.
      Create New Project - Multiple Projects
  3. Select Add to Project followed by API:

    Adobe Developer Console

  4. Select Adobe Target, then Next:

    note note
    If you are subscribed to Adobe Target, but do not see it listed then you should check the Prerequisites.

    Clicking next

  5. Upload your public key, and when complete, continue with Next:

    Adding integrations using Developer Console

  6. Review the credentials, and continue with Next:

    Creating a project

  7. Select the required product profiles, and continue with Save configured API:

    note note
    The product profiles displayed with depend on whether you have:
    • Adobe Target Standard - only Default Workspace is available
    • Adobe Target Premium - all available workspaces are listed, as shown below

    Selecting an API to add

  8. The creation is confirmed.

Assigning privileges to the Integration assigning-privileges-to-the-integration

Now assign the required privileges to the integration:

  1. Open the Adobe Admin Console:

  2. Navigate to Products (top toolbar), then select Adobe Target - <your-tenant-id> (from the left panel).

  3. Select Product Profiles, then your required workspace from the list presented. For example, Default Workspace.

  4. Select API Credentials, then the required integration configuration.

  5. Select Editor as the Product Role; instead of Observer.

Details stored for the Adobe Developer Console Integration Project details-stored-for-the-ims-integration-project

From the Adobe Developer Console - Projects you can see a list of all your integration projects:

To show further details about the configuration, select View (to the right of a specific project entry). These include:

  • Project overview

  • Insights

  • Credentials

    • Service Account (JWT)

      • Credential details
      • Generate JWT
  • APIS

    • For example, Adobe Target

Some of these you must complete the integration of Adobe Target in AEM based on IMS.

Completing the IMS Configuration in AEM completing-the-ims-configuration-in-aem

Returning to AEM, you can complete the IMS configuration by adding the required values from the Adobe Developer Console integration for Target:

  1. Return to the IMS Configuration open in AEM.

  2. Select Next.

  3. Here you can use the details from the project configuration in the Adobe Developer Console:

    • Title: Your text.
    • Authorization Server: Copy/paste this from the aud line of the Payload section below, for example, in the example below
    • API Key: Copy this from the Overview section
    • Client Secret: Generate this in the Overview section, and copy
    • Payload: Copy this from the Generate JWT section

    Technical Account Configuration

  4. Confirm with Create.

  5. Your Adobe Target configuration is shown in the AEM console.

    Adobe IMS Technical Account Configuration

Confirming the IMS Configuration confirming-the-ims-configuration

To confirm that the configuration is operating as expected:

  1. Open:

    • https://localhost<port>/libs/cq/adobeims-configuration/content/configurations.html

    For example:

    • https://localhost:4502/libs/cq/adobeims-configuration/content/configurations.html
  2. Select your configuration.

  3. Select Check Health from the toolbar, followed by Check.

    Adobe IMS Configurations

  4. If successful, you see the message:

    Checking a configuration

Configuring the Adobe Target Cloud Service configuring-the-adobe-target-cloud-service

The configuration can now be referenced for a Cloud Service to use the Target Standard API:

  1. Open the Tools menu. Then, within the Cloud Services section, select Legacy Cloud Services.

  2. Scroll down to Adobe Target and select Configure now.

    The Create Configuration dialog box opens.

  3. Enter a Title and, if you want, a Name (if left blank, it is generated from the title).

    You can also select the required template (if more than one is available).

  4. Confirm with Create.

    The Edit Component dialog box opens.

  5. Enter the details in the Adobe Target Settings tab:

    • Authentication: IMS

    • Tenant ID: the Adobe IMS Tenant ID. See also the Tenant ID and Client Code section.

      note note
      For IMS, this value must be taken from Target itself. You can log into Target and extract the Tenant ID from the URL.
      For example, if the URL is:
      Then you would use yourtenantid.
    • Client Code: See the Tenant ID and Client Code section.

    • IMS Configuration: select the name of the IMS Configuration

    • API Type: REST

    • A4T Analytics Cloud Configuration: Select the Analytics Cloud configuration that is used for target activity goals and metrics. You need this if you are using Adobe Analytics as the reporting source when targeting content. If you do not see your cloud configuration, see the note in Configuring A4T Analytics Cloud Configuration.

    • Use accurate targeting: By default this check box is selected. If selected, the cloud service configuration waits for the context to load before loading content. See note that follows.

    • Synchronize segments from Adobe Target: Select this option so you can download segments that are defined in Target to use them in AEM. Select this option when the API Type property is REST, because inline segments are not supported and you must always use segments from Target. (The AEM term of ‘segment’ is equivalent to the Target ‘audience’.)

    • Client library: Select whether you want the AT.js client library, or mbox.js (deprecated).

    • Use Tag Management System to deliver client library: Use DTM (deprecated), Adobe Launch, or any other tag management system.

    • Custom AT.js: Leave blank if you checked the Tag Management box or to use the default AT.js. Alternatively upload your custom AT.js. Only appears if you have selected AT.js.

    note note
    Configuration of a Cloud Service to use the Target Classic API has been deprecated (uses the Adobe Recommendations Settings tab).
  6. Click Connect to Target to initialize the connection with Adobe Target.

    If the connection is successful, the message Connection successful is displayed.

  7. Select OK on the message, followed by OK on the dialog box so you can confirm the configuration.

  8. You can now proceed to Adding a Target Framework to configure ContextHub or ClientContext parameters that are sent to Target. Note this may not be required for exporting AEM Experience Fragments to Target.

Tenant ID and Client Code tenant-client

With Adobe Experience Manager, the Client Code field had been added to the Target configuration window.

When configuring the Tenant ID and Client Code fields, be aware of the following:

  1. For most customers, the Tenant ID and the Client Code are the same. This means that both fields contain the same information and are identical. Make sure you enter the Tenant ID in both fields.
  2. For legacy purposes, you can also enter different values in the Tenant ID and the Client Code fields.

In both cases, be aware of the following:

  • By default, the Client Code (if added first) is also automatically copied into the Tenant ID field.
  • You can optionally change the default Tenant ID set.
  • So, the backend calls to Target are based on the Tenant ID and the client side calls to Target are based on the Client Code.

As stated previously, the first case is the most common for AEM 6.5. Either way, make sure that both fields contain the correct information depending on your requirements.

If you want to change an existing Target Configuration:
  1. Re-enter the Tenant ID.
  2. Re-connect to Target.
  3. Save the configuration.