Building Blocks

The Accordion component is a Mystique content component that can expand to show its child components. It is useful for hiding details with the ability to pull it up when needed.

• This article describes how to add Add item button (`OpenDataModalButton`) to the drawer and display the list of product items in a modal window ('Add Item' dialogue).

The rule adds an attribute with name `FULFILMENTTYPE` to incoming fulfilment with value based on the fulfilment type.

The rule adds an attribute with name `FulfilmentType` to incoming fulfilment with value based on the fulfilment type.

This setting manages the Fluent Admin Console. The setting contains all the labels required to display and customize the Admin Console. To support languages other than English users can enter the labels directly into the configuration of their preferred language. Alternatively, they can create a language key and add the translation in more than one language setting files.

The Adobe Commerce Connector provides seamless integration between the Fluent Order Management platform and Adobe Commerce. New and existing Adobe Commerce customers can rapidly adopt omnichannel capabilities with the connector.

Allocates picked items to all Fulfilments in the Wave. Priortizing the Fulfilments expiring first and not in specified statuses. Secondly, notifies Fulfilments with the specified event name.

Allocates picked items to all fulfilments in the Wave. Priortising the fulfilments expiring first and not in specified statuses. Secondly, notifies Fulfilments with the specified event name.

This setting enables creation of multiple articles for one fulfilment. If this setting is set to TRUE then the article creation is done post packing to facilitate multiple article creation for one fulfilment. If this setting is set to FALSE then the rule creates only one article for the fulfilment.

This setting captures the list of reasons for appeasement used by a customer care representative while creating an appeasement.

Apply Threshold Controls to an Inventory Position and determine its status.

Apply Threshold Controls to a Virtual Position and determine its status.

A chart that displays graphically quantitative data. It is based on the line chart. The area between the axis and line is emphasized with colors. Commonly two or more quantities are compared with an area chart.

An area chart wrapper that converts data from Metrics API to chart-readable format.

The Attribute Card implements the basic card that maps GraphQL responses onto a two-column card with keys on the left and values on the right.

`fc.attribute.column` is a content component that gives the following options:

• apply different styles to multiline data represented in a cell of `fc.list` component;
• display multiline data in collapsed/expanded view;
• display configured coloured icons in the cell depending on income values;
• display sorted data in the cell.

The Attribute Input Component is a default field component that allows you to add/edit Fluent entity Attributes in a drawer. 

The Auto Refresh Page Component will automatically refresh the current page every 10 seconds. This is useful for ensuring that the information displayed to the user is as accurate as possible with new entities and status updates reflected in pages within web apps at regular intervals.

This setting stores the permissible fulfilment statuses to create wave on a retailer location using Service Point. The setting is used by the createWave rule.

A chart that represents categorical data with rectangular bars with heights or lengths proportional to the values that they represent.

A bar chart wrapper that converts data from the Metrics API to chart-readable format.

The `fc.list.wrapper.bppmetrics` is a wrapper for the `fc.list` component. It transforms data from the Metrics API to a list-readable format, enabling seamless visualization of batch-processing metrics.

This setting stores which retailer IDs will be executed in the database stored procedure - inventory_view to aggregate the inventory results. This aggregation is executed every 6 hours by the cron job and the inventory result is used by the Admin Console. It is used by clients not on Rubix platform.

The rule calculates distances, in meters, from each location to the order delivery address based on the incoming longitude/latitude. Sends event with attributes containing calculated distances.

Calculates the onHand value of an inventory position using inventory quantities filtered by statuses {filterStatuses} and types {filterTypes}, and then send the event {eventName}

The rule changes the status of all fulfilments associated with the incoming order entity to `CANCELLED` and updates fulfilment item's filled quantity and rejected quantity.

The rule changes the status of the incoming fulfilment to 'CANCELLED' and updates fulfilment item's filled and rejected quantities.

The rule changes the order delivery address and creates a comment for the order.

The rule matches the incoming fulfilment's from address location ref to the system rejected location ref provided in the input parameter and if it matches, changes the fulfilment status.

The rule changes the state of the incoming entity to the status provided in the input parameter using the generic update status mutation in GraphQL.

The Circular Progress Component visually indicates the ongoing progress of a loading process.

Collapsible Entity Attributes is a component that can be used to improve the user experience when interacting with a lot of attributes. It has the ability to:

• Display these attributes on one line separated by commas
• Display these attributes line by line.
• Collapse and expand based on the number of characters (for one-line)
• Collapse and expand based on the number of lines (for line-by-line).

The Collapsible Text component takes a string and a maximum number of characters into its props. When the string exceeds the maximum number of characters the text is cut off. Then `More` hyperlink is displayed to allow the user to expand the label to its full length, exposing the remaining text.

This setting is used to store the number of days a parcel remains available for collection once it is ready to pick up from the store. This is used for accounts where settings RUBIX_ENABLED is FALSE for 'Click and Collect' orders. The default value is 7 days. During the execution of the orders, there is a cron job that checks all the articles that are updated in the last 7 days and generates an event to expire those articles.

A simple component that allows you to place other components in a column. Typically used to improve the layout and accessibility of items on a page, see a sample use case and the properties of this component below.

