Basic Knowledge
Essential Knowledge articles related to the Workflow Framework (Rubix)
Webhook Retries and Inline Events
Essential knowledgeCore knowledge to understand Fluent CommerceThis page explains how the Orchestration Engine retries a webhook that is reached through inline events, and helps you decide which value of `fc.rubix.webhook.retry.event` to use for your account.It describes how each workflow pattern is affected, what each value does, and what to check before you change the setting.- Prerequisites: Webhooks, Inline Event, Understanding Event Execution
- A webhook action is retried only when its request fails with a network error, such as a timeout. This happens most often when the receiving system is under load, for example during peak trading
- With
`webhook-event`, the retry uses the webhook event, which is the event that triggered the ruleset in which the webhook action was produced:- The retry is posted to the same endpoint with the same event as the original call
- If the receiving system responds, with any HTTP status code, the retry counts as delivered and retries stop
- If all retries fail, the Exception event is raised for the ruleset and entity of the webhook event
- With
`initial-event`, the retry uses the initial event, which is the event that started the event context:- The retry is posted to the same endpoint, but with the initial event, so the event name, the entity, and the attributes can differ from the original call
- If the receiving system responds, with any HTTP status code, the retry counts as delivered and retries stop. The original call isn’t sent again, and the Send Webhook audit event shows
`SUCCESS`, so the failure goes unnoticed - If all retries fail, the Exception event is raised for the ruleset and entity of the initial event, not for the ruleset of the webhook event
- The values differ only when the webhook event is an inline event. When the webhook action is produced in the ruleset triggered by the initial event, both values give the same retry
- Accounts created before the setting was introduced keep
`initial-event` until you change it. Accounts created since then use `webhook-event`. Check your workflows with this page, then switch to `webhook-event` - For custom webhook rules and the reference
`SendWebhook` rule, also add `preserve-event-details` to the workflow, so the retry reruns the rule that produced the webhook action. Without it, the retry is sent by the built-in platform webhook rule. See `fc.rubix.sdk.webhook.retry.method`.
Synchronous vs. Asynchronous Integration with Fluent Order Management
Essential knowledgeCore knowledge to understand Fluent CommerceFluent’s platform philosophy and integration guidance applies to payment, fulfillment, invoicing, WMS, ERP, and other external systems. Fluent OMS is intentionally asynchronous and event driven to support scalability, reliability, and stable workflow processing. Synchronous calls should occur in a separate integration or middleware layer, which handles the external response and sends the outcome back to Fluent as an event. This prevents delays, timeouts, duplicate actions, and stuck orders while keeping each system within its intended role.- Fluent OMS is an eventdriven, asynchronous platform designed for scalable, stable and reliable integrations.
- Fluent’s workflow engine does not support blocking synchronous calls to external systems such as payment providers, WMS or ERP platforms.
- Synchronous integrations are still possible, but must be managed through an external integration or middleware layer alongside Fluent.
Fluent Connect
Essential knowledgeCore knowledge to understand Fluent CommerceFluent Connect provides a cloud native integration layer that unifies Fluent Commerce with enterprise systems. Its scalable and API driven architecture ensures real time synchronization of orders, inventory and fulfillment data across your tech ecosystem in days instead of months, the following article provides further information about Fluent ConnectTo learn more about Fluent connect native AI powered integration framework read the following article
- Hosted Connectors - Managed integrations with commerce platforms, payments, marketplaces, carriers, tax engines, ERP platforms
- Connected Inventory Connectors - Specialized category for high-frequency, read-only inventory data flows
- AI-Assisted Implementation - AI-assisted build capabilities accelerate connector implementation, troubleshooting, and optimization
Responsive Sourcing Framework Overview
Essential knowledgeCore knowledge to understand Fluent CommerceThe 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.- Prerequisites: You should have knowledge of Order Management and Order lifecycle, Order Reference Module, and GraphQL API
- The Responsive Sourcing Framework is designed for both technical and business users - logic is transparent and comes with a configurable User Experience (UX)
- Enables faster implementation by reusing modular sourcing logic building blocks such as Sourcing Profiles, Strategies, Conditions, and Criteria
- Sourcing Profile GraphQL API is required to correctly set up your sourcing logic
- Supports custom Sourcing Conditions and Criteria through externally developed extensions for advanced or domain-specific logic
Controls Utilities Overview
Essential knowledgeCore knowledge to understand Fluent CommerceThe Controls Utilities library (`util-controls`) applies controls to a catalog position in a consistent, reusable way. Rather than each rule reimplementing how to find and apply controls, a rule calls `ControlUtils.applyControls(...)`, which loads the required data from GraphQL, evaluates the applicable controls, and returns an updated position together with an audit of every change.- Prerequisites: Java, Maven, and JUnit; Rules SDK (Rules and the rule Context); Understanding of Fluent Inventory concepts and domain model
- Single entry point:
`ControlUtils.applyControls(...)` resolves and applies controls in one call - Standard control types:
`ControlUtils` includes inclusion, exclusion, buffer, limit, and threshold controls by default - Specificity-aware: position/product/variant-level controls take precedence over group-level (bulk) controls
- Auditable: the result includes a before/after snapshot for every control the utility applied
- Extensible: supply custom control functions to support control types specific to your implementation
What are Fluent OMS Entities? (Entity)
Essential knowledgeCore knowledge to understand Fluent CommerceA detailed explanation of Fluent OMS entities and how they can be used throughout the order journey.- Entities in Fluent OMS are data objects that store and process information throughout the order journey, such as orders, fulfilments, and financial transactions.
- Entities are managed via GraphQL, with mutations and queries used to create, update, and retrieve entity data.
- Entities should not be deleted but controlled using status fields, although some "remove" mutations can disconnect entities.
- Orchestrated Entities trigger a CREATE event upon successful creation, enabling workflow automation.
- Entities in Fluent OMS serve unique purposes to enable an end-end digital commerce journey and their statuses determine at what stage they sit.
- Entities have types and subtypes, types are rigidly defined, subtypes are more flexible.
ICP, Qualification Criteria and Additional Use Cases
Essential knowledgeCore knowledge to understand Fluent CommerceThe article provides a comprehensive guide to identifying the Ideal Customer Profile (ICP) for an Order Management System (OMS), highlighting key criteria and red flags to ensure successful implementation. It also explores Fluent OMS use cases, showcasing its capabilities in order capture, fulfillment, tracking, promising, shipping, and inventory management.- Ideal Customer Profile (ICP) based on specific industries, company maturity, and high order volumes
- Poor fit indicators, such as outdated legacy infrastructure or a lack of executive buy in
- Fast Qualification Framework to rapidly assess a prospect's Budget, Systems, Volume, and Channels.
Overview of Payments in Fluent
Essential knowledgeCore knowledge to understand Fluent CommerceThe Fluent platform enables payment orchestration across the full lifecycle of an Order. Using the OMX Workflow Framework and core payment entities, businesses can implement custom logic for fulfilment, capture, refunds, and reconciliation. This document outlines the Payments Data Model and GraphQL API capabilities, excluding reference Rules, Workflows, or UX components. Financial operations within the Payments domain rely on precision-safe monetary representations to ensure accuracy and consistency across transactions.- This document covers the Payments data model and GraphQL API
- Payments are usually fulfilment-driven, but capture can occur at different stages depending on workflow configuration
- Core entities: FinancialTransaction (funds source), Payment (capture/refund), PaymentTransaction (status log)
- Monetary values support precision-safe amounts via preciseAmount (BigDecimal/NUMERIC); legacy Float fields remain optional for backward compatibility
Introduction to the Events API
Essential knowledgeCore knowledge to understand Fluent CommerceThe Events API is a core component of the Fluent Platform, enabling the creation and management of events that drive workflow logic and system activity tracking. It supports asynchronous operations for optimized performance and integrates with systems for inventory updates, product data transfer, fulfillment, and carrier tracking.- Events are fundamental to the Fluent Platform, representing actions or occurrences within the system.
- The Events API enables viewing and creating events, supporting workflow logic and system activity tracking.
`ORCHESTRATION` events trigger workflows, while `ORCHESTRATION_AUDIT` events log workflow execution details.- Common Event API operations include retrieving events by ID, filtering events, and creating new events asynchronously.
- Event Contracts are defined by Rulesets in workflows, combining event attributes to handle specific processes.
- Recommended practice: Use asynchronous integration for non-real-time actions to optimize performance.
- Common integrations include inventory updates, product master data transfer, fulfillment updates, and carrier tracking.
Product Description - Fluent Commerce OMS
Essential knowledgeCore knowledge to understand Fluent CommerceFluent 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 main components that comprise the platform architecture are Web Apps, Modules, Order Management Experience (OMX), Orchestration Engine, and Cloud Infrastructure.
- Each Module represents a particular business domain and its associated rules and workflows. Core, Inventory, Order and fulfilment are the four Fluent modules.
- These are the web and in-store interfaces used to access module functionality.
Product Description - Fluent Commerce OMS
Essential knowledgeCore knowledge to understand Fluent CommerceFluent 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 main components that comprise the platform architecture are Web Apps, Modules, Order Management Experience (OMX), Orchestration Engine, and Cloud Infrastructure.
- Each Module represents a particular business domain and its associated rules and workflows. Core, Inventory, Order and fulfilment are the four Fluent modules.
- These are the web and in-store interfaces used to access module functionality.
Workflow Framework Overview
Essential knowledgeCore knowledge to understand Fluent CommerceThe Workflow Engine (aka Rubix) is the engine that drives the Fluent platform. The Workflow Engine enables business process orchestration, workflow automation, and underpins the specific feature sets and functionality for each of the Fluent apps. Additionally, the Workflow Engine is built to be highly scalable, and provide high-performance workflow execution across any domain.- Cloud-native, high availability, scale-on-demand workflow execution.
- Pre-built, customizable workflows delivering capabilities across each of the Fluent App domains.
- Rich Rule Library containing reusable rules across each of the Fluent Apps.
- Software Development Kit (SDK) and Developer Tooling, enabling the implementation of custom rules and integrations.
- Business Tools to manage, configure, and implement workflow and process automation.
A collection of links to get started with your Fluent OMS journey.
Essential knowledgeCore knowledge to understand Fluent CommerceFluent Commerce is a flexible, cloud-native distributed order management system (OMS) designed to help retailers manage inventory, orders, fulfillment, and customer experience more efficiently. This guide outlines the key resources and steps to get you started.- Fluent Commerce is a cloud-native OMS designed to optimize inventory, orders, and fulfillment for retailers.
- Key resources include Core Concepts, Fluent CLI, API integration, workflows, and environment setup.
- Training and certification are available to enhance expertise in Fluent Commerce.
Product Description - Fluent Commerce OMS [Superseded - Document Version 1.0]
Essential knowledgeCore knowledge to understand Fluent CommerceFluent 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 main components that comprise the platform architecture are Web Apps, Modules, Order Management Experience (OMX), Orchestration Engine, and Cloud Infrastructure.
- Each Module represents a particular business domain and its associated rules and workflows. Core, Inventory, Order and fulfilment are the four Fluent modules.
- These are the web and in-store interfaces used to access module functionality.
MockApiClient
Essential knowledgeCore knowledge to understand Fluent CommerceThe `MockApiClient` is a critical component of the `util-test` library. It provides a mock implementation of the `ApiClient`, which is the interface Rules use to communicate with the Fluent Commerce GraphQL API.By using the `MockApiClient`, you can test how your Rule behaves with different API responses without making any actual network calls. This isolates your tests, makes them faster, and allows you to simulate any scenario, including errors or empty data results.
- Test API Interactions: The
`MockApiClient` allows you to test how your rule responds to different API outcomes (e.g., success, failure, empty data) without making live network calls. - Isolate and Speed Up Tests: By mocking the API, your tests run faster and are isolated from network or environment issues.
- Executor Integration: You typically don't use
`MockApiClient` directly. You use the helper methods on `RuleExecutor` and `WorkflowExecutor` (like `.mockQuery()` and `.mockSetting()`) to configure it. - Full Coverage: It supports mocking pre-compiled queries/mutations, dynamic queries/mutations, and settings, giving you complete control over your test environment.
Orchestration Engine
Essential knowledgeCore knowledge to understand Fluent CommerceThe Orchestration Engine powers the execution of workflows, business logic, and business processes. It enables real-time sync for orchestrated availability calls, high-volume batch processing for inventory loads and updates, event tracking which logs all activities, responds to events triggering execution, and triggers activity in external systems.- Orchestration Engine
- Powers the execution of workflows, business logic, and business processes.
- Enables real-time sync for orchestrated availability calls, high-volume batch processing for inventory loads and updates, event tracking which logs all activities
- Responds to events triggering execution, and triggers activity in external systems.