Spryker analytics

_config.yml

@@ -148,6 +148,7 @@ versioned_categories:
   pbc:
     all:
       - back-office
+      - business-intelligence
       - cart-and-checkout
       - carrier-management
       - content-management-system

_data/sidebars/pbc_all_sidebar.yml

@@ -35,6 +35,21 @@ entries:
                     url: /docs/pbc/all/back-office/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html
 
 
+      - title: Business Intelligence
+        url: /docs/pbc/all/business-intelligence/business-intelligence.html
+        include_versions:
+        - "202410.0"
+        nested:
+          - title: Amazon QuickSight third-party integration
+            url: /docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/amazon-quicksight.html
+            nested:
+              - title: Set up Amazon QuickSight
+                url: /docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/set-up-amazon-quicksight.html
+              - title: "Best practices: Analyzing shop data"
+                url: /docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/best-practices-analyzing-shop-data.html
+              - title: Refresh analytics datasets
+                url: /docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/back-office-refresh-analytics-datasets.html
+
       - title: Carrier Management
         url: /docs/pbc/all/carrier-management/carrier-management.html
         nested:
@@ -1231,7 +1246,7 @@ entries:
               - title: Import stores
                 url: /docs/pbc/all/dynamic-multistore/base-shop/import-stores.html
                 include_versions:
-                - "202410.0"  
+                - "202410.0"
 
           - title: Marketplace
             nested:
@@ -1572,7 +1587,7 @@ entries:
                       - title: View merchants
                         url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants/view-merchants.html
                         include_versions:
-                        - "202410.0"                        
+                        - "202410.0"
 
                   - title: Manage merchant users
                     nested:

docs/pbc/all/business-intelligence/202410.0/amazon-quicksight-third-party-integration/amazon-quicksight.md