The commercetools Connector provides seamless native integration between the Fluent Order Management platform and commercetools platform with greater flexibility and simplified development. commercetools customers can rapidly adopt omnichannel capabilities with this connector.

This Setting enables the clients who are not on Global Inventory (GI) to utilise the GI-based rules. This helps the developers to write GI based rules for non-GI enabled clients. When this setting is set to TRUE the system generates the virtual catalog using the legacy inventory tables and legacy catalogue tables.

The Component SDK allows clients and partners to develop new components to extend the functionality of the Fluent Web Apps.

Optionally render descendants only if certain criteria are met. This can be used to show different components depending on the results of the page query, for example:

• a different location card when the order is home delivery vs customer collection
• a completely different screen when a wave is in a given state

The rule updates the fulfillment items with the quantity details using the quantity details from the items received in the event attribute.

Connect SDK is the launchpad to connect any external system with Fluent Commerce predictably. It reduces implementation timelines and costs so customers can see faster ROI. Technically, Connect SDK is a Java Maven Archetype and Java Library Utils that form a toolkit for building Spring Boot microservice applications that communicate with the Fluent Order Management System and any external system.

The rule copies all the attributes from the parent fulfilment onto the article entity in the incoming event.

The Core Reference Module is a foundational Reference Module. 

It provides a base set of general purpose Rules:

• that other Modules are built upon 
• or that can be included in your own Workflows

Extensible by design, use this Module as a base to build a solution for the needs of your customers.

Create an Aggregate Virtual Position, calculate its Available-to-Sell (ATS) quantity, and send an event.

Aggregate Virtual Position ATS calculation is based on the associated Inventory Positions Stock on Hand (SOH) quantities and the applied Controls.

The associated Inventory Positions are defined with:

• The given Product Reference
• The list of Locations for the given Network (the first Network assigned to the Virtual Catalog)
• The specified Inventory Position Statuses

The rule creates one or more articles for the Fulfilment in the incoming event.

Creates a base virtual position and sends the event `{eventName}`

Checks if a Virtual Position does not exist, if the Virtual Position does not exist it will create a new Virtual Position with the matching attributes

The rule creates customer’s Billing Account with billing account reference.

Creates a category based on the information passed in the event

The rule creates a CreditMemo for the BillingAccount using the supplied revised order details and the old order as well.

The rule creates a CreditMemo for the BillingAccount using the supplied Order details.

Create an Inventory Quantity(ies) for the specified Inventory Position.

The rule creates a demo consignment.

Creates a demo consignment with label {"PROP_LABEL_URL"} and carrier {"PROP_CARRIER_REF"}.

The rule processes a payment event and creates a financial transaction.

The rule creates fulfilment based on the incoming proposed fulfilment, excluding fulfilments in specified statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

The rule creates a fulfilment based on the incoming proposed fulfilment, excluding fulfilments in specified statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

The rule creates a rejected fulfilment for order items that could not be fulfilled (no inventory) based on location. The rule processes only fulfilments that are in accepted statuses and not in rejected statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

The rule creates `SYSTEM_REJECTED` fulfilments for unfulfillable items using a location ref provided in input parameters. It uses a mathematical calculation on counts of all fulfilments by dividing them into 2 different groups depending on their statuses i.e. accepted statuses and rejected statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

Create inventory quantity of type {inventoryQuantityType} using event attributes, or set default type as {defaultType}, condition as {defaultCondition} and storageRef as {defaultStorageAreaRef}

Create an inventory position based on the incoming event attributes

Create an inventory quantity based on the incoming event attributes

Create a standard product based on the information provided in the event

The rule creates an Invoice for the order.

This rule is executed to create articles based on the items packed into parcels.

The rule creates a return entity. The return entity is then used to initiate the process of order items return.

The rule creates a revised order based on the revised order attributes passed in the event.

Create a variant product based on the information provided in the event

Create a wave from fulfilments in statuses `{status}`, prioritizing those with the earliest expiry.

The CreateWaveByFulfilmentIds takes a list of Fulfillments and creates a Wave with them.

This setting optimizes picklist sorting for efficient picking runs. Define sorting criteria like: Parent department (e.g., MEN), Child department (e.g., SHOES), and Category (e.g., Sneakers). Sorting by levels (1: Parent, 2: Child, 3: Category) helps staff pick items from the same area at once, reducing travel time between locations.

The dashboard threshold component displays a card with a number referring to the total records returned by a GraphQL query. Tiles can be configured to change colour based on configured threshold limits to indicate their status.

Each tile is configurable with a high and low threshold value, allowing users to view any 'total' data records.

The GraphQL Data Provider component is a wrapper component that changes the data context for its descendants. It is useful when you want to display a separate set of data that is different from the page query. 

Additionally, it provides more control options on how data is queried, including the ability to paginate and fetch data in bulk. Note that the maximum amount of data retrieved with the component is restricted.

This document describes the Date Range Field Component properties and sample usage. The component allows users to select a date and time range in the relevant form.

The `fc.daterange.wrapper.forwarder` is a wrapper designed to forward date range data to a URL. 

This setting stores the default Inventory Catalogue Rules. If the rule does not find any inventory catalogue then it checks in the default catalogue.

If the return destination is not provided to the workflow, then the rule will look for the default return destination stored in this setting.

The value in this setting will be used to populate the `destination location` field on the return order object when it is created.

