Before connecting DXA with Adobe Analytics, ensure you have the following in your Adobe Analytics account:
- An available Custom Insight Conversion Variable (eVar)
- A technical user account (Web Service access) with the following permissions:Note: For more information on managing product permissions, see Manage product permissions in the Admin Console in the Adobe Enterprise & Teams Administration guide.
Setting up in Adobe Analytics
Creating the eVar
In Adobe Analytics, go to Admin > All Report Suites > Edit Settings > Conversion > Conversion Variables.
Create the eVar.
Your eVar configurations should appear as displayed in the image below:
Populating the eVar with the session ID
For the integration to come together, you will need to populate the eVar with the DXA session ID. There are several ways this can be done, which are determined by the chosen Request Type in DXA.
The Default request type provides a convenient mechanism that requires no additional work. DXA will automatically make an additional beacon during a session call using s.tl() method to send the session ID. Users who are limited in the number of beacon calls they can make, or who depend on the default bounce rate metric from Adobe Analytics, can consider using the Manual approach outlined below.
The Manual request type allows for maximum control over how the eVar is populated. You must ensure that you implement the population of the eVar via your tag manager to ensure that the data connection is fully activated. Below are some common examples of how this can be achieved.
The easiest way to activate the population of the eVar is to use Adobe Experience Platform Launch.
Locating the API access information
In the Adobe Analytics top menu, go to Admin > Analytics Users & Assets.
Locate the account you want to integrate with DXA. You must ensure the account has Web Service access. Once you have identified the account from the list, click the name.
- Scroll down to the Web Service Credentials. Take note of the User Name and Shared Secret as they will be needed for setup in DXA.
Setting up in DXA
On the navigation bar, go to Connect > Data Connectors > Configure Data Connectors > Analytics > Adobe Analytics.
Select Adobe Analytics Integration Enabled.
The Adobe Analytics data connector settings appear.
- If you select 1.4 from the API Version dropdown and you select Webservice username and secret from the Authentication Type dropdown, enter the Username and shared Secret of the account being used to integrate. Click Check details to validate that the username and shared secret are correct. Once the username and shared secret are verified, DXA will initiate a request to the Adobe Analytics API and retrieve a list of Report Suites and eVars. Proceed to step 6.
If you select 1.4 from the API Version dropdown and you select JWT from the Authentication Type dropdown, first click Public/Private keypair. The fields Company Name, JWT Payload, Client ID, and Client Secret appear. To get details for these fields, open Adobe Analytics and select the Credential details tab for the associated project. Copy the details for Company Name, Client ID, and Client Secret and enter the information into the respective fields in DXA. In Adobe Analytics, click Generate a Public/Private keypair. Then select the Generate JWT tab and copy the information. You will also need to upload the Public/Private Key Pair generated in DXA by clicking Add a public key in Adobe Analytics. Then you can upload the file generated by DXA. Proceed to step 6.
Paste that into the JWT Payload field in DXA.
- If you select 2.0 from the API Version dropdown and you select OAuth Server to Server from the Authentication Type dropdown, enter a Client ID and a Client Secret. Click Check details to validate that the client ID and client secret are correct. Once the username and shared secret are verified, DXA will initiate a request to the Adobe Analytics API and retrieve a list of Report Suites and eVars.
- Select the desired Report Suite and Custom Variable eVar for the data connection.
- Select a Request Type.Note: For more information, see "Populating the eVar with the session ID" in Setting up in Adobe Analytics.
Select Use Shared Segments. This setting is required, especially if using a technical user account to ensure that segments created by other users in Adobe Analytics, or that have been shared with the Report Suite, are available in DXA.
- (Optional) If your Adobe Analytics instance has more than 50 segments, we suggest that you enable the option to Hide Segments by Default. This setting hides all imported segments from Adobe Analytics in DXA until they are enabled reducing the processing overhead on accounts with many existing segments in Adobe Analytics.Note: For more information, see Adobe Analytics and Google Analytics Segments.
If you have multiple domains under the property that you are configuring implementation for, under Tracked Domains, select which of the domains to enable for the data connection.
- (Optional) To force DXA to immediately fetch the segment data, click Force Segment Data Fetch.Note: The time it takes for this to complete will depend on the total number of segments enabled and how quickly Adobe Analytics can fulfill the export requests.