Fluent Commerce Logo
Docs
Sign In

Recently Updated

Some of the recently updated content.

Fluent Store Dispatch Template

Essential knowledge
  • Pack and Dispatch Orders: This template facilitates the packing of items into boxes or satchels and allows for printing of packing slips and carrier labels.
  • Multiple Order Types: It supports packing for various order types including Home Delivery, Click & Collect, and Store Transfers.
  • Configurable Workflow: The template relies on the Location Store Workflow with a Wave Dispatch User Action to streamline the dispatch process.
  • Wizard Page Integration: Utilizes the fc.page.wizard component from the Component Library for step-by-step guidance through the packing process.

Store Module Overview

Topic

The Store Module brings Order Management capabilities to the in-store experience. The Store Module enables Retailers to transform their existing Stores into fulfillment and distribution centers, optimizing costs and enhancing the customer experience.

Inventory Module Getting Started Guide

Essential knowledge

The Inventory Reference Module is the foundation for inventory related implementations. It provides reference Workflows for inventory ingestion and processing. Extensible by design, use this Module as a base to build a solution to the needs of your customers.

  • Understanding the Pre-requisites is crucial before you begin using the Inventory Module.
  • Learn how to enable the Inventory Module for your system.
  • Get familiar with the Module Workflows to effectively manage your Inventory.
  • Ensure proper configuration of the Inventory Module to suit your business needs.

How to Implement Enhanced Inventory Attributes in Your Payloads

Essential knowledge

This guide is designed to help you implement the enhanced

`attributes`
functionality in your inventory payloads. The
`attributes`
object is a flexible structure that allows you to include a wide range of key-value pairs, including complex JSON objects and arrays. This flexibility enables you to customize the data according to your specific business needs, whether you are managing detailed product information, handling sophisticated supply chain operations, or integrating with custom workflows.

  • Flexible Attribute Structure: The
    `attributes`
    object supports any combination of key-value pairs, including complex JSON structures and arrays. This flexibility allows you to customize the data sent in your inventory payloads to meet specific business needs.
  • Recommended Attributes: Certain key attributes, such as
    `expectedOn`
    ,
    `storageAreaRef`
    , and
    `condition`
    , are automatically integrated into our platform’s workflows. These fields will be directly updated in the inventory quantity associated with the incoming record, facilitating seamless integration with existing fields.
  • Custom Attribute Availability: Any custom attributes that you include in the
    `attributes`
    object will be available in workflows via
    `inventoryPosition.inventoryQuantity.attributes.<fieldname>`
    . This enables you to incorporate custom data into rule-based processes or other logic tailored to your business requirements.
  • ISO 8601 Date Format: For any date-related attributes, it is recommended to use the ISO 8601 format (e.g.,
    `YYYY-MM-DDTHH:MM:SSZ`
    ) to ensure consistency and proper handling within the system.
  • Integration with Workflows: The system is designed to handle both recommended and custom attributes, making them accessible within the workflow context. This ensures that you can leverage these attributes in custom rules and other logic, depending on the specific needs of your implementation.
  • Extensibility: While the table of recommended attributes provides a useful starting point, you are encouraged to extend the
    `attributes`
    object with any additional fields relevant to your business processes. The flexibility of this structure allows for robust customization.

Metrics Overview

Essential knowledge

This document is intended to introduce the Metrics and describe their place within the Fluent Big Inventory product.

Pre-requisites:

  • Metrics are available for all Fluent Order Management and Fluent Big Inventory customers.
  • Metrics data is captured, uploaded, and stored in a monitoring system.
  • Metrics data is retrieved via the Metrics API.
  • Metrics data can be visualized with the OMX UX Framework, Business intelligence tools, and third-party Metrics analytics platforms.

Platform Limit Definitions (v1.0)

Essential knowledge

This document sets out the definitions for the terminology used in the Platform Limits document some of which is also used in your contractual agreement documents (e.g. Order Form) with Fluent Commerce. 

For definitions of other essential terminology, visit the Glossary of Key Terms and Product Taxonomy pages.

  • Read this together with the Platform Limits document and your Agreement/Order Form relating to the Platform.

Platform Limit Definitions (v1.1)

Essential knowledge

This document sets out the definitions for the terminology used in the Platform Limits document some of which is also used in your contractual agreement documents (e.g. Order Form) with Fluent Commerce. 

