ÃÛ¶¹ÊÓƵ

DocumentationAEM 6.5User Guide

Analytics using Cloud Service Framework analyticsusingcloudframework

Last update: Mon Jun 24 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • User
  • Developer

AEM Forms integrates with Analytics that lets you capture and track performance metrics for your published forms and documents. The objective behind analyzing these metrics is to make informed decisions based on data about the changes required to make forms or document more usable.

NOTE
The analytics feature in AEM Forms is available as part of the AEM Forms add-on package. For information about installing the add-on package, see Installing and configuring AEM Forms.
In addition to the add-on package, you need an ÃÛ¶¹ÊÓƵ Analytics account and administrator privileges on the AEM instance. For information about the solution, see .

You can also perform analytics using ÃÛ¶¹ÊÓƵ Launch. For more information on how to integrate AEM Forms with ÃÛ¶¹ÊÓƵ Launch, see Analytics using ÃÛ¶¹ÊÓƵ Launch.

Overview overview

You can use ÃÛ¶¹ÊÓƵ Analytics to discover interaction patterns and problems users face while using adaptive forms, HTML5 forms and interactive communication. Out of the box, ÃÛ¶¹ÊÓƵ analytics tracks and stores information about the following parameters:

  • Average fill time: Average time spent to fill the form.
  • Renditions: Number of times a form is opened.
  • Drafts: Number of times a form is saved in the draft state.
  • Submissions: Number of times a form is submitted.
  • Abort: Number of times the users leave without completing the form.

You can customize ÃÛ¶¹ÊÓƵ Analytics to add/remove more parameters. Along with the above information, the report contains following information about every panel of the HTML5 and adaptive form:

  • Time: Time spent on the panel and the fields of the panel.
  • Error: Number of errors encountered on the panel and on the fields of the panel.
  • Help: Number of times a user opens help of a panel and the fields of the panel.

Creating report suite creating-report-suite

Analytics data is stored in customer-specific repositories called report suites. To create report suite and use ÃÛ¶¹ÊÓƵ Analytics, you must have a valid ÃÛ¶¹ÊÓƵ Marketing Cloud account. Before performing the following steps, ensure that you have a valid ÃÛ¶¹ÊÓƵ Marketing Cloud account.

Perform the following steps to create a report suite.

  1. Log in at

  2. In the Marketing Cloud, select Admin > Admin Console > Report Suites.

  3. Select Create New > Report Suite in the Report Suite Manager.

    Create new Report Suite

    Create new Report Suite

  4. Make sure the first dropdown list is set to Create from a Template and then select Commerce.

  5. Locate the Report Suite ID field and add new Report Suite ID. For example, JJEsquire. A report suite ID appears below the Report Suite ID field. It includes an automatic prefix, which is often the company name.

  6. Add new Site Title. For example, JJEsquire Getting Started Suite. This title is used within the Analytics UI. Use the report suite ID in your code.

  7. Select a Time Zone from the dropdown. All of the data that comes into this report suite is recorded based on defined time zone.

  8. Leave the Base URL and Default Page fields empty. These two values are only used from the ÃÛ¶¹ÊÓƵ Marketing Cloud interface to link to your website.

  9. Leave the Go Live Date set to today. The Go Live Date determines the day when the report suite is activated.

  10. In the Estimated Page Views Per Day field, type 100. Use this field to estimate the number of page views you anticipate for your website per day. This estimate allows ÃÛ¶¹ÊÓƵ to put in place the appropriate amount of hardware to process the data you will be collecting.

  11. Select a Base Currency from the dropdown. All currency data that comes into this report suite is converted and stored in this currency format.

  12. Click Create Report Suite. You should see the page refresh with a message that your report suite has been successfully created.

  13. Select the newly created Report Suite. Navigate to Edit Settings > General > General Account Settings.

    General Account Settings

    General Account Settings

  14. In General Account Settings screen, enable Geography Reporting, and click Save.

  15. Navigate to Edit Settings > Traffic > Traffic Variables.

  16. In the report suite, configure and enable following traffic variables.

    • formName: Identifier for an adaptive form.
    • formInstance: Identifier of an adaptive form instance. Enable Path reports for this variable.
    • fieldName: Identifier of an adaptive form field. Enable Path reports for this variable.
    • panelName: Identifier of an adaptive form panel. Enable Path reports for this variable.
    • formTitle: Title of the form.
    • fieldTitle: Title of the form field.
    • panelTitle: Title of the form panel.
    • analyticsVersion: Version of form analytics.

  17. Navigate to Edit Settings > Conversion > Success Events. Define and enable the following success events:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2
    Success Event Type
    abandon Counter
    render Counter
    panelVisit Counter
    fieldVisit Counter
    save Counter
    error Counter
    help Counter
    submit Counter
    timeSpent Numeric
    note note
    NOTE
    An event number and prop number used to configure AEM Forms analytics must be different from event number and prop number used in AEM analytics configuration.

  18. Log out of the ÃÛ¶¹ÊÓƵ Marketing Cloud account.