A field may optionally send in its destination location for custom returns solutions when submitting the user action. The setting will serve as a fallback value if the field does not provide a destination location (which the reference solution does not)

See destinationLocation in the `CreateReturnOrder` GraphQL schema for more details

This setting is used to store the default values of the tax details.  

Displays order items in the collection screen. The following permissions must be enabled for the users in RETAILER CONTEXT to view order details:

- ORDER_VIEW

- ORDERITEM_VIEW

- PRODUCT_VIEW

- VARIANTPRODUCT_VIEW

- STANDARDPRODUCT_VIEW

- GROUPPRODUCT_VIEW

- CATEGORY_VIEW

There are some Fluent APIs that directly produce HTML pack slips.

These files can't be directly linked as they require authentication, so the Download Print Button exists to allow them to be downloaded directly from the page.

Forward the incoming event with event name {eventName} to the category entity with the provided ref

Send an event to the inventory position specified in event attributes from the inventory catalogue

Forward event `{eventName}` if the inventory position exists.

Forward the incoming event with event name {eventName} to the product entity with the provided ref.

Sends event {eventName} to the virtual position if a Virtual Position does exist

This article describes adding the 'Add item' button (OpenDataModalButton) to a drawer and displaying the 'Add Item' dialogue in a modal window. This allows users to easily review product items in an order before submitting.

The rule defines whether the address change is major based on the address fields that have been modified.

This setting stores the value for the permissible number of waves for an order. This setting is used by the CreateWave rule which creates the maximum number of waves equal to the number stored in this setting. If nothing is found then the rule creates a default of 5 waves.

This new component adds a drawer functionality to event searching, when a user clicks on an event it will now open a drawer with the event details instead of navigating to another page. 

This allows users not to lose search results and stop waiting for page navigation while going back and forth between the list of events. 

Learn more about the functionality of this component below.

This setting holds the default values for the settings. When a user creates an exchange, this system pulls the values from the setting.

`ExtendedAddressInput` is a Mystique component that can support the extended address in order details and a digital/e-mail shipping method. The component supports delivery addresses with lengthy street/city/company name fields (255 characters).

Previously, customers had an impact by an edge case in our authentication token expiry, which would occur when authentication expires while a batch job was in progress. The platform returns the HTTP response code of 500 instead of 401. This issue has now been fixed, and a 401 response code will return when the authentication token expires while running a batch job.

To ensure backward compatibility, we have implemented a setting to toggle between the correct (i.e. return 401 HTTP response code) and previous (i.e. return 500 HTTP response code) functionality. The setting details are mentioned in this document.

A setting to enable or disable Batch Pre-Processing feature.

This setting is a feature toggle that defines how empty strings and `null` inputs are handled by the GraphQL API and how the values are persisted. 

To enable it, set the setting `fc.graphql.compatibility.nullEmptyValidation` value to `validate-empty-fields`.

This setting is a feature toggle that enables Order creation across multiple Retailers with a single integration user. It allows the creation of Orders independent of the primary Retailer of the user and specifically enables the sending of the corresponding `CREATE` event.

Using the Workflow Builder (Orchestration Modeller), you can add user actions in the context of a custom web app name, by adding this new setting to your account. A custom web app is a web app that is not developed and supported by Fluent Commerce. Examples of the current web apps developed and supported by Fluent Commerce are Admin Console and Fluent Store (ServicePoint).

• The Fulfilment List Field Component allows users to select and filter Fulfilments. In the reference solution, these are then used to create Waves.
• Readers will understand the functionality of this component, how it can be configured and extended in order to implement different Store Fulfilment use cases.

The `fc.oms.mystique.inventory.search.inventory.position.stock.statuses` is a configuration that defines the available statuses for the Stock Status Filter on the Inventory Search page. This allows users to filter inventory data based on predefined status options.

The `fc.oms.mystique.inventory.search.virtual.position.stock.statuses` is a configuration that defines the available statuses for the Virtual Stock Status Filter on the Inventory Search page. This allows users to filter virtual positions based on predefined status options.

When this setting is set, the default Fluent Store web app will be overridden.

When this setting is set, the waves page will be overriden in the Fluent Store Web App

The `fc.oms.inventory.search.inventory.catalogue.default` setting is a configuration used to set the default value for the Inventory Catalogue Filter on the Inventory Search page. This ensures that the filter is pre-applied with a specific catalog. The setting can be configured as a string or a JSON value, allowing support for multiple inventory catalogs by including their references.

The `fc.oms.inventory.search.product.catalogue.default` setting is a configuration used to set the default value for the Product Catalogue Filter on the Inventory Search page. This ensures that the filter is pre-applied with a specific catalog.

This setting determines the time when we start the pick and pack process for an order. It is measured in hours and set at retailer and/or agent levels. The setting also determines when a fulfillment will appear in the store by changing the status from `SCHEDULED` to `AWAITING_WAVE`.

This setting determines the time when we reserve inventory for an order. It is measured in hours and is set at the account and/or retailer level. The system will create fulfillment based on the `DeliverAfter` value.

This setting fetches the location coordinates from the Google API. If this is set to TRUE and the coordinate is not supplied by the requestor then the logic fetches the coordinates from Google API.