For definitions of other essential terminology, visit the Glossary of Key Terms and Product Taxonomy pages.

  • Read this together with the Platform Limits document and your Agreement/Order Form relating to the Platform.

How Metrics works

Essential knowledge

This document is intended to describe to implementers Metrics technical details within the Fluent Big Inventory product.

Pre-requisites:

  • All customers' Metrics are isolated in the dedicated workspaces.
  • Metrics are captured from the Fluent APIs, Orchestration Engine (Rubix), Batch Pre-Processing, and Inventory Feeds.
  • Use
    `metricInstant`
    and
    `metricRange`
    GraphQL queries to retrieve the Metrics data.

Display REST API Data in Standard Library Components

How-to Guide

Build a Webhooks Monitoring Dashboard

How-to Guide
  • For Frontend Configurators (JSON) of the Fluent OMX UX Framework with access to a small custom component
  • Enable a visual Webhooks Monitoring Dashboard in the Fluent OMS (or any other Fluent web app)
  • How to add a new page to the Insights section
  • How to query the Event API for Webhook Audit Events
  • How to use the
    `devrel.provider.rest`
    component to display information from the Fluent REST APIs using standard the standard UX Component Library
  • Access specific attributes by name (even when they contain spaces!)
  • How to conditionally color code a specific table column
  • How to display a details drawer from a list
  • How to display contextual Webhook information on the Order Details screen

GraphQL API

Essential knowledge

The Fluent GraphQL API provides powerful access to data, integration, and orchestration-driven business logic. It provides an opportunity to streamline and optimize requests to the Fluent Order Management platform in a way that is more flexible than the REST-based API.

  • Schema Documentation
  • Benefits of GraphQL
  • Why Did We Choose GraphQL?
  • Differences Between REST and GraphQL-based APIs

REST API

Essential knowledge

The Fluent Platform provides and number of REST APIs for interacting with the platform.

These differ from the primary GraphQL APIs which primarily cover domain entities. This section provides access to the REST based Platform APIs reference documentation.

  • The REST APIs provide platform level capability, such as Authentication, Integration, and Workflow Framework setup
  • This does not include deprecated v4.1 Domain-based REST APIs
  • See GraphQL for current domain-based entities and APIs

Install Reference Modules using Plugin and Workflow APIs

How-to Guide
  • Reference Modules: There are four reference modules: Core, Order, Fulfilment, and Inventory
  • Version: Always download and install the latest version of the module
  • Extraction: Unzip the downloaded file using system-appropriate software
  • Verification: Ensure the extracted folder follows the naming pattern fc-module-<domain>-<pluginVersion>
  • Assets Folder: Confirm the extracted folder contains the "assets" folder, which includes "rules" and "workflows" subfolders
  • Jar File: Within the "rules" folder, locate the jar file named fc-plugin-<domain>-<pluginVersion>. Keep track of the domain and version numbers
  • Workflows: In the "workflows" folder, ensure default workflows with placeholders are appropriately customized for your account

What is a Reference Module?

Essential knowledge

A Reference Module is a Module provided by Fluent Commerce that is designed to provide reference artifacts that you can use to create your own solutions. While an Extension contains an entire solution within itself, Reference Modules provide Domain Artifacts that can be used to speed up building your solutions. Structurally, Reference Modules are identical to Modules, as are Extensions.


  • Provide understanding of Reference Module and link to some examples

Connector Contract

Essential knowledge
  • Provides a customisable and reusable approach for respective module contracts
  • The contract can be extended to implement customer-specific requirements

How to transform v1.0 manifest into the manifest v2.0

Essential knowledge
  • Admin Console Vs Fluent OMS Manifests
  • How to add a component to a tab
  • How to add a filter and exclude filters that should not be displayed on
  • How to add breadcrumbs
  • How to set the default page size
  • How to add Mutations and UserActions
  • How to add components to a card
  • How to add components to a list
  • How to configure navigation from Dashboard to the page with applying date and time range filter

Rule Development Guidelines & Recommended Practices

Essential knowledge
  • This document will cover the following topics:
    • Best Practices
    • Rule Naming Conventions
    • Rule Descriptions
    • Rule Parameters
    • Exception Handling
    • Logging & Audit Events
    • Utilities, Helpers, and Services
    • Constants
    • Documentation
    • Additional Best Practices

