AEM Forms integrates with Adobe Analytics that allows you to 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.
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 Adobe Analytics account and administrator privileges on the AEM instance. For information about the solution, see Adobe Analytics.
You can use Adobe Analytics to discover interaction patterns and problems users face while using adaptive forms, HTML5 forms, or adaptive documents. Out of the box, Adobe 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 Adobe 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.
Analytics data is stored in customer-specific repositories called report suites. To create report suite and use Adobe Analytics, you must have a valid Adobe Marketing Cloud account. Before performing the following steps, ensure that you have a valid Adobe Marketing Cloud account.
Perform the following steps to create a report suite.
- 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.
Navigate to Edit Settings > Conversion > Sucess Events. Define and enable the following success events:
Sucess Event Type abandon Counter render Counter panelVisit Counter fieldVisit Counter save Counter error Counter help Counter submit Counter timeSpent Numeric
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.
Cloud Service configuration is information about your Adobe Analytics account. The configuration enables Adobe Experience Manager (AEM) to connect to Adobe Analytics. Create a separate configuration for each Analytics account that you use.
When the Edit panel opens on the configuration page, fill in the fields:
- Company: Your company's name as featured on Adobe Analytics.
- Username: The name used to log in to Adobe Analytics.
- Password: The Adobe Analytics password for the above account.
- Data Center: The Data Center of your Adobe Analytics account.
An Adobe Analytics framework is a set of mappings between Adobe Analytics variables and AEM variables. Use a framework to configure how your forms populate data to Adobe Analytics reports. Frameworks are associated with an Adobe Analytics configuration. You can create multiple frameworks for each configuration.
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 Adobe 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 Adobe Analytics server.
- Analytics report sync cron: Specify cron expression for fetching reports from Adobe 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.
- heartbeat check time: The heartbeat check time setting is only for adaptive documents. Adobe Analytics session times-out after an inactivity of 30 minutes. The heartbeat check time setting verifies, after an interval of specified seconds, if the adaptive document window or tab is active or not. If the adaptive document window or tab is active at the time of verification, an event is sent to Adobe Analytics server. It keeps the analytics session alive. The default interval is 5 minutes (600 seconds).
- adaptive document field tracking: Disable or enable analytics for the fields of an adaptive document. For example, if the adaptive document has a checkbox to accept an agreement. If you disable the option, the analytics information is not captured for the field of the adaptive form. By default, fields of an adaptive document are not enabled for tracking. The default value is false..
It can take up to 10 seconds more to timeout report fetch operation then the specifed number of seconds.
Click Forms > Forms & Documents, select a form or document, and click Enable Analytics. The analytics is enabled.
A. Enable Analytics button B. Selected form
For detailed information on viewing forms analytics reports, see Viewing and understanding AEM Forms analytics reports