The `fc.filterPanel` component is a versatile feature for filtering data, supporting two key use cases: standalone list filtering or as an embedded feature within the `fc.list` component for inner list filtering. It enables developers to customize filters via overrides, manage dynamic GraphQL queries, and exclude specific fields. When embedded, it enhances the user experience with dynamic, row-level filtering. Flexible configuration options ensure precise control over behavior and appearance, adapting seamlessly to various scenarios.

The rule finds locations which are outside the radius provided in the event attribute.

Forward the incoming event with event name {eventName}.

The rule sends an event with a proper name if the fulfilment choice has a definite type.

The rule sends event to all fulfilment choices with definite reference.

The rule forwards the input event with coordinates of the order delivery address.

The rule forwards the event containing the longitude & latitude of the delivery address if fulfilment choice has definite delivery type.

The rule forwards the input event with coordinates of the pickup location.

The rule forwards the event containing the longitude & latitude of the pickup location if the fulfilment choice has definite delivery type.

Forwards the event with name {eventName} if the category exists.

Forwards the event with name {eventName} if the category does not exist.

The rule forwards the input event if the order’s delivery address is not present.

The rule forwards the input event if the order’s delivery address is present.

The rule forwards the input event if the fulfilment choice delivery address longitude and latitude are invalid.

The rule forwards the input event if the fulfilment choice delivery address longitude and latitude are valid.

The rule forwards the input event if the fulfilment choice delivery address is invalid.

The rule forwards the input event if the fulfilment choice delivery address is present.

Forward the incoming event with the event name `{eventName}` if event attribute key `{attributeKey}` has value `{attributeValue}`.

Forward event {eventName} if the inventory position does NOT exist.

This article covers the following topics: 

• Supported Entities: `VIRTUAL_POSITION`
• This rule produces a `SendEventAction`
• Rule Parameters
• Event Attributes
• Exceptions
• Configuration Example
• Detailed Technical Description

Conditionally trigger another Ruleset when the Inventory Position and Quantity of the specified type exist.

Conditionally trigger another Ruleset when the Inventory Quantity of the specified type does NOT exist.

Forwards an event if the location has a different status compared to the inventory position and the location status is the same as the given {status} in the input parameters

The rule forwards the input event if the split limit is not reached for the order, excluding fulfilment with one of the given statuses.

The rule forwards the input event if the split limit is reached for the order, excluding fulfilment with one of the given statuses.

Forward the event {eventName} if the inventory position onHand value has changed

The rule forwards the input event if coordinates of the order delivery address do not exist.

The rule forwards the input event if coordinates of the order delivery address exist.

The rule sends an event if the pickup location is not part of the network specified or doesn’t match the specified location status. 

The rule sends an event if the pickup location is part of the network specified and matches the specified location status. 

Send an event {eventName} if the status of the product in the product catalogue with ref {productCatalogueRef} has the current status of {status}.

This rule forwards the input event if a proposed fulfilment is not present.

The rule forwards the input event if a proposed fulfilment is present.

Forwards the event with name {eventName} if the Standard Product exists.

Forwards the event with name {eventName} if the Standard Product does not exist.

The rule forwards the input event if unfulfilled items exist in the order, excluding fulfilment with one of the given statuses.

The rule forwards the event with the proper event name if fulfilment statuses are not from the provided list and there are unfulfilled items in the fulfilment choice.

Forwards the event with name {eventName} if the Variant Product exists.

Forwards the event with name {eventName} if the Variant Product does not exist.

Forwards the event {eventName} if the virtual position does not exist

The Fulfilment Options Module is the foundation for Product Availability. It provides Workflows to enable Product Availability for Home Delivery and Click-and-Collect. Extensible by design, this Module can be used as a base to build a solution that fits your business's unique needs.

The Fulfilment Reference Module is the foundation for in-store operations. It provides a reference Workflow to enable picking, packing, and shipping orders. Extensible by design, use this Module as a base to build a solution that fits your business's unique needs.

This component is a chart that indicates progress and consists of an arc with two sectors (active and inactive) and two texts - primary (big bold one) and secondary (normal size and font weight).

The gauge chart wrapper will convert Metrics data to be displayed in a gauge. This is configurable for different color and fill thresholds.

This setting is used to store the API Key to send an address and get back the longitude and latitude values.

The rule finds the locations with a required status in network and sends event.

Enables a backward compatibility for clients who are not using Fluent Commerce's Global Inventory (GI) system. If this setting is enabled, the system activates GI for those clients. For more information about the application of this setting, see Global Inventory.

Google Map component is a custom content component that displays the location (put pinpoint (location identifier/pin)) according to the location latitude and longitude. The component supports multi-language.

When this setting is enabled, The GraphQL Me Query is disabled for this Account.

A base grid component that lays data out in a four-column format. The primary use case of this component is to display product attributes, as the data must be keys and their corresponding values.

Tax Setting to declare the GST percentage value for return calculation.

This setting is required for orchestrated returns.

This setting is required to enable the `DEAFULT_TAX_TYPE` setting. This setting enables reading and writing raw JSON. This is a Boolean setting that should be set to `TRUE`.

Conditionally trigger another Ruleset when the specified Entity field or Event attribute matches the provided value.

Conditionally trigger another Ruleset when the specified Entity field or Event attribute is between the provided values.

