DocumentationAEM 6.5User Guide

Connecting to Adobe Analytics and Creating Frameworks connecting-to-adobe-analytics-and-creating-frameworks

Last update: Mon Jan 08 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

To track web data from your AEM pages in Adobe Analytics, create an Adobe Analytics Cloud Services configuration and an Adobe Analytics framework:

  • Adobe Analytics Configuration: The information about your Adobe Analytics account. The Adobe Analytics configuration enables AEM to connect to Adobe Analytics. Create an Adobe Analytics configuration for each account that you use.
  • Adobe Analytics Framework: A set of mappings between Adobe Analytics report suite properties and CQ variables. Use a framework to configure how your website data populates your Adobe Analytics reports. Frameworks are associated with an Adobe Analytics configuration. You can create multiple frameworks for each configuration.

When you associate a web page with a framework, the framework performs tracking for that page and the descendants of that page. Page views can then be retrieved from Adobe Analytics and displayed in the Sites console.

Prerequisites prerequisites

Adobe Analytics Account adobe-analytics-account

To track AEM data in Adobe Analytics, you must have a valid Adobe Experience Cloud Adobe Analytics account.

The Adobe Analytics account must:

  • Have Administrator privileges
  • Be assigned to the Web Service Access user group.
CAUTION
Providing Administrator privileges (within Adobe Analytics) is not enough to allow a user to connect from AEM to Adobe Analytics. The account must also have Web Service Access privileges.

chlimage_1-67

Before proceeding, ensure that your credentials let you log in to Adobe Analytics. By way of either of the following:

Configuring AEM to Use Your Adobe Analytics Data Centers configuring-aem-to-use-your-adobe-analytics-data-centers

Adobe Analytics data centers collect, process, and store data associated with your Adobe Analytics report suite. Configure AEM to use the data center that hosts your Adobe Analytics report suite. The data center is mentioned in your contract. Contact an Admin in your organization for this information.

If necessary, use the following to be routed to the correct data center: https://api.omniture.com/.

If your organization requires data collection or retrieval from a specific data center, use the following:

Data Center
URL
London
https://api3.omniture.com/
Singapore
https://api4.omniture.com/
Oregon
https://api5.omniture.com/

Use the Web Console to configure the OSGi bundle Adobe AEM Analytics HTTP Client. Add the Data Center URL for the data center that hosts a report suite for which your AEM pages collect data.