Exception Management in writing Rules

Essential knowledge
  • To ensure that the Orchestration Audit Events contain as much useful information as possible, it is important to consider the Exception Strategy used by your Rules.
  • Don't swallow exceptions inside Rules, and always allow a caught exception to be re-thrown, or added as a cause to a new exception to ensure the cause is included in the Audit Events.
  • The Workflow Framework provides a special exception type called RuleExecutionException which provides special handling of exceptions differently from all others.

GraphQL Reference

Essential knowledge

These docs were generated by graphql-docs. Just starting out with GraphQL? Check out GraphQL's official documentation!

  • The schema docs are generated as part of a product release process and therefore are up-to-date.

Getting Started with Metrics API

Essential knowledge

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 data is fetched and visualized for the Fluent Platform Observability enablement.
  • Use
    `metricInstant`
    and
    `metricRange`
    GraphQL queries to retrieve the Metrics data.
  • Prometheus Query Language is utilized for the Metrics API queries construction.

Metrics usage for Platform Observability

Essential knowledge

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:

  • Metrics are available for all customers with Fluent Order Management and Fluent Big Inventory.
  • Metrics data is captured, uploaded, and stored in the Metrics workspace.
  • Metrics data is fetched and visualized for the Platform Observability enablement.

Languages and Localisation

Essential knowledge

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

  • Australian English 
    `en-AU`
     - Default
  • American English - 
    `en-US`
  • French - 
    `fr-FR`
  • Mexican Spanish - 
    `es-MX`
  • Italian - 
    `it-IT`
  • Enable additional language in OMS
  • Additional language Support - Beta
  • Custom Language Bundles
  • Language Preferences for User Accounts
  • Customizing Languages and Key
  • Customizing Workflow User Actions
  • Adding new Mutation Actions
  • Priority and Fall Back Options of Internationalization
  • Limitations

Using the anyMatch Template

Essential knowledge

The Mystique manifest configures icons, cards, and templates. Templates can be structured in various ways; for further details, please consult the UX Configuration Common Concepts article. This article, however, will specifically concentrate on the any Match template. 

This template functions as a filter for a stream (such as a list of items), capable of matching none, some, or all records where a specific condition is met by a field path. This feature is particularly valuable for filtering purposes.

  • The anyMatch template is used for performing conditional checks on structured data streams (i.e lists, arrays), typically JSON. The template requires three inputs parameters:  
    `STRING_PATH_TO_VARIABLE`
    ,
    `VALUE`
    and
    `OPTIONAL_FUNCTION .`
  •  This template checks if a specific path within your data structure matches a given value. 
  •  The anyMatch template also supports optional functions to perform different kinds of comparisons. The optional functions will compare the specified path to the value and return results if there is a match. 

Self-Service IPU/IPC visibility Overview

Essential knowledge

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

Webhooks Frequently Asked Questions

Essential knowledge
  • Static IP Whitelisting: Fluent Commerce's AWS Cloud setup doesn't allow for static IP whitelisting due to the potential for IP address changes caused by scaling or architectural adjustments, as well as AWS's own IP address alterations.
  • Authentication Measures: Instead of relying on IP Access Control Lists, Fluent Commerce employs strong authentication measures for webhook requests, including cryptographic signing with a private key and verification using a public key to ensure the request's legitimacy and integrity.
  • IP-Based Restrictions: Implementing IP-based restrictions, such as whitelisting or IP ranges, is not recommended due to the dynamic nature of IP addresses in the AWS Cloud setup, which can lead to high exposure levels and difficulty in implementation.
  • Alternative Approaches for Access Control: Instead of IP-based restrictions, companies can utilize firewall/networking equipment or reverse proxies to restrict access based on incoming HTTP request details, or configure unique, specific static URLs for incoming traffic to filter and accept connections securely.

Sources Dashboard

Essential knowledge
  • The Sources Dashboard offers a real-time window into Inventory Ingestion, allowing customers to monitor the execution flow and comprehend the current status of their inventory.
  • With user-friendly visualizations and configurable time periods, the Sources Dashboard empowers users to access comprehensive inventory metrics data, enhancing their ability to make informed decisions about inventory processing.