Conditionally trigger another Ruleset when the specified Entity field or Event attribute is greater than the provided value.

An example of this includes pushing an Order through a fraud-check flow only when the `totalPrice` field is greater than `100`.

Conditionally trigger another Ruleset when the specified Entity field or Event attribute is less than the provided value.

Conditionally trigger another Ruleset when the specified Entity field or Event attribute is not null.

The Image Card Component enables you to display an image alongside other components within a card.

For example, you can place download buttons below an image to prompt the reader to interact with the buttons.

When enabled, this setting stores the inventory JSON in s3, and each Rubix server processes one batch at a time. This enhances the performance of the inventory load.

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.

The Inventory Module includes the following areas:

• Product Catalog workflow
• Inventory Catalog workflow
• Control Group workflows
• Virtual Catalog workflows

Custom component to display a page with an IPU/IPC report chart that displays data filtered by three parameters:  report type, time period, and granularity.

`fc.attribute.jsoneditor` is a custom content component that allows editing data in JSON format. The component has additional editing commands which can be accessed by right mouse button click on the component editor field.

`fc.attribute.json` is a custom content component that displays data in JSON format. If data contains a valid JSON, it will be parsed and displayed properly, while invalid data will be represented as is (raw).

When this is set to TRUE then it prohibits filter based query. For accounts with LARGE_VOLUME_CLIENT setting enabled Event query API should be used with account token.

A line chart visually represents data points over a continuous interval, typically along a horizontal axis. It offers a clear depiction of trends, patterns, or fluctuations in the data by connecting points with lines, aiding in easy comprehension of the data's trajectory over time or across categories. The x-axis commonly denotes time or categories, while the y-axis represents the numerical values being measured, providing a quick snapshot of data relationships.

Standard table card that takes array-like content and renders it as a table. While the Material UI table is available directly, the Mystique Table component adds several enhancements, including:

• mapping, transforming, and translating values from the GraphQL API
• pagination automatically hooked up to the page-level query
• per-row and bulk user action support driven by the workflow

The list source wrapper is a wrapper for the fc.list component that converts data from the Metrics API to a list-readable format.

Forward event `{eventName}` (inline event) with the attribute 'inventoryPositionExists' set to true or false if the inventory position exists or not respectively.

Forward event {eventName} (inline event) with the attribute "productStatus" and "locationStatus" if the product and location exist.

Loads the virtual position details and then sends an event {eventName}

The Upsert Location Module enables Event based integration for Location Feed. It provides workflows to create and update locations of type STORE and WAREHOUSE. The workflows orchestrate the following activities:

• Create/Update of Location entity as well the User entity linked to that Location
• Create `PICK_N_PACK_TIME_LIMIT` setting for the newly created Location
• Process Network changes
• ACTIVATE / DEACTIVATE Location
• Send `LocationStatusChanged` event to the configured Inventory Catalogue upon Location status change

This article explains the logic that triggers the creation of a wave. Commonly, waves are created based on the fulfillment expiry time. Alternatively, the logic can be based on specific attributes of identified items (e.g. bulk items). Making this change can help facilitate a more efficient picking process according to the store layout.

User actions can be created throughout the wave process to reinforce specific business procedures. For example, we can ensure that in-store staff confirms the completion of the picking phase by using a confirmation dialogue box.

The Repeater component allows you to display a set of components once per item in an array or connection. For example, use the repeater to show a table of items for each article in an order.

Enables the change delivery address feature. Users can configure major field changes such as cancellation of a fulfilment. Once delivery address change request is received by user action based event in Order workflow we evaluate whether it is a significant Address change. 

This is decided based on `MAJOR_ADDRESS_CHANGE_FIELDS` setting. In case of a minor change, the Order delivery address is updated in order and fulfillments. For significant address change, the existing fulfilment is cancelled and re-run the create fulfilment logic with the new delivery address. 

Ensure that `ChangeOrderDeliveryAddress` and the `EvaluateFulfilmentsForAddressChange` rules have been added to the Order workflow.

The Multi Card Component can be used to nest multiple components within the same card.

The Multi-Value Search Component is an interactive UI element designed to facilitate flexible multi-value input. It enables users to enter free-text search terms, dynamically converting them into individual chips while ensuring duplicate values are removed automatically.

This component supports two search modes: context search (default), which allows partial matches, and exact search (configurable) for strict term matching.

Sends an event to all Fulfilments in a Wave. Optionally, it can also send each event with a list of Articles and their dimensions, such as length, width, height, and weight.

Send {eventName} event with productRef attribute to the {inventoryCatalogueRef} inventory catalogue with retailer id {retailerId}

Conditionally send an event (or multiple events) to the Virtual Catalog(s) specified by their References, which passed the "Network-Match-Check".

A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).

Conditionally send an event (or multiple events) to Virtual Catalog(s) specified by their Types, which passed the "Network-Match-Check".

A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).

Conditionally send an event (or multiple events) to Virtual Catalog(s), which passed the "Network-Match-Check".

A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).

This setting is an additional check to the FETCH_USER_COORDINATE setting to decide the exception handler's behavior when the location is not available from all sources. If the location is neither provided within the order and nor fetched from the Google API then the system checks for this flag and if it is set to TRUE then the order is failed.

