IMS Configuration for use when Integrating with Adobe Analytics

The integration of Adobe Experience Manager as a Cloud Service (AEMaaCS) with Adobe Analytics via the Analytics Standard API requires the configuration of Adobe IMS (Identity Management System). The configuration is realized with the Adobe Developer Console.

NOTE

Support for the Adobe Analytics Standard API 2.0 is new in AEMaaCS 2022.2.0. This version of the API supports IMS authentication.

The API selection is driven by the authentication method used for AEM/Analytics integration.

Further information is also available under Migrating to the 2.0 APIs.

Prerequisites

Before starting this procedure:

  • Adobe Support must provision your account for:

    • Adobe Console
    • Adobe Developer Console
    • Adobe Analytics 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 using the Adobe Developer Console.
    • For further details see Manage Developers.

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 Analytics.

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

  6. Confirm with Create certificate.

    Create Certificate

  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 Analytics integration with AEM.

    CAUTION

    Keep this configuration open, it will be needed again when Completing the IMS Configuration in AEM.

    Download Certificate

Configuring IMS for Adobe Analytics integration with AEM

Using the Adobe Developer Console you need to create a Project (integration) with Adobe Analytics (for AEM to use), then assign the required privileges.

Creating the Project

Open the Adobe Developer Console to create a Project with Adobe Analytics that AEM will use:

  1. Open the Adobe Developer Console for Projects:

    https://developer.adobe.com/console/projects

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

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

    Get Started with your new Project

  4. Select Adobe Analytics, then Next:

    NOTE

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

    Add an API

  5. Select Service Account (JWT) as the type of type of authentication, then continue with Next:

    Select type of authentication

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

    Upload your public key

  7. Review the credentials, and continue with Next:

    Review credentials

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

    Select required product profiles

  9. The configuration will be confirmed.

Assigning privileges to the Integration

You must now assign the required privileges to the integration:

  1. Open the Adobe Admin Console:

  2. Navigate to Products (top toolbar), then select Adobe Analytics - <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

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

Select a specific project entry to show further details about the configuration. These include:

  • Project overview
  • Insights
  • Credentials
    • Service Account (JWT)
      • Credential details
      • Generate JWT
  • APIS
    • For example, Adobe Analytics

Some of these you will need to complete the integration of Adobe Analytics in AEM based on IMS.

Completing the IMS Configuration in AEM

Returning to AEM you can complete the IMS configuration by adding required values from the IMS integration for Analytics:

  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:

    AEM IMS COnfiguration details

  4. Confirm with Create.

  5. Your Adobe Analytics configuration will be shown in the AEM console.

    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.

    IMS Configuration - Check Health

  4. If successful, you will see a confirmation message.

Complete the Integration with Adobe Analytics

You can now use this IMS configuration to complete the integration with Adobe Analytics.

On this page