Analytics Reporting Integration in SGJC

To record Analytics events in SGJC, you must add certain templates to your application. These templates call B2C Commerce processes that capture the data and report on it via the Business Manager user interface.

SGJC uses session IDs to capture web activities for the Analytics data. This approach doesn't distinguish between visits and visitors (unique visits). However, this approach does circumvent the issue with users blocking cookies or not allowing JavaScript and therefore not being counted.

To capture this information, you can include the appropriate reporting template on a page. This template triggers a request to the server (via a URL include statement) with the required parameters.

When you include the reporting template, it triggers a request to the server. The server request is triggered via a URL include statement and provides the required parameters.

Note: B2C Commerce ignores reporting (log) entries that originate from pages that are processed using the RedirectURL-Start pipeline (URL mappings).

Important: Don't use the ReportingEvent-Start pipeline as a pipeline trigger. There are some explicit checks for it in the web adapter, and the requests for that pipeline don't propagate to B2C Commerce. See A/B Test Participation Triggers.

See Analytics.

Reporting Hooks

The following SiteGenesis templates include reporting hooks (SiteGenesis Storefront Core: cartridge/templates/default/util/reporting):

ReportABTesting.isml: collects Analytics on A/B testing (the A/B testing functionality in the Business Manager Analytics Module, not in the Online Marketing > A/B Testing module).
ReportBasket.isml: collects Analytics on the basket.
ReportCheckout.isml: collects Analytics on the checkout process.
ReportOrder.isml: collects Analytics on orders.
ReportSearch.isml: collects Analytics on search results.
ReportSourceCodes.isml: collects Analytics on source codes.
ReportUserRegistration.isml: collects Analytics on the user registration process.

CAUTION:

Don't change the locale in these templates. These templates merely log the information into the Analytics log file. The customer never sees it, and the Analytics module expects en_US.

ReportABTesting.isml

This template must be referenced via an include statement in a template that renders the result of the test segmentation or alternate page. For example:

<isinclude template="util/reporting/ReportABTesting.isml"/>.

Variables are passed in the SiteGensis application to the ReportingEvent-Start.xml pipeline that this template expects

ReportBasket.isml

This template, referenced via an include statement, logs events that indicate the creation or use of a basket (cart). For example:

<isinclude template="util/reporting/ReportBasket.isml" />

Use the parameters to collect:

Common cart information
Order promotion information: price adjustments for the entire cart
Shipping promotion information: check all shipments for shipping promotions, line items, and their promotions
Product promotion information: check all product items in the cart

In SiteGenesis, this include statement is in the cart.isml and minicart.isml templates.

ReportCheckout.isml

This template logs a checkout event. It logs the step, depending on the parameters, and expects the step number and name as parameters in the scope of a page. The reporting funnel display uses the step value to show the steps in ascending order. Using the name improves the display. This template can be called using an include statement, for example:

<isinclude template="util/reporting/ReportCheckout.isml"/>

Use the parameters in this template to collect checkout information.

You can give each step a meaningful name for the checkout funnel name by changing the pdict variable checkoutname. You must report the steps in the correct sequence with the checkoutstep variable. For example, if you have three steps in your checkout, they must be reported with the values one, two, and three. If you report with values one, two, and five, the funnel report inserts steps three and four with the same values as in step five.

In SiteGenesis, the modues.isml template references the ReportCheckout.isml template directly. It doesn't use an include statement.

ReportOrder.isml

This template logs the total number of customer orders. This template is called using an include statement. For example:

<isinclude template="util/reporting/ReportOrder.isml"/>

Use the parameters to collect information such as:

Order details
Order price adjustments information
Shipping promotions, line items, and their promotions
Product line item promotion details
Multiple price adjustments
Gift certificate line items
information on gift certificate payment instruments

In SiteGenesis, the include statement is in the confirmation.isml template.

ReportSearch.isml

B2C Commerce determines if the current search request is the initial search request or a secondary search specifying other refinement attributes. B2C Commerce only logs initial searches, not refinements. This template can be called using an include statement. For example:

<isinclude template="util/reporting/ReportSearch.isml"/>

Use the parameters to collect information on initial searches.

In SiteGenesis, the include statement is in the categoryproducthits.isml, foldercontenthits.isml, and nohits.isml templates.

ReportSourceCodes.isml

If a source code exists in the session, B2C Commerce logs the source code. Place this template on every page that can be a redirect result of an incoming source code to the session or visit. You can place this template on every page, or you can include this template as part of the minicart, which is part of every page.

You can call this template with an include statement. For example:

<isinclude template="util/reporting/ReportSourceCodes.isml"/>

Use the parameters to collect information on:

A requested source code
Source code status by name

In SiteGenesis, the include statement is in the ReportBasket.isml, ReportOrder.isml, ReportBasket.isml, and redirect.isml templates.

ReportUserRegistration.isml

B2C Commerce tracks user registration by assigning each iteration of AccountOpen a unique ID. B2C Commerce then counts its occurrence, no matter where it occurs in the storefront, using the parameters listed in the template.

You can call this template with an include statement, for example:

<isinclude template="util/reporting/ReportUserRegistration.isml"/>

In SiteGenesis, the include statement is in the footer.isml templates.