You're viewing help content for version:

Add components to the framework that gather the data to send to Adobe Analytics. Components that are designed to gather analytics data store the data in the appropriate CQ variable. When you add such a component to a framework, the framework displays the list of CQ variables so that you can each to the appropriate Analytics variable.


When the AEM view is open the Analytics variables appear in the content finder. 


You can map the same Analytics variable with multiple CQ variables. You can also map multiple Analytics variables with the same CQ variable.


The mapped data is sent to Adobe Analytics when the page loads and the following conditions are met:

  • The page is associated with the framework.
  • The page uses the components that are added to the framework.

Use the following procedure to map CQ component variables with Adobe Analytics report properties.

  1. In the AEM view, drag a tracking component from sidekick onto the framework. For example, drag the Page component component from the General category. 


    There are several default component groups: General, Commerce, Communities, Search&Promote, and Other. Your AEM instance may be configured to display different groups and components.

  2. To map Adobe Analytics variables with variables that are defined in the component, drag an Analytics variable from the content finder onto a field on the tracking component. For example, drag Page Name (pageName) to pagedata.title.



    The Report Suite ID that is selected for the framework determines the Adobe Analytics variables that appear in the content finder.

  3. Repeat the previous two steps for other components and variables.


    You can map multiple Analytics variables (e.g. props, eVars, events) to the same CQ variable (e.g. pagedata.title)


    It is highly recommended that:

    • eVars and props are mapped to CQ variables beginning with either pagedata.X or eventdata.X
    • whereas events should be mapped to variables starting with

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

Mapping Product-Related Variables

AEM uses a convention for naming product-related variables and events that are meant to be mapped to Adobe Analytics product-related properties:

CQ Variable Analytics Variable Description
product.category product.category (conversion variable) The product category.
product.sku product.sku (conversion variable) The product sku.
product.quantity product.quantity (conversion variable) The number of products being purchased.
product.price product.price (conversion variable) The product price. The success event(s) to associate with the product in your report. is the prefix for events named eventName.
product.evars.eVarName The conversion variable(s) (eVar) to associate with the product. product.evars is the prefix for eVar variables named eVarName.

Several AEM Commerce components use these variable names.


Do not map the Adobe Analytics Products property to a CQ variable. Configuring product-related mappings as described in the table is effectively equivalent to mapping the Products variable. 

Checking reports on Adobe Analytics

  1. Login to the Adobe Analytics website using the same credentials provided to AEM.
  2. Make sure the RSID selected is the one used in the previous steps.
  3. In Reports (on the left side of the page) select Custom Conversion, then Custom Conversion 1-10 and select the variable coresponding to eVar7
  4. Depending on the version of Adobe Analytics that you are using, you need to wait on average 45 minutes for the report to be updated with the search term used; e.g. aubergine in the example  