@@ -0,0 +1,118 @@
+---
+title: Amazon QuickSight
+description: Amazon QuickSight overview
+template: concept-topic-template
+last_updated: Oct 24, 2024
+---
+
+Amazon QuickSight brings customizable and powerful business intelligence tools to the Back Office.
+
+## Data sources and data sets
+
+This feature supports data from Spryker projects and third-party systems. When you set up Amazon QuickSight, the data from your project is available by default, and you can add other data sources if needed.
+
+![QuickSight-datasets](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/amazon-quicksight.md/qs-data-sets.png)
+
+For more details on data sources, see [Supported data sources](https://docs.aws.amazon.com/quicksight/latest/user/supported-data-sources.html).
+
+### Extending project data for analytics
+
+By looking at datasets, you can see what data from your project is available for adding to analytics. By default, for each dataset, only the data that can be useful for analytics is available from a respective database table. For example, the Customer dataset doesn't include customer passwords.
+
+You can extend the data available to datasets on the project level. For more details, see [Install Amazon QuickSight]().
+
+
+
+### Refreshing data
+
+To make datasets up to date, you need to refresh them by resyncing data from your project or third-party systems.
+
+You can refresh data manually or automatically by setting up a schedule per data set.
+
+
+![refresh-dataset](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/amazon-quicksight.md/refresh-dataset.png)
+
+For instructions, see [Refresh analytics datasets](/docs/pbc/all/business-intelligence/202410.0/amazon-quicksight-third-party-integration/back-office-refresh-analytics-datasets.html).
+
+
+
+
+## User management and permissions
+
+
+When working with analytics, users can have the following roles:
+* Author: can view, create, and edit assets.
+* Reader: can view assets.
+
+<!--
+To give a Back Office user access to analytics, you need to assign one of these roles to them. For instructions, see [Create users]() and [Edit users]().
+
+-->
+
+The analytics roles are derived from Amazon QuickSight and are separate from the [Back Office user roles](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html).
+
+
+## Analyses and dashboards
+
+In Amazon QuickSight, you are going to work with analyses and dashboards.
+
+An analysis is a customizable visual representation of data. Using the provided tools, you can manipulate your data to extract and present the most important information.
+
+Each analysis can contain multiple data visualizations, which can be rearranged and customized.
+
+
+![QuickSight-analyses](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/amazon-quicksight.md/qs-analysis.png)
+
+
+A dashboard is a representation of data prepared in an analysis. It serves as a published version of data analysis, which can be shared with other users.
+
+![QuickSight-dashboard](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/amazon-quicksight.md/qs-dashboard.png)
+
+
+Both analyses and dashboards are shareable, you can share a complete dashboard or collaborate on an analysis.
+
+![QuickSight-sharing](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/amazon-quicksight.md/qs-sharing.png)
+
+You can share dashboards with authors and readers, and analyses – only with authors.
+
+### Default dashboards
+
+For those new to Amazon QuickSight analytics, while you're learning how to create your own dashboards, you can start using the default dashboards right away.
+
+The feature is shipped with the following dashboards.
+
+#### Sales dashboard
+
+* Track sales performance over time
+* Gain insights into orders and return rate
+* Monitor discounts, product categories, brands
+* Monitor the usage of payment and shipping methods
+
+#### Products dashboard
+
+* Track performance of products
+* Monitor availability and returns
+* Analyze top-selling items, category distribution, and trends in shopping lists and customer carts
+
+
+#### Customers dashboard
+
+Track the following customer metrics:
+* Order number and value
+* Registration trends
+* Locations
+* Demographics
+
+
+#### Marketplace dashboard
+* Track marketplace performance with insights into merchant status and commission
+* Get an overview of merchant orders, products, and offers
+
+
+
+## Resetting analytics
+
+
+Sometimes you might want to start from scratch and get a fresh analytics account. Resetting analytics removes all assets and returns your account to the default state.
+
+![reset-analytics](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/amazon-quicksight.md/reset-analytics.png)

docs/pbc/all/business-intelligence/202410.0/amazon-quicksight-third-party-integration/back-office-refresh-analytics-datasets.md

@@ -0,0 +1,40 @@
+---
+title: "Back Office: Refresh analytics datasets"
+description: Learn how to refresh analytics datasets in the Back Office.
+last_updated: Oct 24, 2024
+template: back-office-user-guide-template
+related:
+---
+
+This document describes how to refresh datasets manually and on a schedule.
+
+
+## Refresh an analytics dataset
+
+1. In the Back Office, go to **Analytics**.
+2. On the **Analytics** page, go to **Datasets**.
+  This opens the **Datasets** section.
+3. Click the dataset you want to refresh data for.
+   This opens the dataset's details.
+4. Click the **Refresh** tab.
+5. Click **REFRESH NOW**.
+6. In the **Refresh type** window, select **Full refresh**.
+7. In the **Confirm refresh** window, click **REFRESH**
+  This refreshes the page. A new refresh entry is displayed in the **History** pane. You can check the status of the refresh in the **Status** column.
+
+
+## Set up a schedule to refresh an analytics data set automatically
+
+1. In the Back Office, go to **Analytics**.
+2. On the **Analytics** page, go to **Datasets**.
+3. Click the dataset you want to refresh data for.
+   This opens the dataset's details.
+4. Click the **Refresh** tab.
+5. Click the **ADD NEW SCHEDULE** button.
+6. In the **Create a refresh schedule** window, select **Full refresh**.
+7. For **Time zone**, select a time zone according to which you want to set up a schedule.
+8. For **Start time**, choose a date and time to start refreshing the dataset.
+9. For **Frequency**, select how often you want to refresh the dataset.
+10. If you selected **Weekly** or **Monthly** in the previous step, for **Refresh on**, select a day to refresh the dataset on.
+11. Click **Save**.
+  This closes the window and displays the added refresh schedule in the **Schedules** pane.

docs/pbc/all/business-intelligence/202410.0/amazon-quicksight-third-party-integration/best-practices-analyzing-shop-data.md

@@ -0,0 +1,158 @@
+---
+title: "Best practices: Analyzing shop data"
+description: Learn how to analyze and present shop data.
+last_updated: Oct 24, 2024
+template: back-office-user-guide-template
+related:
+---
+
+Amazon Quicksight is a powerful business intelligence tool. It's highly customizable and has a lot of tools that can't be covered in one document. This document describes a typical use case and how you can start working with analytics, but doesn't cover all the editing options.
+
+For more insights into creating analyses and dashboards, see [Author Workshop](https://catalog.workshops.aws/quicksight/en-US/author-workshop).
+
+## Prerequisites
+
+[Set up Amazon QuickSight](/docs/pbc/all/business-intelligence/202410.0/amazon-quicksight-third-party-integration/set-up-amazon-quicksight.html)
+
+
+## Optional: Back up the default analysis
+
+The Analytics feature is shipped with a default analysis that can be useful while you're learning how to create your own. If you need to play around with the existing analysis, we recommend duplicating the default one as follows:
+
+1. In the Back Office, go to **Analytics**.
+2. On the **Analytics** page, click **Analyses**.
+3. Click on **MASTER Analysis**.
+4. On the page of the analysis, click **File**>**Save as Analysis**.
+5. In the **Save a copy** window, enter an **Analysis name**.
+6. Click **SAVE**.
+  This duplicates the analysis and opens it. Now you can safely play around with this duplicate or the original analysis.  
+
+
+
+## Refresh data
+
+In this example, you're going to create an analysis with product availability data. Because availability is constantly changing, it's important for data to be up to date.
+
+To refresh product related datasets, do the following:
+1. On the **Analytics** page, go to **Datasets**.
+2. In the **Datasets** section, click on the **Product Concrete Availability** dataset.
+  This opens the dataset's details.
+3. Click the **Refresh** tab.
+4. Click **REFRESH NOW**.
+5. In the **Refresh type** window, select **Full refresh**.
+6. In the **Confirm refresh** window, click **REFRESH**
+  This refreshes the page. A new refresh entry is displayed in the **History** pane. You can check the status of the refresh in the **Status** column.
+7. To go back to the list of datasets, cilck **< Datasets**.
+8. Repeat steps 2-7 for all the other product datasets, like **Product Concrete + Store**
+
+Now the data is fresh and you can use it to create an anlysis.
+
+
+## Create an analysis
+
+Analysis is basically a visualization of data in your datasets. To create one, follow the steps:
+
+1. On the **Analytics** page, go to **Analyses**.
+2. In the **Analyses** section, click **New analysis**.
+3. In the **Your Datasets** section, click on the **Order Totals (Custom SQL)** dataset.
+  This opens the dataset's details.
+4. Click **USE IN ANALYSIS**.
+  This creates an analysis called **Order Totals (Custom SQL)** with one visual.
+
+### Edit the visual
+
+In this example, you're going to create a product availability visual:
+
+1. To select the visual, click on it.
+2. In the **Data** pane, click on **Availability**.
+  This highlights the field and adds its data to the visual.
+3. In **Visuals** select the pie chart.
+  This shows the data as a pie chart.
+
+![concrete-product-availability](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/best-practices-analyzing-shop-data.md/concrete-product-availability.png)
+
+
+### Add one more visual
+
+1. Go to **Data** > **Add Dataset**.
+2. In the **Choose dataset to add** window, click on **Category + Localized Product Abstract**.
+3. Click **Select**
+  This shows a success message and the **Datasets in this analysis** window. Click **Close** to close the window.
+4. In the **Visuals** pane, click **+ADD**.
+This adds an empty visual to the sheet.
+5. Click on the visual you've added.
+6. In the **Data** pane, for **Dataset**, select **Category + Localized Product Abstract**.
+7. Add the **name[spy_category_attribute]** as a dimension to the **Y AXIS** section.
+8. Add the **sku** field as a measure to the **VALUE** field.
+
+![product-per-category](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/best-practices-analyzing-shop-data.md/product-per-category.png)
+
+9. Name of the visual is inherited from the fields you've added. To make it presentable, double-click the name.
+10. In the **Edit title** window, enter a name for the visual. For example, `Products per category`.
+11. To apply the change, click **Save**.
+
+This closes the the window and the new name of the visual is displayed.
+
+Now you know how to add data and format it in different ways. For more information on how to create analyses, see [Author Workshop](https://catalog.workshops.aws/quicksight/en-US/author-workshop).
+
+
+## Add filters
+
+1. In the toolbar, click the filter button.
+
+2. In the **Filters** pane, click **+ ADD** and select **store**.
+  This adds the filter to the pane.
+3. To edit the filter, click on it.
+4. To apply the filter to all the visual in the sheet, for **Applied to**, select **Single sheet**.
+5. To add filter controls, click the three dots next to the filter and select **Add control**>**Top of this sheet**.
+  This adds the filter controls to the top of the sheet.
+
+![store-filter](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/best-practices-analyzing-shop-data.md/store-filter.png)  
+
+
+## Share the analysis
+
+If you want another author to collaborate with you on the analysis, you can share it.
+
+To share an analysis, follow the steps:
+
+1. On the page of the analysis, go to **File** > **Share**.
+2. In the **Share analysis**, enter and select the email address of the author to share the analysis with.
+  This displays the user in the table.
+3. Repeat the previous step until you've added all the authors you want to share the analysis with.
+4. Click **Share**
+  This closes the window. The added users can now edit the analysis.
+
+{% info_block infoBox "Manage permissions" %}
+
+You can check and manage permissions of all users to an analysis in **File**>**Share**>**Manage analysis permissions**.
+
+{% endinfo_block %}
+
+
+
+
+## Publish analysis as a dashboard and share
+
+Most of your analytics users will have view permissions. When you're ready to share the analysis with a wider audience, you need to publish it as a dashboard. Users with view permissions can access only dashboards.
+
+To publish and share a dashboard, follow the steps:
+
+1. To publish a dashboard, on the page of an analysis click **PUBLISH**.
+2. For **Publish new dashboard as**, enter a name for the dashboard.
+3. To confirm, click **Publish dashboard**.
+  This publisher the dashboard and opens its page.
+
+![published-dashboard](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/business-intelligence/amazon-quicksight-third-party-integration/best-practices-analyzing-shop-data.md/published-dashboard.png)
+
+4. To share the dashboard, in the top-right corner, click the share icon and select **Share dashboard**.
+  This opens the **Share dashboard** page.
+5. In the **Invite users and groups to dashboard** pane, start entering the email address of a user.
+  This shows users with matching email addresses as you're typing.
+6. Next to the needed user, click **ADD** and select the permissions to assign to them.
+  This shows the user in the **Manage permissions** pane with the permissions you've assigned.
+
+
+## Conclusion
+
+In this guide, you've followed a typical user journey of creating, collaborating, and presenting data in a meaningful way. Now you can play around with these tools or learn by following [Author Workshop](https://catalog.workshops.aws/quicksight/en-US/author-workshop).