This setting stores the default value of the expiry time for the fulfilment of an order and is used by ScheduleFulilmentExpiry rule.The rule gets the expiry time from the event. If the value is not supplied in the event then the rule takes the value from this setting. During actual execution of the order , once the time limit reaches, the order should expire. This setting is used by clients that are not on the Rubix platform.

`fc.order.itemDetails` is a custom content component that allows displaying order item details on a drawer.

The Order Reference Module is the foundation for order-related implementations. It provides reference workflows for click & collect, home delivery and mixed baskets and those needed to build your own. Extensible by design, use this Module as a base to build a solution to your customers' needs.

Webhook notifications enable external systems to receive updates about a certain entity when it’s created or modified. These notifications are flexible and can be added at any point in the workflow - it is up to the business requirements to define when these notifications are sent. By definition, a notification is always related to a past event/fact that has already happened in the system (Fluent).

In the order update scenario, the workflow notifies external systems of any order progression or modification through its lifecycle.

API Details

Event Names:

`fc.connect.order.webhook.status-update`

This setting captures the retailer's information used to create packing slips.

The Page component is the basic top-level layout component, that renders a header bar (with user actions) and a set of children in a Material UI Grid.

The page filter select component allows to change variables on the page-level query.

The page section is a simple component that renders all children. It is primarily used for grouping multiple components together for index-based components like the tab card.

There are no properties on the page section, but standard configuration options like descendants and datasource work as usual.

This component allows rendering a title on top of the page (fc.page) component. In addition, this component can take "descendants" and render them on the right side of the component, this is useful for action buttons.

The three common use cases for the Section Header component are:

• render a title on top of the page.
• render an icon + title on top of the page.
• render an icon + title on the top left of the page, and some other component/s on the top right of the page (passed as descendants, generally a print button).

This setting is used to describe the Payment Currencies used by the Account

This setting is used to describe the Payment Methods (including Card Types) used by the Account

This setting is used to describe the Payment Providers used by the Account

The Pick list field allows for extra information to be displayed for each item within the picking step of the Wave Wizard. The purpose of this field is to enable more complex and efficient picking by providing users with more information about the item.

• The Pick list provides an expandable table that can be configured to display information in any order.
• Additional components can be added to an expandable row that is accessed on click.
• The quantity selector can be configured to start with either 0 or the maximum amount required.

When this setting is set, the ServicePoint only allows barcode instead of +/- button.

This setting is created to capture the configurable time limit for allowing the pick and pack process. This can be set to a specific number of hours.

UPSERT_LOCATION event (from the ES Starter Pack) will auto-create this setting as part of the event trigger.  Therefore, the user is not required to manually create this setting for each location.

The Print Button combines the page query with an HTML setting to generate a document that can be printed. 

A user can use this component to print pick lists, packing slips, order invoices, and more.

Send a scheduled event to each inventory position using the locationRef from the event attributes.

Send an event {eventName} to each virtual position in the catalogue which is impacted by the control update. Only VariantProduct/Location and VariantProduct control changes are considered.

The Product Card Component is a consistent way to represent product information across the applications. Alongside the typical card features it can also display an image, attributes, a count, and a close icon, while also allowing nested components for added functionality.

Send scheduled event to each inventory position using the productRef from the event attributes.

This setting stores the default values for proximity and quantity parameters to calculate the weightage to decide the order of stores in which they will be picked up for fulfilment.SearchInventoryCommonRule uses this setting.

This setting stores the default values for proximity and quantity parameters to calculate the weightage to decide the order of stores in which they will be picked up. This setting is used by `fulfilment.SearchInventoryCommonRule.` 

The Integer Range Filter component allows users to filter data by specifying an integer range. It provides two input fields: a minimum value and a maximum value, where users can manually enter one or both values. Once the range is set, the filter displays only the data that falls within the selected range.

This setting is used for the rest APIs and is used to store the conditions to create a return order/process. During a return process, if the return type is 'cannot_fulfil' or 'cancellation', then the system checks this setting value and if the value is TRUE then the system allows creation of return.

The rule rejects a fulfilment by updating the rejected quantities of all fulfilment items to the requested quantities.

This setting can be configured to identify the number of days to wait before a reminder email is sent to the customer informing them that they have an order for collection. This setting is used by clients not on Rubix platform.

Resets the virtual position

The rule resolves the longitude and latitude of the fulfilment choice delivery address. It sends specific event depending on whether the coordinates could be resolved or not.

The rule determines the longitude and latitude of an order based on the delivery address.

This setting is used to validate a retailer's location address at the time of courier booking the orders from a location. This is used by the order Booking API and Create Fulfilment API. The setting is used for clients not on Rubix platform.

This setting stores the default URL for the retailer's logo. This logo may be used in the pack slips, emails etc.

Retailers configuration contains:

• Retailer List page
• Retailer Details page

This setting contains a list of possible return conditions that can be associated with each item being returned.

These values should correspond to the different conditions in which items are physically presented to the Operation.

This list of returns conditions will be used to populate the conditions dropdown on the returns field

This Setting is created to enable/disable the Return feature in Service Point so that clients who do not use orchestrated return through Rubix do not see the feature in service point and hence are not impacted. If this setting is TRUE, then the return module is visible on Service Point.