aa-07

  1. Open the Web console in your web browser. (https://localhost:4502/system/console/configMgr)

  2. To access the console, enter your credentials.

    note note
    NOTE
    To find out if you have access to this console, contact you site administrator.

  3. Select the Configuration item named Adobe AEM Analytics HTTP Client.

  4. To add the URL for a data center, press the + button next to the Data Center URLs list, and type the URL in the box.

  5. To remove a URL from the list, click the - button next to the URL.

  6. Click Save.

Configuring the Connection to Adobe Analytics configuring-the-connection-to-adobe-analytics

CAUTION
Due to security changes within the Adobe Analytics API, it is no longer possible to use the version of Activity Map that is included within AEM.
The ActivityMap plugin provided by Adobe Analytics should now be used.

Configuring for the Activity Map configuring-for-the-activity-map

CAUTION
Due to security changes within the Adobe Analytics API, it is no longer possible to use the version of Activity Map that is included within AEM.
The ActivityMap plugin provided by Adobe Analytics should now be used.

Creating an Adobe Analytics Framework creating-a-adobe-analytics-framework

For the Report Suite ID (RSID) that you are using, you can control which server instances (author, publish, or both) contribute data to the Report Suite:

  • All: Information from both the author and the publish instance populates the Report Suite.
  • Author: Only information from the author instance populates the Report Suite.
  • Publish: Only information from the publish instance populates the Report Suite.
NOTE
Selecting the type of server instance does not restrict calls to Adobe Analytics, it merely controls which calls include the RSID.
For example, a framework is configured to use the diiweretail report suite and author is the selected server instance. When pages are published along with the framework, calls are still made to Adobe Analytics, however these calls do not contain the RSID. Only calls from the author instance include the RSID.

  1. Using Navigation, select Tools, Cloud Services, then Legacy Cloud Services.

  2. Scroll to Adobe Analytics and select Show Configurations.

  3. Click the [+] link next to your Adobe Analytics configuration.

  4. In the Create Framework dialog:

    • Specify a Title.
    • Optionally you can specify the Name, for the node that stores the framework details in the repository.
    • Select Adobe Analytics Framework

    And click Create.

    The framework opens for editing.

  5. In the Report Suites section of the side pod (right side of main panel), click Add Item. Then use the drop-down to select the Report Suite ID (for example, geometrixxauth) with which the framework interacts.

    note note
    NOTE
    The content finder on the left is populated with Adobe Analytics variables (SiteCatalyst Variables) when you select a Report Suite ID.

  6. To select the server instances that you want to send information to the Report Suite, use the Run Mode drop-down (next to the Report Suite ID).

    aa-framework-01

  7. To make the framework available on the publish instance of your site, on the Page tab of sidekick, click Activate Framework.

Configuring Server Settings for Adobe Analytics configuring-server-settings-for-adobe-analytics

The framework system lets you change the server settings within each Adobe Analytics framework.

CAUTION
These settings determine where your data is sent and how, so it is imperative that you do not tamper with these settings and let your Adobe Analytics representative set it up instead.

Start by opening the panel. Press the downward arrow next to Servers:

server_001

  • Tracking Server

    • contains the URL used to send Adobe Analytics calls

      • cname - defaults to the Adobe Analytics account’s Company name
      • d1 - corresponds to the data center that the information is sent to (either d1, d2, or d3)
      • sc.omtrdc.net - domain name

  • Secure Tracking Server

    • Has the same segments as the Tracking server
    • Used for sending data from secure pages (https://)

  • Visitor Namespace

    • The namespace determines the first part of the tracking URL.
    • For example, changing the namespace to CNAME causes the calls made to Adobe Analytics to look like CNAME.d1.omtrdc.net instead of the default.

Associating a Page with an Adobe Analytics Framework associating-a-page-with-a-adobe-analytics-framework

When a page is associated with an Adobe Analytics framework, the page sends data to Adobe Analytics when the page loads. Variables that the page populates are mapped and retrieved from Adobe Analytics variables in the framework. For example, page views are retrieved from Adobe Analytics.

Descendents of the page inherit the association with the framework. For example, when you associate the root page of your site with a framework, all pages of the site are associated with the framework.

  1. From the Sites console, select the page you wish to set up with tracking.

  2. Open the Page Properties, either directly from the console, or the page editor.

  3. Open the** Cloud Services** tab.

  4. Use the Add Configuration drop-down to select Adobe Analytics from the available options. If inheritance is place, disable that before the selector becomes available.

  5. The drop-down selector for Adobe Analytics is appended to the options available. Select the required framework configuration.

  6. Select Save & Close.

  7. To activate the page and any connected configurations/files, Publish the page.

  8. The final step is to visit the page on the publish instance and search for a keyword (for example, aubergine) using the Search component.

  9. You can then check the calls made to Adobe Analytics using an appropriate tool; for example, Adobe Experience Cloud Debugger.

  10. Using the example provided, the call should contain the value entered (that is, aubergine) in eVar7 and the events list should contain event3.

Page Views page-views

When a page is associated with an Adobe Analytics framework, the number of page views can be shown in the List view of the Sites console.

See Seeing Page Analytics Data for further details.

Configuring the Import Interval configuring-the-import-interval

Configure the appropriate instance of the Adobe AEM Analytics Report Sling Importer service:

  • Fetch attempts:
    Number of attempts to fetch a queued report.
    The default is 6.

  • Fetch delay:
    The number of milliseconds between attempts to fetch a queued report.
    The default is 10000. As this is in milliseconds it corresponds to 10 seconds.

  • Fetch frequency:
    A cron expression to determine the frequency for fetching the Analytics Report.
    The default is 0 0 0/12 * * ?; this corresponds to 12 fetches every hour.

To configure this OSGi service, you can either use the Web Console or an osgiConfig node in the repository (the service PID is com.day.cq.analytics.sitecatalyst.impl.importer.ReportImporterScheduler).

Editing Adobe Analytics Configurations and/or Frameworks editing-adobe-analytics-configurations-and-or-frameworks

As when creating an Adobe Analytics configuration or framework, navigate to the (legacy) Cloud Services screen. Select Show Configurations, then click the link to the specific configuration you want to update.

When editing an Adobe Analytics configuration, press Edit when on the configuration page itself to open the Edit Component dialog.

Deleting Adobe Analytics Frameworks deleting-adobe-analytics-frameworks

To delete an Adobe Analytics framework, first open it for editing.

Then select Delete Framework from the Page tab of the sidekick.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2