User Interface Framework (WebApps, Manifest Configuration, Fragments, Components, and their Elements.), Orchestration Framework (Workflow, Actions, Rules, Entities, Contracts, Settings, Triggers, Status, and Variables), Developer Tooling (Modules, Templates, Connectors, and SDKs.)
The Responsive Sourcing Framework is a configurable, scalable alternative to custom Workflows and Rules for managing sourcing strategies. You’ll learn how to define and optimize sourcing logic using Sourcing Profiles, Strategies, Conditions, and Criteria. The Framework empowers both technical and business users with faster implementation, greater control, and transparency into how sourcing decisions are made and why.
The Sourcing Profiles functionality in the Fluent OMS Admin interface enables retailers to configure, manage, and optimize sourcing rules. Profiles group strategies with defined priorities, catalogs, and networks, while strategies use flexible conditions (IF) and criteria (THEN) to refine fulfillment logic. New profiles are created via API, while profile versions can be generated either through the Admin UI or API. The UI provides capabilities to view, edit, reorder, activate, and track versions.
`updateProfile`
mutation.The `util-sourcing`
library is a comprehensive collection of utility functions designed to minimize the overhead and complexity of writing sourcing logic in your Fluent Commerce rules.
Prerequisites
These articles assumes you're familiar with:
`SourcingUtils`
): Orchestrates the sourcing process and provides helper methods to load a Sourcing Profile`SourcingContextUtils`
): Loads and manages Sourcing Context `OrderUtils`
): Performs order-specific operations such as fulfillment creation`LocationUtils`
): Provides location-based helpers including distance calculations and cachingFluent Order Management components are Web Apps, Modules, Order Management Experience (OMX), Orchestration Engine, and Cloud Infrastructure. These components operate within the framework to enable the order management experience on the platform.
Fluent Order Management components are Web Apps, Modules, Order Management Experience (OMX), Orchestration Engine, and Cloud Infrastructure. These components operate within the framework to enable the order management experience on the platform.
The Workflow Framework Engine ensures that all Exceptions thrown out of Rules are recorded within the Orchestration Audit Events, accessible via the Event API. This is important for providing detailed information about what went wrong.
The `RuleContextGenerator`
is the underlying class that the `RuleExecutor`
and `WorkflowExecutor`
use to construct a mock `Context`
for your tests. While you will most often interact with it through the executors, you can also use it directly to manually create a `Context`
object.
This is particularly useful when you are unit testing a helper or utility class that requires a `Context`
object as a parameter, but you don't need to execute a full rule.
`RuleContextGenerator`
is the fundamental builder class that the `RuleExecutor`
and `WorkflowExecutor`
use to create the mock `Context`
for your tests.`RuleContextGenerator.of(...)`
) when you need a `Context`
object for testing a helper class or utility method, but don't need to execute a full rule.`getActionsOfType()`
and `getLastActionOfType()`
for verification.This article describes the details of the different events in the Fluent platform and provides the required base knowledge for troubleshooting. This article expects that you have a good understanding of the Fluent Event Execution process and how Events are matched before the corresponding business logic is executed.
In this document we will describe how to work with workflows and workflow fragments using the Fluent CLI. Then delve into how the tool is tracking the installed workflows, fragments in the workflow log.
`workflowlog`
to manage the workflow and fragment lifecycleWorkflows are the backbone of the Fluent platform as they describe the lifecycle of an entity. Defining subsections or sub-processes within a workflow allows to manage and evolve them independently. Thus fostering loosely coupled and self-contained fragments with no duplication of shared or unchanged behavior of a baseline workflow.
On this page we will look at the different ways of structuring workflows into fragments and then how to optimally merge them into a final workflow that is used to orchestrate entities. Finally how to package both workflows and fragments into a module.
`workflows`
before `workflow-fragments`
.The Dispatch Template is a preconfigured UX Template used within the Fluent Store Web App.
The Availability interface provides visibility into fulfilment options generated by the system when evaluating how an order can be completed. Availability ensures that orders are processed in line with business rules, inventory availability, and delivery or collection methods.
The interface contains one submenu: Fulfilment Options. This section provides access to all generated fulfilment options and their related fulfilment plans.
The Fluent OMS Web App's dashboard interface serves as a central hub for monitoring and managing order activity and alerts.
It provides real-time visibility into key operational metrics — such as orders received, escalations, returns, cancellations, and pending actions — enabling quick responses to exceptions.
The dashboard is fully configurable to match business requirements. The numbers displayed represent the total records returned by these queries.
Fluent Order Management components are Web Apps, Modules, Order Management Experience (OMX), Orchestration Engine, and Cloud Infrastructure. These components operate within the framework to enable the order management experience on the platform.
The Feeds interface provides visibility into inventory feeds for an account, enabling monitoring and analysis of feed activity over selected time periods.
It includes:
The Products interface is a collection of products and any attributes and details associated with each product in the category.
The Products interface of the Fluent Web App provides comprehensive capabilities:
The module contains the following configurations:
Rulesets are fundamental components in implementing business flows. They are reusable collections of rules that contain orchestration logic. These functions can be applied across various workflows and use cases, providing flexibility and efficiency. The Order, Inventory, and Fulfilment reference modules contain a set of pre-defined rulesets, each with its corresponding rules.
This document provides comprehensive guidelines and best practices for custom rule development on the Fluent Commerce platform. Following these guidelines ensures your Rules are maintainable, testable, and follow platform conventions.
It is highly recommended that you first read Designing Rules and Writing Custom Rules if you have not done so already.
As a part of Internationalisation, the Fluent platform supports multiple languages. This support allows users of web apps such as OMS Webapp and Fluent Store to configure and view the modules and interfaces of the Fluent platform in their preferred language.
As of the Fluent v4.45 release, the Fluent platform provides pre-configured support for the following languages.
Fluent Order Management uses a default language of Australian English `en-AU`
.
`en-AU`
- Default`en-US`
`fr-FR`
`es-MX`
`it-IT`
The Fluent OMS module is pre-configured with certain standard functions that allow the interface to manage orders, product availability, inventory, and order fulfilment and serve as a starting point for your projects.
The default UX templates are hosted on the platform, so there is no need to create the manifest settings yourself unless you need to customize the existing baseline configuration.
`https://<ACCOUNT_ID>.<ENVIRONMENT>.apps.fluentcommerce.com/oms`
This article contains the list of Settings used in the context of ACCOUNT.
Workflow Framework Rules are written using Java and contain a specific structure and metadata for describing and validating the Rule. In this lesson, you will learn how to write Rules by adding customised business logic.
To guide you through your journey of understanding and learning the Fluent Commerce OMS platform, the documentation is modeled according to the internal building blocks of the system, like 🔀Workflow or ⚙️Settings, with other top-level content types, such as 💡Essential Knowledge and 🧭How-to Guides layered on top of it. Dive right into it by starting here.
This document is intended to introduce the Metrics and describe their place within the Fluent Big Inventory product.
Pre-requisites:
The Order Management Experience (OMX) Design System provides guidelines for delivering a user experience tailored to the Omnichannel Order Management space. This article will describe the foundations of the Design System, including color palette and typography which make up the overarching design theme of the Fluent Commerce platform.
We provide three reference workflows Home Delivery (HD), Click and Collect (CC) and Mixed Baskets. Suppose our reference workflows do not accommodate your business case. In that case, you can create a new Order Workflow to support additional Order Types that require different processing and timing, with such as marketplace orders and back orders
Learn more about supported reference workflows here.
This document is intended to describe to implementers Metrics technical details within the Fluent Big Inventory product.
Pre-requisites:
`metricInstant`
and `metricRange`
GraphQL queries to retrieve the Metrics data.This article explains how to transform manifests v1.0 into the new manifests v2.0. From this guide, you will learn how to configure manifest with necessary menu items, add filters and configure them, and add custom components. The examples below demonstrate the following Fluent OMS menu items:
Learn more about App-Level and Route-Level configuration here.
Differences between Admin Console and Fluent OMS manifests are summarised in the following tables
This guide is intended to provide implementers with information about the Metrics API within the Fluent Big Inventory product, describing its functionalities and utilization principles within the Fluent Platform.
Pre-requisites:
`METRICS_VIEW`
permission for Metrics data access.`metricInstant`
and `metricRange`
GraphQL queries to retrieve the Metrics data.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:
This document will detail how customers can view their Inventory Position Update(IPU) and Inventory Position Change(IPC) usage from within the Inventory Web App. Using this, customers can easily compare their usage to contracted rates.
Pre-requisites
`ACCOUNTUSAGE_VIEW`
permission`ACCOUNTUSAGE_VIEW`
permission in the Fluent Big Inventory Web application.The Fluent Admin Console is a web browser-based portal, for retail business users, that provides the interface to manage orders, product availability, inventory and order fulfillment. The Admin Console is used by businesses and administrators to access a large range of functionality provided by the following Fluent Commerce apps:
Each app provides out-of-the-box capabilities that are accessed by the Fluent Admin Console.
By default, the Admin Console displays content in English. However, v4.44 release onwards, the Fluent platform provides support for multiple languages. For more information on languages and localization and configuring other languages, click here. The console should be used on tablets and computers that have an active internet connection and a supported web browser.
Fluent Commerce doesn't support static IP whitelisting due to AWS Cloud's dynamic nature. Instead, robust authentication measures are in place for webhook security, including cryptographic signing and signature verification. While static IPs aren't recommended, securing webhook endpoints is achievable by configuring unique URLs and firewall rules. Additionally, setting up custom authorizers or message queue validation enhances security. Each webhook establishes a single connection, with inbound and outbound calls dependent on workflow events. For detailed guidance, refer to Fluent's 'Webhook overview' documentation.
Using the Event API
Clients and Partners will need to have their Fluent Account set up prior to being able to work with Orchestration.
You should have received an "Account Ready" email with your Fluent Account Details, including user login credentials.
If you do not have access to a Sandbox account, please contact your Fluent Account Manager.