This setting contains a list of possible return reasons that can be associated with each returned item. These values should correspond to the different reasons for customers to return items.

This list of reasons will be used to populate the reasons dropdown on the returns field.

This setting extends the Inventory domain Audit Events to include the Event Attribute Payload.

Note the default value for new accounts created after 20/08/2022 is `enabled`

Provides backward compatibility to those clients who are not on Fluent Commerce’s Rubix platform. These clients are still utilising the API driven logic that is now moved to the workflows and rules in the Rubix Platform.
If this setting is set to TRUE then the system skips the logic embedded within the APIs and goes to the Rubix platform based workflow execution.

This setting fixes the functionality where an inline event would use the status of the parent entity to confirm whether a ruleset should be triggered.

Note the default value for new accounts created after 11/11/2021 is `Enabled`

The Rules SDK is the Software Development Kit for the Fluent Workflow Framework. It allows Java Developers to build custom rules for the Workflow Framework Rule Library.

The Rules SDK comes equipped with a Java API Client for REST and GraphQL APIs, making integration of rule logic with the platform simple and quick to implement.

Fluent Commerce provides a connector certified by Salesforce using the Salesforce Reference front end architecture to accelerate integration between the Salesforce Commerce Cloud (SFCC) storefront and Fluent Order Management. This connector provides the following functionality and integration points between SFCC and Fluent Order Management:

To accelerate integration between the Salesforce Service Cloud (SFSC) and Fluent Order Management, Fluent Commerce provides a connector certified by Salesforce using their reference front-end architecture. The connector enables Customer Service Representatives to find and manage customer orders from a single application, which helps to:

• Reduce call time by managing orders from just one application
• Enhance customer experience - Shorter call times mean happier customers.
• Reduce training time - Using the familiar Salesforce UI.
• Access powerful business logic stored in Fluent Order Management.

Send an event to trigger another Ruleset for the same entity after a specified amount of time has passed.

The rule schedules an event based on the Shipment’s Delivery From date (fulfilment choice’s `deliverAfter` date).

This rule sets an expiry time for the incoming fulfilment and schedules a `FulfilmentExpiry` event.

The rule schedules an event based on the Shipment’s Delivery From date (fulfillment choice’s `deliverAfter` date).

SCIM Connector powered by Fluent is a service using SCIM protocol to integrate the Azure Active Directory and Fluent Commerce platform natively, enabling automation of user management from client Azure IDP to the Fluent platform.

The rule searches inventory based on the incoming event information using virtual catalogue reference.

The rule searches inventory based on the incoming event information using virtual catalogue with virtual catalogue ref, and sends event.

The Select Component is a field component designed for use in any form. It allows users to view a list of options as a drop-down regardless of the number of items in the list. This sets it apart from the field, which displays a drop-down only when the list contains more than three items; otherwise, it switches to a radio button group. The component supports flexible value sourcing. It can retrieve options either via a query, from a predefined setting, or from a manifest.

The rule selects a proposed fulfilment based on the inventory found in the incoming event excluding fulfilment in defined statuses.

The rule selects a proposed fulfilment based on the inventory found in the incoming event excluding fulfilments in the specified excluded fulfilments statuses.

Send an event to trigger another Ruleset for the same entity.

The rule sends event to all fulfilment choices.

The rule sends an event to all fulfilments.

This rule sends an event to the billing workflow from an order workflow with a customer's billing account information and refund information to create a credit memo of type Credit with the refund amount for the order.

The rule sets an expiry time for the incoming fulfilment based on the location’s `Pick&PackTimeLimit` and schedules a "FulfilmentExpiry" event.

The rule sends an event to the related fulfilment.

The rule sends event to the associated fulfilment choice.

This rule triggers an event to the fulfillment choice if no items were rejected during the Pack step.

The rule sends an event for the associated Order.

This rule triggers an event for the order when no items were rejected during the packing process.

The rule sends an event to the billing workflow with billing account information and entity information

Send an event {eventName} for the (current entity)

Send event {inventoryConfirmationEvent} if inventory is confirmed, or send {inventoryReserveEvent} if inventory is reserved, or {inventoryCancelEvent} if inventory is cancelled, to inventory position and include inventory quantities of type {inventoryQuantityTypes} in event attribute.

The rule sends event to the entity from the incoming event on verifying if all the articles of the incoming entity are in any of the given statuses.

The rule sends event to the entity from the incoming event if all the articles of the incoming entity are in one of the given statuses.

The rule sends event if all fulfilment choices of entityType have statuses from the specified list.

The rule verifies if all fulfilments for order are in defined statuses. If yes then send an event to order, else no processing.

The rule verifies if all fulfillments for fulfilment choice are in given status. If yes, then it sends an event to the fulfilment choice, else no processing.

The rule sends an event to current Order when for all items in the Order, sum of `filledQty` of fulfilments in defined statuses, `rejectedQty` of fulfilments in defined statuses and `requestedQty` of fulfilments in defined statuses matches the `requestedQty` of the Items in the Order.

The rule verifies if any fulfilment in the incoming order is in one of the given statuses in the input parameter. If yes then the rule will send an event to order, otherwise no processing is done.

The rule sends and event with the name specified in the input parameter in case the incoming entity has an attribute name and value that matches with the name and value provided in the input parameters. Otherwise, a no match event is sent.

