Fluent Commerce Logo
Docs
Sign In

Frameworks

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

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.

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.

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.

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.

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

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.

Using the Event API

Essential knowledge

Using the Event API

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.

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