Install the Analytics feature

Last updated:
Edit on GitHub

This document describes how to install the Analytics feature. This feature enables the Back Office UI for Amazon QuickSight.

Prerequisites

Install the required features:

NAME VERSION INSTALLATION GUIDE
Spryker Core 202410.0 Install the Spryker Core feature

1) Install the required modules

Install the required modules using Composer:

composer require spryker-feature/analytics:"202410.0" --update-with-dependencies
Verification

Make sure the following modules have been installed:

MODULE EXPECTED DIRECTORY
AnalyticsGui vendor/spryker/analytics-gui
AnalyticsGuiExtension vendor/spryker/analytics-gui-extension

2) Set up transfer objects

Generate transfer changes:

console transfer:generate
Verification

Make sure the following changes have been applied in transfer objects:

TRANSFER TYPE EVENT PATH
AnalyticsRequest class created src/Generated/Shared/Transfer/AnalyticsRequestTransfer
AnalyticsCollection class created src/Generated/Shared/Transfer/AnalyticsCollectionTransfer
Analytics class created src/Generated/Shared/Transfer/AnalyticsTransfer
AnalyticsAction class created src/Generated/Shared/Transfer/AnalyticsActionTransfer
AnalyticsEmbedUrlResponse class created src/Generated/Shared/Transfer/AnalyticsEmbedUrlResponseTransfer

3) Configure navigation

  1. Add the Analytics section to navigation.xml:

config/Zed/navigation.xml

<?xml version="1.0"?>
<config>
    <analytics>
        <label>Analytics</label>
        <title>Analytics</title>
        <icon>fa-chart-bar</icon>
        <bundle>analytics-gui</bundle>
        <controller>analytics</controller>
        <action>index</action>
    </analytics>
</config>
  1. Build the navigation cache:
console navigation:build-cache
Verification

In the Back Office, make sure the Analytics navigation menu item is displayed.