DocumentationAEMAEM Screens Guide

Adobe Analytics Integration with AEM Screens

Last update: May 8, 2024
  • Topics:
  • Administering Screens

CREATED FOR:

  • Intermediate
  • Admin
  • Developer
CAUTION
This AEM Screens functionality is only available if you have installed minimum version of AEM 6.4.2 Feature Pack 2 or AEM 6.3.3 Feature Pack 4. For AEM Screens Cloud service customers, Contact your Adobe Relationship Manager to enable Adobe Analytics in Screens Cloud.
NOTE
To get access to either of these Feature Packs, contact Adobe Support and request access. You can download the latest Feature Pack for AEM Screens from the Software Distribution Portal using your Adobe ID.

This section covers the following topics:

  • Overview
  • Architectural Details
  • Configuring the Properties

Overview

AEM Screens uses Adobe Analytics, and with that you can achieve something unique in the market - cross-channel analytics that help correlate content shown in location with other data sources.

AEM Screens provides an out of the box integration with Adobe Analytics and provides you with a proof of play.

This section describes the following functionality involved with connecting an AEM Screens project with Adobe Analytics:

  • Allows for proof of play reporting by device
  • Allows for proof of play reporting by asset
  • Ensures that all player events are captured and timestamped
  • Ensures that all player events are stored locally if the play is not connected to a network
  • Feedback loops can be created which track play events over time
  • Lets the system edit content and layouts based on success criteria defined by the Content Author

Adobe Analytics Integration with AEM Screens thus enforces the following goals:

  • Enable ROI from digital signage implementations
  • Integrate Analytics as a foundation for future enablement of gathering and analyzing usage information

Architectural Details

An AEM Screens customer wants to understand what content was shown at what time, and for how long (aggregated). This necessity is a common capability of a signage solution. Instead of building a separate analytics application, AEM Screens uses Adobe Analytics. The combination lets us achieve something unique in the market - cross-channel analytics that help correlate content shown in location with other data sources.

The following architectural diagram explains the Adobe Analytics Integration with AEM Screens:

screen_shot_2018-09-12at85611am

Enabling Adobe Analytics in AEM Screens

The Adobe Analytics settings can be configured from the OSGi console.

Navigate to Adobe Experience Manager Web Console Configuration so you can configure Adobe Analytics for AEM Screens.

screen_shot_2018-09-04at25550pm

Screens Analytics: Enablement Flow

CAUTION
Before you configure the properties, contact your Adobe Relationship Manager to create a ticket to obtain an Analytics API Key and Analytics Project for use with AEM Screens.

Configuring the Properties

CAUTION
Before you configure the properties, contact your Adobe Relationship Manager to create a ticket to obtain an Analytics API Key and Analytics Project for use with AEM Screens.

The following table highlights the properties with their description for configure Adobe Analytics for AEM Screens:

Property
Description
Analytics URL
URL to post analytics data from the player.
For development/stage - https://cc-api-data-stage.adobe.io/ingest/
For Production - https://cc-api-data.adobe.io/ingest/
Analytics API Key
API key to authenticate to the Adobe Analytics server (provided by the Accounts Manager).
Analytics Project
AEM Screens project configured on your analytics to receive data (provided by the Accounts Manager).
Environment
Stage or Production environment (choose either Stage or Production).
Analytics Send Frequency
Frequency in minutes for sending analytics data from the players. By default, it is set to 15 mins.
NOTE
By default, the Analytics Send Frequency is 15 minutes.

Using Adobe Analytics Service in AEM Screens

This scenario invokes the Analytics API through REST calls from an analytics service in the firmware. It also instruments AEM screens-core components to create and send events specific to a particular use case. All this functionality while allowing extensibility where any custom message can be sent to Analytics from a custom-developed channel.

Analytics events are stored offline in indexedDB and later chunked and sent to the cloud.

NOTE
To learn more about the Sequencing and Standard Data Model for Events, see Configuring Adobe Analytics for AEM Screens.
recommendation-more-help
adce462a-f916-4dbe-9ab5-0b62cfb0f053