The rule verifies if the incoming consignment entity has the label URL and the consignment status from input parameter is a success or failure and sends an event.

This rule is executed when no items are packed into parcels and all items are rejected.

This rule triggers an event when items are packed into parcels without rejection.

This rule is executed when both packed items and rejections are present.

Send an event {eventName} to inventory quantities of type {inventoryQuantityTypes} using event attributes

The rule sends an event to the incoming fulfilment entity if the fulfilment choice is in any of the statuses provided in input parameter.

The rule sends an event to the incoming fulfilment entity if the parent order is in any of the statuses provided in input parameter.

The rule triggers inventory re-calculation event with event name provided in the input parameter with +/-ve quantities of each item on the basis of the type of operation.

Send an Event payload to an external system, defined by a Setting configuration.

This rule is executed to update item quantities and record rejection reasons when items are rejected.

Change the Status of the current Entity to the value provided.

Shipment Details drawer is a custom content component that displays detailed information about a particular shipment on a drawer.

Notifies the inventory positions of the incoming deltas with event `{eventName}`

Notifies the inventory positions of the incoming updates with event {eventName}

This setting is added when an Account is SSO enabled. This setting contains details about the specific SSO provider environment for this Account

The Tile Metric component can be used to display a metrics data and the title of that metric within a single tile.

This setting is used to determine whether a Distribution Center (DC) fulfilment is allowed as a final attempt. If this setting is set to TRUE then the system attempts to create one last fulfilment from the DC for the unfulfilled items of the order that can not be fulfilled by a store or store network. The setting is used for clients not on Rubix platform.

FOR HD ORDER, SHIPMENTTYPE = HD_PFDC

FOR CC ORDER, SHIPMENTTYPE = CC_PFDC

This setting stores the data to compute the Service Level Agreement (SLA) when there is an article that needs to be moved from one store to another store. The following logic is used to determine the SLA:

• ETA FROM BOTH STORES.
• GREATER OF ( from_Store ETA) AND ( To_Store ETA)
• ETA OF from_Store
• ETA OF To_Store
• ETA FROM THE SETTING
• DEFAULT VALUE OF 3 HOURS

The rule sends an event to the related articles.

• The Activity component displays events and related entities for a lifecycle of the entity that the page represents.
• This document describes what is an activity component, its properties, and sample usage.

The customization of the pick list is created using a custom template stored in this setting that can be triggered using a request.

Makes Webhook retries for custom Webhook rules using custom Webhook rule logic instead of the default logic.

Configures the Webhook retry schedule with an escalating back-off pattern.

Improves Workflow performance by preventing context.getEvent() from making excessive GraphQL calls.

Update an Aggregate Virtual Position and calculate its Available-to-Sell (ATS) quantity.

Aggregate Virtual Position ATS calculation is based on the associated Inventory Positions Stock on Hand (SOH) quantities and the applied Controls.

The associated Inventory Positions are defined with:

• The given Product Reference
• The list of Locations for the given Network (the first Network assigned to the Virtual Catalog)
• The specified Inventory Position Statuses

Updates a base virtual position

Adds or removes categories from the standard product based on the information provided in the event

Adds or removes categories from the variant product based on the information provided in the event

Update a category based on the information provided in the event

Updates the value of a control with the event attribute value.

The rule updates longitude and latitude of the fulfilment choice delivery address based on the incoming event information.

The rule updates fulfilment type field.

Updates the status of inventory quantities to status {status} which belong to the inventory position and are of type {filterTypes} and in statuses {filterStatuses}

Updates an inventory quantity of type {type} using the event attributes.

Update the onHand value of the Inventory Position according to the event attribute {InventoryPositionOnHandCalculated}

The rule provides the foundation to update the order Item attribute with the previously identified returnable quantity amount.

The rule updates original order attribute with link to new revised order reference.

Update a standard product using the information provided in the event

Update a variant product based on the information provided in the event

Create or Update an Inventory Quantity.

The inline user action generates a form from a workflow-configured user action and places it directly into the page as a card.

This is useful when the main reason for a page existing is to trigger that user action, especially when coupled with the conditional component to create a wizard-like flow.

The rule validates that appeasement amount does not exceed the original total order price.

Validates the incoming category event for the existence of the parent and child categories

Validates the incoming category event

Validates the incoming product payload

The rule verifies the delivery address of the order, sets the address coordinates accordingly and sends out an event.

Validate the incoming Product event to confirm that the given Categories already exist.

The rule provides the foundation to validate that the return request is valid.

The rule validates the revised order request before canceling the existing order.

Validates the incoming standard product payload

Validates the incoming variant product event payload

The rule verifies billing account existence, sends event to the billing account workflow, or creates billing account if none found, before the return is initiated.

The rule verifies the quantity of items fulfilled in the incoming fulfilment entity and sends the corresponding event when it matches the quantity from the input parameter.

Provides backward compatibility to clients not yet on Fluent Commerce's Rubix platform. 

The Wizard page component is an alternative top-level layout component for displaying multi-step wizard-like flows, like the wave pick/pack process.

It takes a set of "step" configurations, and chooses which user actions and other descendants to display based on the conditions provided in those steps. 

Describes the usage of `fc.page.wizard.action`.