Using the Content Finder (cf#) on a Adobe Analytics Analytics framework

Initially, when you open an Adobe Analytics framework the content finder contains the following predefined Analytics variables:

  • Traffic variables: channel, pageName, pageType, pageURL, server, hier1, hier2, hier3, hier4, hier5
  • Conversion variables: purchaseID, campaign, transactionID, visitorID, products, product.category, product.sku, product.quantity, product.price, state, zip, list1, list2, list3
  • Events: prodView

When an RSID is selected all the variables belonging to that RSID get added to the list.
The cf# is needed in order to map Analytics variables to the CQ variables present on the different tracking components. See Setting Up a Framework for Basic Tracking.

Depending on the view selected for the framework, the content finder will be populated by either Analytics variables (in AEM view) or CQ variables (in Analytics view).

The list can be manipulated in the following ways:

  1. When in AEM view, the list can be filtered depending on what variable type is selected using the 3 filter buttons:
    • If No button is selected, the list shows the full list.
    • If the Traffic button is selected, the list will only show the variables belonging to the Traffic section
    • If the Conversion button is selected, the list will only show the variables belonging to the Conversion section. 
    • If the Events button is selected, the list will only show the variables belonging to the Events section.


Only one filter button can be active at once.


Search&Promote variables belong to the Conversion section as well.

  1. The list also has a search feature, which filters the elements according to the text entered in the search field.
  2. If a filter option is activated while searching for elements in the list, the results displayed will be filtered according to the active button as well.
  3. The list can be reloaded at any time using the swirly-arrows button.
  4. If multiple RSIDs are selected on the framework, all variables in the list will be displayed using all labels used within the RSIDs selected.
  1. When in Adobe Analytics view, the Content Finder displays all CQ variables belonging to the tracking components dragged in CQ view.
    • e.g. in case the Download component is the only one dragged in CQ view (which has two mappable variables eventdata.downloadLink and, the Content Finder wil look like this when switching to Adobe Analytics view:
  • The variables can be dragged&dropped onto any Adobe Analytics variable belonging to either one of the 3 variable sections (Traffic, Conversion and Events).
  • When dragging a new tracking component onto the framework in CQ view, the CQ variables belonging to the component get automatically added to the Content Finder(cf#) in Adobe Analytics view.


Only one CQ variable can be mapped to a Adobe Analytics variable at once

Using CQ view and Adobe Analytics view

At any given time, users have the option to switch between 2 ways of viewing the Adobe Analytics mappings when on a framework page. The 2 views provide a better overview of the mappings within the framework, from 2 distinct perspectives.

CQ View


Taking the above image as an example, the CQ view has the following properties:

  1. This is the default view the framework opens to.
  2. Arrow 1 - the content finder(cf#) is populated by Adobe Analytics variables based on the RSID(s) selected
  3. Arrow 2 - this is where you can swich between the 2 views
  4. Arrow 3 - if the framework has components that are inherited from its parent, they will be listed here, along with the variables mapped to the components.
    • Notice that the inherited Download component is "locked"
    • To unlock the inhertited component, just double-click on the padlock next to the component's name
    • In order to revert the inheritance you must delete the unlocked component; after which it will regain its "locked" status.
  5. Arrow 4 - You can find all of the components that are currently included in the analytics framework
    • To add a component drag&drop one from the SideKick's Components tab
    • To delete a component and all of its mappings:
      • press Delete if you're on Windows OR press Function+Delete if you're on a Mac; then accept the deletion on thE confirmation dialogue
      • Right-click and select Delete from the menu then accept the deletion on the confirmation dialogue
    • Keep in mind that a component can only be deleted from the framework it was created in, and cannot be deleted from child frameworks in the traditional sense. (they can only be overwritten)
  6. Drag components here to include them in the analytics framework - Components from the Sidekick can be drag&dropped here.

Adobe Analytics View

  1. This view can be accessed by switching to the Adobe Analytics tab on the framework. 
  2. Arrow 1 - Content Finder(cf#) populated by CQ variables based on the components dragged onto the framework in CQ view.
  3. Arrow 2 - Switch back to CQ view from here
  4. The 3 tables (Traffic, Conversion, Event) list all available Adobe Analytics variables belonging to the RSID(s) selected. The mappings shown here should be the same as in CQ view:
    • Arrow 3.a - Traffic variable (prop1) mapped to a CQ variable (eventdata.downloadLink)
      • Notice that the component has a Padlock next to it - this means it is inherited from a parent framework and thus cannot be edited
    • Arrow 3.b - Conversion variable (eVar1) mapped to a CQ variable (pagedata.title)
    • Arrow 3.c - Conversion variable (eVar3) mapped to a javascript expression added inline by double-clicking on the CQ variable field and entering the code manually
    • Arrow 3.d - Event variable (event1) mapped to a CQ event (



Only one CQ variable can be mapped to a Adobe Analytics variable at any given time.

  1. Every table’s CQ variable column can be filled inline as well, by double-clicking on the field and adding text to it. These fields accept javascript as an input.
    • e.g. next to prop3 you can add
      to send the title of a page concatenated with its sitesection using : (colon) and prefixed with Adobe as prop3
  2. The side pod is the same for both views.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy