Identify Inventory Failed Events

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

How-to Guide

Authors:

Kirill Gaiduk, Holger Lierse, Girish Padmanabha

Changed on:

15 Mar 2024

Key Points

Detect Inventory problems or anomalies with the Total Failures card on the Sources Dashboard.
Identify the specific failure events with advanced filtering on the Events page.
Understand the what, where, and why of the event failure by using the Event Details Drawer.

Prerequisites

Sources Interface

Metrics Overview

Insights

Steps

1. Understand the current state of Inventory Updates.

Navigate to the Sources Dashboard. No alt provided

2. Detect Inventory problems or anomalies.

Monitor the Total Failures card. No alt provided

The Total Failures card value reflects the aggregated Metrics data:

Events with `FAILED` and `NO_MATCH` statuses;
Of the Inventory domain Entity types: `INVENTORY_CATALOGUE`, `INVENTORY_POSITION`, `INVENTORY_QUANTITY`, `VIRTUAL_CATALOGUE`, `VIRTUAL_POSITION`, and `BATCH`;
Excluding data with `internal` source label.

For more details, check the Labels section of the Metrics usage for Platform Observability.

Tip

Use the Page Filter Select dropdown to set a period for the failure number aggregation. No alt provided

Customize the filter periods with How to configure Page Filter Select via Manifest.

3. Identify the specific Inventory failure events.

Click the Total Failures card link, which will redirect to the Events page. No alt provided

The Events Search Results are pre-filtered with:

Event status: `FAILED` & `NO_MATCH`;
Root entity type: `INVENTORY_CATALOGUE` & `VIRTUAL_CATALOGUE`.

Tip

Use available filters with multi-select input to narrow the Events Search Results if needed. For example:Apply the Category filter with `EXCEPTION` & `ERROR` values selected to filter out the events of any other category. No alt provided

Click the SEARCH button to apply the filters selected to the Events Search Results.

4. Identify the events that require deeper analysis.

Inspect the Events Search Results table.

Tip

Customize the Events Search Results columns configuration by overriding the Insights Manifest fragment.See the Configuration example provided in the Events Search Component.

5. Get more information about the specific event.

Click the Event column value link to open the Event Details Drawer. Inspect the DETAILS and CONTEXT sections. No alt provided

6. Understand what, where, and why it happened.

Scroll down to the Event Details Drawer BODY section to inspect the attributes providing the necessary information for the problem understanding and remediation, like:

error `code` (available for `FAILED` events only);
error `message`;
`lastRuleSet`;
`lastRule`;
`entityStatus` (available for `NO_MATCH` events only);
`closeMatches` (available for `NO_MATCH` events only).

Info

`closeMatches` attribute shows all the Rulesets (including Error messages and their Triggers) with the `name` equal to the "target" Ruleset in the following "not-matching-by" order:

`type` (of the entity);
`subType` (of the entity);
`eventType`;
`triggers`.

Explanation through an Example

Failed Events Identification is an initial part of the Inventory Processing monitoring to enable users to identify the specific Inventory Events that have failed and provide visibility into why those events have failed. The following example for Inventory Update (via the customer’s request based on Point Of Sale (POS) data) is intended to serve as a reference for the Inventory Failed Events Identification process.1. The current state of the Inventory Stock-On-Hand is 25 pcs: No alt provided

2. Current state of the recent (last 30 min) Inventory Updates: No alt provided

3. Incorrect Inventory Update customer’s request based on Point Of Sale (POS) data is sent.

1{
2    "retailerId": "3353",
3    "entityRef": "DEFAULT:33533",
4    "name": "InventoryChanged",
5    "entityType": "INVENTORY_CATALOGUE",
6    "rootEntityType": "INVENTORY_CATALOGUE",
7    "rootEntityRef": "DEFAULT:33533",
8    "entitySubtype": "DEFAULT",
9    "type": "NORMAL",
10    "source": "POS",
11    "attributes": {
12        "inventoryPosition": {
13            "retailerId": "3353",
14            "locationRef": "F_1686296685026",
15            "productRef": "AH8050-F_1686296685026-96",
16            "qty": "10"
17        }
18    }
19}

4. The Inventory Update Failure occurred is displayed on the Sources Dashboard: No alt provided

Warning

The state of the Inventory Stock-On-Hand remains unchanged (25 pcs) because of the Inventory Update failure: No alt provided

5. The user is redirected to the pre-filtered Events page on Total Failures link click: No alt provided

6. The Event Details Drawer is opened on Event column link click: No alt provided

Received information analysis

The reason for the failure is identified with the exception message: non-existing Inventory Catalogue.

7. Fixed POS Inventory Update customer’s request is sent.

1{
2    "retailerId": "3353",
3    "entityRef": "DEFAULT:3353",
4    "name": "InventoryChanged",
5    "entityType": "INVENTORY_CATALOGUE",
6    "rootEntityType": "INVENTORY_CATALOGUE",
7    "rootEntityRef": "DEFAULT:3353",
8    "entitySubtype": "DEFAULT",
9    "type": "NORMAL",
10    "source": "POS",
11    "attributes": {
12        "inventoryPosition": {
13            "retailerId": "3353",
14            "locationRef": "F_1686296685026",
15            "productRef": "AH8050-F_1686296685026-96",
16            "qty": "10"
17        }
18    }
19}

8. The Inventory Update is reflected on the Sources Dashboard: No alt provided

9. The Inventory Stock-On-Hand is successfully updated to 10 pcs: No alt provided

The given example is one of the use cases.

The Failed Events Identification is applicable to a wide range of Inventory Observability scenarios. For Example:

Batch Inventory Updates, including the Batch Pre-Processing;
Delta Inventory Updates;
Inventory Updates upon Order reservations, processing, or canceling.

Related artifacts

Page Filter Select Component

Tile Metric Component

Events Search Component

Date Range Field Component

Event Details Drawer Component

Related content

Metrics usage for Platform Observability

Edited 678 days ago

This document is intended to describe to implementers which Metrics are available within the Fluent Big Inventory product and what kind of data they provide to achieve Platform Observability.Pre-requisites:

You should have knowledge of How Metrics works.
You should have knowledge of Events.
You should have knowledge of Fluent APIs.

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

6. Understand what, where, and why it happened.

Scroll down to the Event Details Drawer BODY section to inspect the attributes providing the necessary information for the problem understanding and remediation, like:

error `code` (available for `FAILED` events only);
error `message`;
`lastRuleSet`;
`lastRule`;
`entityStatus` (available for `NO_MATCH` events only);
`closeMatches` (available for `NO_MATCH` events only).

Info

`closeMatches` attribute shows all the Rulesets (including Error messages and their Triggers) with the `name` equal to the "target" Ruleset in the following "not-matching-by" order:

`type` (of the entity);
`subType` (of the entity);
`eventType`;
`triggers`.

Explanation through an Example

2. Current state of the recent (last 30 min) Inventory Updates: No alt provided

3. Incorrect Inventory Update customer’s request based on Point Of Sale (POS) data is sent.

1{
2    "retailerId": "3353",
3    "entityRef": "DEFAULT:33533",
4    "name": "InventoryChanged",
5    "entityType": "INVENTORY_CATALOGUE",
6    "rootEntityType": "INVENTORY_CATALOGUE",
7    "rootEntityRef": "DEFAULT:33533",
8    "entitySubtype": "DEFAULT",
9    "type": "NORMAL",
10    "source": "POS",
11    "attributes": {
12        "inventoryPosition": {
13            "retailerId": "3353",
14            "locationRef": "F_1686296685026",
15            "productRef": "AH8050-F_1686296685026-96",
16            "qty": "10"
17        }
18    }
19}

4. The Inventory Update Failure occurred is displayed on the Sources Dashboard: No alt provided

Warning

The state of the Inventory Stock-On-Hand remains unchanged (25 pcs) because of the Inventory Update failure: No alt provided

5. The user is redirected to the pre-filtered Events page on Total Failures link click: No alt provided

6. The Event Details Drawer is opened on Event column link click: No alt provided

Received information analysis

The reason for the failure is identified with the exception message: non-existing Inventory Catalogue.

7. Fixed POS Inventory Update customer’s request is sent.

1{
2    "retailerId": "3353",
3    "entityRef": "DEFAULT:3353",
4    "name": "InventoryChanged",
5    "entityType": "INVENTORY_CATALOGUE",
6    "rootEntityType": "INVENTORY_CATALOGUE",
7    "rootEntityRef": "DEFAULT:3353",
8    "entitySubtype": "DEFAULT",
9    "type": "NORMAL",
10    "source": "POS",
11    "attributes": {
12        "inventoryPosition": {
13            "retailerId": "3353",
14            "locationRef": "F_1686296685026",
15            "productRef": "AH8050-F_1686296685026-96",
16            "qty": "10"
17        }
18    }
19}

8. The Inventory Update is reflected on the Sources Dashboard: No alt provided

9. The Inventory Stock-On-Hand is successfully updated to 10 pcs: No alt provided

The given example is one of the use cases.

The Failed Events Identification is applicable to a wide range of Inventory Observability scenarios. For Example:

Batch Inventory Updates, including the Batch Pre-Processing;
Delta Inventory Updates;
Inventory Updates upon Order reservations, processing, or canceling.

Identify Inventory Failed Events

Key Points

Prerequisites

Sources Interface

Metrics Overview

Insights

Steps

1. Understand the current state of Inventory Updates.

2. Detect Inventory problems or anomalies.

3. Identify the specific Inventory failure events.

4. Identify the events that require deeper analysis.

5. Get more information about the specific event.

6. Understand what, where, and why it happened.

Explanation through an Example

Related artifacts

Page Filter Select Component

Tile Metric Component

Events Search Component

Date Range Field Component

Event Details Drawer Component

Related content

Metrics usage for Platform Observability

Using the Event API

Log Action & Events

Events

Kirill Gaiduk

Contributors:

Building Blocks

By Type

Helpful Resources

Quick Links

1. Understand the current state of Inventory Updates.

2. Detect Inventory problems or anomalies.

3. Identify the specific Inventory failure events.

4. Identify the events that require deeper analysis.

5. Get more information about the specific event.

6. Understand what, where, and why it happened.

Explanation through an Example