Integration with Adobe Analytics using IMS integration-with-adobe-analytics-using-ims

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

Support for the Adobe Analytics Standard API 2.0 is new in AEM This version of the API supports IMS authentication.
Using the Adobe Analytics Classic API 1.4 in AEM is still supported for backward compatibility. The Analytics Classic API uses user credentials 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 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 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 Analytics.

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

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

    Info dialog to add the key to Adobe I/O

Configuring IMS for Adobe Analytics integration with AEM configuring-ims-for-adobe-analytics-integration-with-aem

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

Creating the Project creating-the-project

To create a Project with Adobe Analytics 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 depends 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 located upper-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 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 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 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 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 details-stored-for-the-ims-integration-project

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

To show further details about the configuration, select a specific project entry. These include:

  • Project overview

  • Insights

  • Credentials

    • Service Account (JWT)

      • Credential details
      • Generate JWT
  • APIS

    • For example, Adobe Analytics

Some of these you must complete the integration for Adobe Analytics in AEM.

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 integration project for Analytics:

  1. Return to the IMS Configuration open in AEM.

  2. Select Next.

  3. Here you can use the Details stored for the Adobe Developer Console Integration Project:

    AEM IMS COnfiguration details

  4. Confirm with Create.

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

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

    IMS Configuration - Check Health

  4. If successful, you see a confirmation message.

Configuring the Adobe Analytics Cloud Service configuring-the-adobe-analytics-cloud-service

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

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

  2. Scroll down to Adobe Analytics 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 Analytics Settings tab:

    • Authentication: IMS

    • IMS Configuration: select the name of the IMS Configuration

  6. To initialize the connection with Adobe Analytics, click Connect to Analytics.

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

  7. Select OK on the message.

  8. Complete other parameters as required, followed by OK on the dialog box so you can confirm the configuration.

  9. You can now proceed to Adding an Analytics Framework to configure parameters that are sent to Adobe Analytics.