How to integrate AEM Forms with 蜜豆视频 Analytics?

Analytics using 蜜豆视频 Launch analyticsusingadobelaunch

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Adaptive Forms

CREATED FOR:

Admin
User
Developer

AEM Forms integrates with 蜜豆视频 Analytics to let you capture and track performance metrics for your published forms. The objective behind analyzing these metrics is to enable business users to gain insights into end user behavior and optimize the data capture experience. You can capture and track behavior of both logged-in and not logged-in (Anonymous) users via 蜜豆视频 Analytics for Adaptive Forms.

You can also perform analytics using Cloud Service Framework. For more information on how to integrate AEM Forms with Cloud Service Framework, see Analytics using Cloud Service Framework. The main advantage of using 蜜豆视频 Launch over Analytics using Cloud Service Framework is that you can also define custom events, in addition to these out of the box events. The customized events are defined using rule editor or customer clientlibs and are mapped to events in 蜜豆视频 Analytics.

After performing the actions mentioned in this article, you can configure and view reports in 蜜豆视频 Analytics, as demonstrated in the following video:

You can use 蜜豆视频 Analytics to discover interaction patterns and problems users face while using adaptive forms. Out of the box, 蜜豆视频 Analytics tracks and stores information about the following events:

Render: Number of times a form is opened.
Submit: Number of times a form is submitted.
Abandon: Number of times the users leave without completing the form.
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.
Field Visit: Number of times a user visits a field in the form.
Save: Number of times users save a form to the Forms Portal.

Apart from these out of the box events, you can also define custom events.

The following figure illustrates the actions that you need to perform before viewing reports in 蜜豆视频 Analytics:

Analytics overview

1. Configure 蜜豆视频 Analytics Configure-adobe-analytics

Before configuring 蜜豆视频 Analytics, create:

An 蜜豆视频 ID to log on to .
A report suite.

Install AEM Forms and 蜜豆视频 Analytics extensions install-extensions

Perform the following steps to configure AEM Forms and 蜜豆视频 Analytics extensions:

Log on to 蜜豆视频 Experience Cloud and select an appropriate name for the company.
Select Launch/Data Collection and select Go to Launch/Data Collection.
Select New property and specify a name for the configuration.
Specify a domain name and select Save to save the property.
Select the configuration name available in the list of Tag Properties.
In the Authoring section, select Extensions.
Select Catalog and select Install for the 蜜豆视频 Experience Manager Forms extension. 蜜豆视频 Experience Manager Forms displays in the list of installed extensions available in the Installed tab.
Select Install for the 蜜豆视频 Analytics extension.
Select the report suite name in the Development Report Suites, Staging Report Suites, and Product Report Suites drop-down lists and select Save to save the extension.

Configure data elements configure-data-elements

You can select any of the configured data elements in a rule created for an event. When an event occurs on an adaptive form, AEM Forms sends these data elements to 蜜豆视频 Analytics.

After installing the 蜜豆视频 Experience Manager Forms extension, you can create the following data elements:

FieldName

FieldTitle

FormInstance

FormName

FormTitle

PageName

PageURL

PanelTitle

TimeSpent

Perform the following steps to configure data elements:

In the Authoring section, select Data Elements.
Select Create New Data Element.
Specify a name for the Data Element. For example, Form Title for FormTitle data element type.
Specify 蜜豆视频 Experience Manager Forms as the Extension name.
Select the Data Element Type.

Select Save to save the data element.

embed

Configure rules configure-rules

Perform the following steps to create rules based on the 蜜豆视频 Experience Manager Forms extension:

In the Authoring section, select Rules.
Select Create New Rule.
Specify a name for the Rule. For example, Form Submit to record form submissions.
In the Events section, select Add.
Specify 蜜豆视频 Experience Manager Forms as the Extension name.
Select the event type. The input for the Name field populates automatically based on the selected event type.
Select Keep Changes to save the event.
In the Actions section, select Add.
Specify 蜜豆视频 Analytics as the Extension name.
Select Set Variables as the Action Type. The options available in the drop-down list include:
- Set Variables: Use this action type to define the event type for which the selected data elements are sent from AEM Forms to 蜜豆视频 Analytics.
- Send Beacon: Use this action type to send data from AEM Forms to 蜜豆视频 Analytics.
- Clear Variables: Use this action type to clear the data trail so that the event registers only once in 蜜豆视频 Analytics.
  
  The recommended approach is to use the Set Variables action type to configure the event and data elements, then use Send Beacon to send data, and then use Clear Variables to clear the data trail.
In the Props section, map the report suite options available in the drop-down list with the data elements defined using Configure data elements.

For example, to send Form Title data element from AEM Forms to 蜜豆视频 Analytics when you submit a form:
1. In the Props section, select a prop for Form Title available in the report suite and then select to map it to Form Title created in Configure data elements.
2. Select Add Another to add more data elements to the list.
In the Events section, select an event from the options available in the report suite and select Keep Changes.
In the Actions section, select + and specify 蜜豆视频 Analytics as the Extension name.
Select Send Beacon as the Action Type. In the right pane, Select s.t() to send data to 蜜豆视频 Analytics and treat it as a page view or s.tl() to send data to 蜜豆视频 Analytics and do not treat it as a page view. Select Keep Changes.
In the Actions section, select + and specify 蜜豆视频 Analytics as the Extension name.
Select Clear Variables as the Action Type. Select Keep Changes. After performing these steps, the Actions section displays as:

