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.
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.
-
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.
note caution CAUTION Keep this configuration open; it is needed again when Completing the IMS Configuration in AEM.
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:
-
Open the Adobe Developer Console for Projects:
-
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.
- If you already have existing projects, these are listed and Create new project is located upper-right.
- If you do not have any project yet, Create new project is center, bottom.
-
Select Add to Project followed by API:
-
Select Adobe Analytics, then Next:
note note NOTE If you are subscribed to Adobe Analytics, but do not see it listed then you should check the Prerequisites. -
Select Service Account (JWT) as the 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 is confirmed.
Assigning privileges to the Integration assigning-privileges-to-the-integration
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.
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:
-
Return to the IMS Configuration open in AEM.
-
Select Next.
-
Here you can use the Details stored for the Adobe Developer Console Integration Project:
- Title: Your text.
- Authorization Server: Copy/paste this from the
aud
line of the Payload section below, for example,https://ims-na1.adobelogin.com
in the example below - API Key: Copy this from the Credentials section of the Project overview
- Client Secret: Generate this in the Client Secret tab of the Service Account (JWT) section, and copy
- Payload: Copy this from the Generate JWT tab of the Service Account (JWT) section
-
Confirm with Create.
-
Your Adobe Analytics configuration is shown in the AEM console.
Confirming the IMS Configuration confirming-the-ims-configuration
To confirm that the configuration is operating as expected:
-
Open:
https://localhost<port>/libs/cq/adobeims-configuration/content/configurations.html
For example:
https://localhost:4502/libs/cq/adobeims-configuration/content/configurations.html
-
Select your configuration.
-
Select Check Health from the toolbar, followed by Check.
-
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:
-
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 box opens.
-
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).
-
Confirm with Create.
The Edit Component dialog box opens.
-
Enter the details in the Analytics Settings tab:
-
Authentication: IMS
-
IMS Configuration: select the name of the IMS Configuration
-
-
To initialize the connection with Adobe Analytics, click Connect to 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 box so you can confirm the configuration.
-
You can now proceed to Adding an Analytics Framework to configure parameters that are sent to Adobe Analytics.