Creating Cloud Service Configuration creating-cloud-service-configuration

Cloud Service configuration is information about your ÃÛ¶¹ÊÓƵ Analytics account. The configuration enables ÃÛ¶¹ÊÓƵ Experience Manager (AEM) to connect to ÃÛ¶¹ÊÓƵ Analytics. Create a separate configuration for each Analytics account that you use.

  1. Log in to your AEM author instance as an administrator.

  2. In the top-left corner, click ÃÛ¶¹ÊÓƵ Experience Manager > Tools hammer icon > Cloud Services > Legacy Cloud Services.

  3. Locate ÃÛ¶¹ÊÓƵ Analytics icon. Click Show Configurations and then proceed to click [+] to add new configuration.

    If you are a first-time user, click Configure now.

  4. Add a Title to your new configuration (filling out the Name field is optional). For example, My analytics configuration. Click Create.

  5. When the Edit panel opens on the configuration page, fill in the fields:

    • Company: Your company’s name as featured on ÃÛ¶¹ÊÓƵ Analytics.
    • Username: The name used to log in to ÃÛ¶¹ÊÓƵ Analytics.
    • Password: The ÃÛ¶¹ÊÓƵ Analytics password for the above account.
    • Data Center: The Data Center of your ÃÛ¶¹ÊÓƵ Analytics account.

  6. Click Connect to Analytics. A dialog appears with message that the connection was successful. Click OK.

Creating Cloud Service Framework creating-cloud-service-framework

An ÃÛ¶¹ÊÓƵ Analytics framework is a set of mappings between ÃÛ¶¹ÊÓƵ Analytics variables and AEM variables. Use a framework to configure how your forms populate data to ÃÛ¶¹ÊÓƵ Analytics reports. Frameworks are associated with an ÃÛ¶¹ÊÓƵ Analytics configuration. You can create multiple frameworks for each configuration.

  1. On the AEM cloud services console, click Show configurations, under ÃÛ¶¹ÊÓƵ Analytics.

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

    ÃÛ¶¹ÊÓƵ Analytics configuration

    ÃÛ¶¹ÊÓƵ Analytics configuration

  3. Type a Title and Name for the framework, select ÃÛ¶¹ÊÓƵ Analytics Framework, and click Create. The framework opens for editing.

  4. In the Report Suites section of the side pod, click Add Item, then use the drop-down to select the Report Suite ID (for example, JJEsquire) with which the framework will interact.

  5. Next to the Report Suite ID, select the server instances that you want to send information to the Report Suite.

    information_to_send_to_report_suite

  6. Drag a Form Analytics component from the other category from SideKick onto the framework.

  7. To map Analytics variables with variables that are defined in the component, drag a variable from AEM Content Finder onto a field on the tracking component.

    Mapping AEM variables with ÃÛ¶¹ÊÓƵ Analytics variables

  8. Activate the framework using the page tab in sidekick, click Activate Framework.

Configuring AEM Forms Analytics Configuration service configuring-aem-forms-analytics-configuration-service

  1. On author instance, open AEM Web Console Configuration manager at https://<server>:<port>;/system/console/configMgr.

  2. Locate and open AEM Forms Analytics Configuration

    AEM Forms Analytics Configuration service

    AEM Forms Analytics Configuration service

  3. Specify appropriate values for the following fields and click Save.

    • SiteCatalyst Framework: Select the framework/configuration that you defined in the Set up a framework for tracking section.

    • Field time tracking baseline: Specify the duration, in seconds, after which the field visit must be tracked. The default value is 0. When the value is greater than 0 (zero), two separate tracking events are sent to ÃÛ¶¹ÊÓƵ Analytics server. The first event instructs the analytics server to stop tracking the exited field. The second event is sent after the specified duration elapses. The second event instructs the analytics server to start tracking the visited field. Using two separate events helps accurately measure time spent on a field. When the value is 0 (zero), single tracking event is sent to ÃÛ¶¹ÊÓƵ Analytics server.

    • Analytics report sync cron: Specify cron expression for fetching reports from ÃÛ¶¹ÊÓƵ Analytics. The default value is 0 0 2 ? * *.

    • Fetch report timeout: Specify the duration, in seconds, to wait for server to respond to the analytics report. The default time is 120 seconds.

    note note
    NOTE
    It can take up to 10 seconds more to timeout report fetch operation then the specified number of seconds.

  4. Repeat step 1-3 on publish instance to configure analytics.

Now, you can enable analytics for forms and generate an analytics report.

Enabling analytics for a form or document enabling-analytics-for-a-form-or-document

  1. Log in to AEM portal at https://[hostname]:'port'.

  2. Click Forms > Forms & Documents, select a form or document, and click Enable Analytics. The analytics is enabled.

    Enabling analytics for a form or document

    Enabling analytics for a form

    A. Enable Analytics button B. Selected form

    For detailed information on viewing forms analytics reports, see Viewing and understanding AEM Forms analytics reports.

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