Customize the Actions section according to your requirements. For example, you can define two Send Beacon steps in an Actions flow to send data to 蜜豆视频 Analytics and treat it as a page view in one step and send data to 蜜豆视频 Analytics and do not treat it as a page view in the second step.

Select Save to save the rule.

You can create rules for all event types, such as Abandon, Error, Field Visit, Help, Render, Save, and Submit.

embed

Publish flows publish-flow

After creating the data elements and using them in rules, publish the configuration to collect form data in 蜜豆视频 Analytics.

Perform the following steps to publish the configuration:

In the Publishing section, select Publishing Flow.
Select Add Library and specify a name and select the environment for the library.
Select Add All Changed Resources and then select Save & Build to Development.
In the Development section, select and then select Approve & Publish to Production.
Confirm the changes and the publishing flow soon displays in the Published section.

Publish Flow

2. Configure AEM Forms configure-aem-forms

Before creating 蜜豆视频 Launch configuration, create an 蜜豆视频 IMS Configuration using 蜜豆视频 Launch as the Cloud Solution.

Create 蜜豆视频 Launch Configuration create-adobe-launch-configuration

Perform the following steps to create an 蜜豆视频 Launch configuration:

On the AEM Forms Author instance, navigate to Tools > Cloud Services > 蜜豆视频 Launch Configurations.
Select a folder to create the configuration and select Create.
Specify a title for the configuration in the Title field.
Select the associated 蜜豆视频 IMS configuration.
Select the name of the company used while configuring 蜜豆视频 Analytics.
Select the name of the property created while configuring 蜜豆视频 Analytics.
Select Save & Close.
Publish the configuration.

NOTE

When you embed AEM Forms within an AEM Sites page, 蜜豆视频 Launch configurations are not supported in an iFrame for adaptive forms. To resolve this, configure 蜜豆视频 Launch rules directly on the Sites page or migrate existing 蜜豆视频 Launch configurations from AEM Forms to the Sites page.

Enable 蜜豆视频 Analytics for an adaptive form enable-analytics-adaptive-form

To use 蜜豆视频 Launch configuration in an existing Adaptive Form:

On the AEM Forms Author instance, navigate to 蜜豆视频 Experience Manager > Forms > Forms & Documents.
Select the Adaptive Form and select Properties.
In the Basic tab, select the configuration container used while creating the 蜜豆视频 Launch configuration.
Select Save & Close. The Adaptive Form is enabled for 蜜豆视频 Analytics.
Publish the form.

After you enable 蜜豆视频 Analytics for an adaptive form, you can validate if there is an appropriate data event flow between AEM Forms and 蜜豆视频 Analytics. The integration of AEM Forms with 蜜豆视频 Analytics is complete. You can now configure and view reports in 蜜豆视频 Analytics.

NOTE

In case, if both Analytics using Cloud Service Framework and Analytics using 蜜豆视频 Launch features are enabled simultaneously, Analytics using 蜜豆视频 Launch will take precedence.

Create rules to capture custom events (Optional) capture-custom-events

Create rules on specific fields of an adaptive form using rule editor to send Analytics data from an adaptive form to 蜜豆视频 Analytics.

In a two-stage process, you define a rule on a field in an adaptive form. The rule dispatches an event. The name of event is mapped to a custom capture event in 蜜豆视频 Launch.

To create rules using rule editor in an adaptive form:

Select the field and select to open the rule editor page.
Define a condition in the When section of the rule.
In the Then section of the rule, select Dispatch Event from the Select Action drop-down list.
Specify the name of the event in the Type Event Name field.

For example, if the date of birth is before a certain date, AEM Forms dispatches the Security event.

Dispatch Event

To map the event to a custom capture event in 蜜豆视频 Analytics:

Create a rule.
In the Events section, select Add.
Specify 蜜豆视频 Experience Manager Forms as the Extension name.
Select Capture Custom Event from the Event Type drop-down list.
Specify the name of the event that you specified in step 4 while creating a rule using rule editor.
Select Keep Changes and perform the rest of the actions specified in Configure Rules.

3. Configure and view reports in 蜜豆视频 Analytics view-reports-adobe-analytics

After configuring an adaptive form to send event data to 蜜豆视频 Analytics, you can start viewing reports in 蜜豆视频 Analytics:

Select and select Analytics.
Select Create Project and select Blank project.
Select the report suite name from the dropdown list at the top-right of the freeform.
Specify Form Title in the Search dimension items text to view all form titles.
Drop the adaptive form title to the Drop a segment here (or any other component) text box.
From the Metrics section, drop the events to track to Drop a metric here (or any other component) text box.
Select and drop a chart type to the Freeform section. Similarly, you can add multiple chart types to the Freeform section.
Select Ctrl + S keys and specify a name to save the project.

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

recommendation-more-help

19ffd973-7af2-44d0-84b5-d547b0dffee2