Products

Essential knowledge
  • The Products module within the Fluent Big Inventory app is a centralized hub for managing a collection of products, encompassing all associated attributes and details, offering a holistic approach to product management.
  • The module focuses on Product Catalogue management, Standard Product management, and Category management. It empowers users to organize and oversee their product-related information efficiently, providing a seamless and comprehensive solution.
  • The module offers specific configurations for managing Categories and Product Catalogues, ensuring a tailored and effective approach to product categorization and cataloguing.

Feeds Dashboards

Essential knowledge
  • You should know about Inventory Feeds.
  • The Feeds Dashboard offers a comprehensive overview of inventory feeds, presenting general information for selected periods and providing users with insights into their account's feed activities.

Colored Thresholds for Gauge Charts Configuration

How-to Guide

Page Filter Select configuration via Manifest

How-to Guide

Connector Deployment Cloudformation

Essential knowledge

Attached to this page is the “connectors.yaml” template which is used to create Cloudformation Stack for the Connectors API. The resulting stack deploys ECS Fargate containers that run the API and produce a public endpoint. This public endpoint is secured with an SSL certificate which is applied to the Application Load Balancer.

  • Disclaimer
  • Prerequisites
  • Manual Deployments
  • Stack Provisioned

Fluent Big Inventory Web App Overview

Essential knowledge

The Fluent Big Inventory Web App is a web-based interface designed to streamline the management of products, inventory, feeds, and sources. Key functionalities encompass:

  • Feeds. The Feeds Dashboard contains general information about inventory feeds for an account.
  • Sources. The inventory data sources allow users to observe and track integrated inventory update sources.
  • Products. The products section allows a user to manage product catalogues and products.
  • Inventory. The Inventory section provides robust inventory management, including visibility of allocation, stock on hand (SOH) for specific items, real-time inventory status, available-to-promise levels, and inventory buffers to prevent overselling.
  • Stores. The stores section allows you to manage individual locations and networks of locations.
  • Insights. The insights section provides comprehensive details to monitor all the system events that have occurred.
  • Admin. The admin section provides administrative capabilities to manage the system and users.

Each section contributes essential reference capabilities integrated into the Fluent Big Inventory Web App to offer an unparalleled user experience and deliver value across diverse business scenarios.

  • The Fluent Big Inventory Web App offers a comprehensive suite of functionality.
  • With dedicated sections for Sources, Products, Inventory, Stores, Insights, and Admin, the web-based interface provides users with a holistic toolset, allowing them to observe and track integrated sources, manage product catalogues, exercise precise control over inventory, oversee individual and networked store locations, monitor system events comprehensively, and efficiently administer the entire inventory availability system for a seamless and valuable user experience.

Using the Event API

Essential knowledge

Using the Event API

Webapps OMS Dashboard

Essential knowledge
  • The Console Dashboard is configured using the Dashboard Threshold Component to display orders and alerts.
  • The user can configure each dashboard tile Order and Alerts specific to the business requirement.

Workflow Configuration - Getting Started

Essential knowledge

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.

  • Overview and Key Concepts on Workflow Configuration.
  • The primary setting required to be enabled for working with Orchestration is that your Account should be RUBIX_ENABLED. 
  • As a user working with the Orchestration Modeller via the Admin Console, you will require the ORCHESTRATION_ADMIN role.

Mixed Baskets User Interface

Essential knowledge

The Fluent OMS module is pre-configured with certain standard functions. Mixed Baskets functionality is not a part of the default pre-configuration. The reference manifest fragment represents the new UI for Mixed Baskets functionality. Detailed information on configuring UI for Mixed Baskets is available in the guide.

  • Mixed Baskets order functionality introduces an essential change in the relationship model between order and fulfilment choice. It is a one-to-many relation model for Mixed Baskets order type and one-to-one for HD/CC.
  • Enhanceable manifest to change Fulfillments display

External Network Notification

Topic

In this sample project, we will go through some basic features of the SDK by creating a connector that can receive notifications from Fluent System, which is processed and sent to any external system like Email, Slack, Datadog, etc.

These are the topics covered by this guide:

  • Create a new Handler for receiving Notification from Fluent System
  • Send Notifications to an external network
  • Schedule Job Handler for Monitoring failed events

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.

Fluent Logo