Fluent Commerce Logo
Docs

Configuring the Fluent Analytics Dashboards: A Step-by-Step Guide

How-to Guide

Author:

Holger Lierse

Changed on:

16 Jan 2026

Key Points

  • The Fluent Analytics dashboards deliver real-time visibility across orders, inventory, fulfillments, and returns domains. Embedded dashboards and metric tiles can be surfaced contextually in Fluent Web Apps to provide insight where business decisions are made.
  • To configure its full functionality, you need to create multiple settings that define default filter values, as well as Analytic Queries linked to the corresponding metric tiles.
  • This guide will walk you through the configuration steps using examples from a reference solution. Note that the parameters, such as the statuses of these examples, may differ from your specific implementation requirements.

Steps

Step arrow right iconEnable the Analytics Plugin

To enable Fluent Analytics in your Fluent Web App, the analytics plugin must be added to the base web app manifest.Add the following to your web app manifest:
1{
2  "src": "/_plugins/analytics",
3  "type": "url"
4}

Step arrow right iconAdd the Analytics Dashboard Manifest

The reference analytics manifest fragment provides the dashboard structure and components.--> Get the Fluent Analytics Dashboards Reference ManifestIntegration steps:
  • Review the reference manifest at the URL above
  • Customize the manifest as needed for your implementation
  • Add it to your base web app manifest using the appropriate reference method

Step arrow right iconConfigure Default Filter Options

Use the settings `fc.analytics.sources.ordertypes`, `fc.analytics.returnordertypes` and `fc.analytics.sources.timezones` to associate filter options with order and return order type used within the solution and define the applicable timezones. 

Step arrow right iconConfigure Analytics Query Settings

The following settings provide a number of available Analytics Queries for each dashboard:For more details see Analytics Query Settings.

Step arrow right iconConfigure User Roles & Permissions

Access to individual analytics queries can be restricted by defining specific `roles`. Furthermore, any role that accesses analytics must have the `ANALYTICS_VIEW` permission assigned to it.This means for a user to be able to view a metric, the following conditions must be met:
  • The user must have assigned one of the defined `roles` for the query, and
  • The role must have the `ANALYTICS_VIEW` permission assigned
For further details see Analytics Roles & PermissionsThe reference Fluent Analytics queries for each dashboard are configured with the following roles in the corresponding analytic query setting:
  • Order queries: `ORDER_MANAGER`
  • Fulfilment queries: `FULFILMENT_MANAGER`
  • Inventory queries: `INVENTORY_MANAGER`
  • Return queries: `RETURNS_MANAGER`
Analytics Query Example
1{
2  "name": "total_revenue",
3  "resource": {
4    "type": "PATH",
5    "value": "Standard Template/Dashboards/Orders/Total Revenue"
6  },
7  "roles": [
8    "ORDER_MANAGER"
9  ],
10  "parameters": [
11    {
12      "name": "order.status",
13      "value": ["booked"]
14    }
15  ]
16}

Step arrow right iconAnalytic Query Configurations

In addition to the Analytic Query setting, each metric can be configured through the manifest fragment.Example:
For the Total Revenue Metric, if the retailer would like to treat additional order statuses as completed (default: `COMPLETE`), the relevant dashboard fragment must be updated. In the Fluent Analytics manifest fragment this metric is referenced with the name `orders_total_revenue` with the following naming convention:
  • The query group (`orders`) maps to the query setting: `fc.analytics.queries.orders`
  • The query name (`total_revenue`) matches the `name` field in the query definition within the setting (`"name": "total_revenue"`). 
For this example there are 2 options in making the corresponding configuration changes:Option 1 (recommended):
The default status can be overridden by adding and additional parameter to the manifest:
1{
2  "name": "orders_total_revenue",
3  "parameters": [
4    {
5      "key": "order.created_date",
6      "value": [
7        "{{params.orders_created_on}}"
8      ]
9    },
10    {
11      "key": "retailer.ref",
12      "value": [
13        "{{readArrayFromParams 'retailer_ref[]'}}"
14      ]
15    },
16    {
17      "key": "order.type",
18      "value": [
19        "{{params.order_type}}"
20      ]
21    },
22    {
23      "key": "order.status",
24      "value": ["NEW_STATUS", "ANOTHER_NEW_STATUS"]
25    }
26  ]
27}
For more information see Filtering Analytics Queries by Status.Option 2:
The default status can also be overridden by adding and additional parameter to the Analytics Query setting:
1...
2    {
3      "name": "total_revenue",
4      "resource": {
5        "type": "PATH",
6        "value": "Standard Template/Dashboards/Orders/Total Revenue"
7      },
8      "roles": [
9        "ORDER_MANAGER"
10      ],
11      "parameters": [
12        {
13          "name": "order.status", 
14          "value": ["NEW_STATUS", "ANOTHER_NEW_STATUS"]
15        }
16      ]
17    }
18...
Analytics Query parameters can be overridden in the query definition.  To add a parameter to the query definition, specify the field name and effective value under the `parameters` array, as shown above.