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 184.108.40.206. 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.
Before starting this procedure:
Adobe Support must provision your account for:
Your organization’s System Admininstrator should use the Admin Console to add the required developers in your organization to the relevant product profiles.
The first stage of the configuration is to create an IMS Configuration in AEM and generate the Public Key.
In AEM open the Tools menu.
In the Security section select Adobe IMS Configurations.
Select Create to open the Adobe IMS Technical Account Configuration.
Using the drop down under Cloud Configuration, select Adobe Analytics.
Activate Create new certificate and enter a new alias.
Confirm with Create certificate.
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.
Keep this configuration open, it will be needed again when Completing the IMS Configuration in 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.
Open the Adobe Developer Console to create a Project with Adobe Analytics that AEM will use:
Open the Adobe Developer Console for Projects:
Any projects that you have will be shown. Select Create New Project - the location and usage will depend on:
Select Add to Project followed by API:
Select Adobe Analytics, then Next:
If you are subscribed to Adobe Analytics, but do not see it listed then you should check the Prerequistes.
Select Service Account (JWT) as the type of type of authentication, then continue with Next:
Upload your public key, and when complete, continue with Next:
Review the credentials, and continue with Next:
Select the required product profiles, and continue with Save configured API:
The configuration will be confirmed.
You must now assign the required privileges to the integration:
Open the Adobe Admin Console:
Navigate to Products (top toolbar), then select Adobe Analytics - <your-tenant-id> (from the left panel).
Select Product Profiles, then your required workspace from the list presented. For example, Default Workspace.
Select API Credentials, then the required integration configuration.
Select Editor as the Product Role; instead of Observer.
From the Adobe Developer Projects console you can see a list of all your integration projects:
Select a specific project entry to show further details about the configuration. These include:
Some of these you will need to complete the integration for Adobe Analytics in AEM.
Returning to AEM you can complete the IMS configuration by adding required values from the integration project for Analytics:
Return to the IMS Configuration open in AEM.
Here you can use the Details stored for the Adobe Developer Console Integration Project:
audline of the Payload section below, e.g.
https://ims-na1.adobelogin.comin the example below
Confirm with Create.
Your Adobe Analytics configuration will be shown in the AEM console.
To confirm that the configuration is operating as expected:
Select your configuration.
Select Check Health from the toolbar, followed by Check.
If successful, you will see a confirmation message.
The configuration can now be referenced for a Cloud Service to use the Analytics Standard API:
Open the Tools menu. Then, within the Cloud Services section, select Legacy Cloud Services.
Scroll down to Adobe Analytics and select Configure now.
The Create Configuration dialog will open.
Enter a Title and, if you want, a Name (if left blank this will be generated from the title).
You can also select the required template (if more than one is available).
Confirm with Create.
The Edit Component dialog will open.
Enter the details in the Analytics Settings tab:
IMS Configuration: select the name of the IMS Configuration
Click Connect to Analytics to initialize the connection with Adobe Analytics.
If the connection is successful, the message Connection successful is displayed.
Select OK on the message.
Complete other parameters as required, followed by OK on the dialog to confirm the configuration.
You can now proceed to Adding an Analytics Framework to configure parameters that will be sent to Adobe Analytics.