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

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

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.

Prerequisites

Settings Creation and Editing Mutations

Overriding the default manifest

Steps

Fluent Analytics Enablement Process

Fluent Analytics requires enablement by Fluent Expert Services before dashboards and metric tiles are available. Contact your Customer Success Representative or Expert Services consultant to initiate this process.

Note

The Fluent Analytics Dashboards Reference Solution is available and can be easily added to a Fluent web app and further customized by configuring the manifest. The steps outlined below are required to make the reference solution functional, but they may vary depending on your specific implementation.If you have modified the base manifests for the Fluent web apps (e.g., `fc.mystique.manifest.oms`), you can include the Fluent Analytics fragment by using the setting name `fc.mystique.manifest.oms.fragment.dashboard.analytics`.

Enable 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}

Add 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

Configure 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.

Configure Analytics Query Settings

The following settings provide a number of available Analytics Queries for each dashboard:

`fc.analytics.queries.orders` - Provides a list of available order metric queries.
`fc.analytics.queries.fulfilments` - Provides a list of available fulfillment metric queries.
`fc.analytics.queries.inventory` - Provides a list of available inventory metric queries.
`fc.analytics.queries.returns` - Provides a list of available return metric queries.

For more details see Analytics Query Settings.

Configure 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}

Analytic 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.

Important Note

Manifest parameters override query definition parameters. Query configurations apply globally across all usage instances.

Related content

Analytics Query Structure

Edited 132 days ago

This document defines the structure and syntax for querying the Fluent Analytics backend services. Analytics Queries reference pre-configured metrics by name (called "targets"), rather than defining individual fields like standard GraphQL queries. Targets provide controlled access to analytics metrics with built-in role-based permissions. Use this document to:

Understand and construct analytics GraphQL queries
Understand target name format and how it links to query settings
Configure filter parameters to refine query results
Integrate analytics into dashboards and web applications

Analytics: Roles & Permissions

Edited 132 days ago

Access to Fluent Analytics is controlled through a combination of permissions and role-based access control (RBAC). This document defines the permission model, role requirements, and configuration patterns for access to Fluent Analytics.Access to Fluent Analytics is controlled through a two-layer model: users must be assigned a role that

has the `ANALYTICS_VIEW` permission AND
is listed in the Analytics Query definition.

Analytics Visualisation Component

Edited 132 days ago

The Analytics Visualisation Component displays a single analytics query result from the Fluent Analytics Backend. It renders metric tiles and visualizations based on configured Analytics Queries settings.Depending the configuration, this component can be placed standalone on a page, where it will make its own GraphQL query, or it can also read data from the page level query. This is useful when analytics data is the main content on the page.

Analytics: Filtering Analytics Queries by Status

Edited 132 days ago

Analytic Query Configurations

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"`).

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...

Important Note

Manifest parameters override query definition parameters. Query configurations apply globally across all usage instances.

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

Key Points

Prerequisites

Settings Creation and Editing Mutations

Overriding the default manifest

Steps

Enable the Analytics Plugin

Add the Analytics Dashboard Manifest

Configure Default Filter Options

Configure Analytics Query Settings

Configure User Roles & Permissions

Analytic Query Configurations

Related content

Analytics Query Structure

Analytics: Roles & Permissions

Analytics Visualisation Component

Analytics: Filtering Analytics Queries by Status

Holger Lierse

Building Blocks

By Type

Helpful Resources

Quick Links

Enable the Analytics Plugin

Add the Analytics Dashboard Manifest

Configure Default Filter Options

Configure Analytics Query Settings

Configure User Roles & Permissions

Analytic Query Configurations