Docs
Search
Search
Help & Feedback
Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases
Configuring Components
How to configure components
Configuring Fluent Analytics Studio Dashboard Filters
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Dashboard filters are configured through
Analytics Dashboard Component
settings.
Filters can be applied to an entire dashboard or individual metric tiles.
Hidden filters are applied automatically and are not visible or editable by end users.
Filter keys must match filters already defined within the dashboard configuration.
Available dashboard filters and supported filter keys are documented in the dashboard configuration examples included in this guide.
Enable sorting for the Print Button
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Configure sorting for any Print Button using the sort property and a matching setting
Use
`arrayPath`
to define which array should be sorted
Use one or more sorting rules to define sorting priority
If sorting is not configured, the Print Button behavior remains unchanged
Sort on fields from transformed attribute data using dot-separated field paths (for example,
`sku.attributes.byName.Size`
)
Configure the Application Switcher
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
The Application Switcher is displayed in the Fluent application header and allows users to switch between available Fluent applications
The Switcher is displayed only when users can access more than one application. If only a single application is available, it is hidden
Application visibility is configured through the
`fc.mystique.apps`
setting, which defines the applications available in the Application Switcher and the conditions under which they are shown
Application visibility is evaluated independently for each configured application
Role and context-level filters may be combined. To grant users access to an application, assign the required permissions through roles.
The
`fc.mystique.apps`
setting controls visibility only and does not grant permissions
Application labels reference translation keys. A corresponding translation entry should exist for each configured label, so application names are displayed correctly in the UI. If no translation entry exists, the key string is displayed in place of the application name
Enable Return Order with Exchange in Fluent OMS
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Eligibility & Conditions
– Clearly define the conditions under which an item can be exchanged, such as time limits, product conditions, and receipt requirements.
Exchange Process
– Outline the step-by-step process, including how customers initiate an exchange, return shipping details, and replacement timelines.
Inventory & Availability
– Ensure the desired replacement item is in stock and provide alternatives if it's unavailable.
Refund vs. Exchange Policy
– Specify whether price differences will be refunded or charged.
Customer Communication
– Keep customers informed at every stage with order tracking, confirmation emails, and support availability.
Configure UI for Mixed Baskets
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Mixed basket functionality is not covered in Fluent's base default pre-configurations.
In order to enable mixed basket functionality on the UI, you would need to modify the manifest and add a few settings. The process is explained in detail in this article.
Settings Template on the UI
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
It is possible to configure fields as a dropdown and sort the order of displayed field on the UI within OMX framework
Add Comment Workflow Template Overview
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Configuration
Add Order List Page into Fluent Store
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Guide for a user to add an order list page into Fluent Store.
Image capture of Returned Goods during Return
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
This idea/solution will provide a new feature where the Store User can take a photo of the returning item and attach it as part of the returnOrder entity.
The source code will not be provided in this article.
Compress the Order List view
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Fluent OMS can display the order list in two ways: Compressed and Standard.
The manifest needs to be modified in order to enable the compressed view.
Add a Comment to Order
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
A Comment provides an additional piece of information to the entity it is related to.
An Order can contain multiple comments associated with it.
Create Order Wizard
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
The 'Create Order' wizard streamlines the order creation process by guiding users through each step, reducing the chances of errors, and ensuring all necessary information is captured.
It provides a user-friendly interface that simplifies complex order configurations, making it accessible for users with varying levels of technical expertise.
The wizard includes validation checks at each step, ensuring that all entered data is accurate and complete before proceeding to the next step.
Validate Customer ID at Pickup
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
This idea/solution will provide an extended new feature where the Store User can validate the Customer ID during the Customer Collection Process.
New custom UI components and rules are needed to capture the user input and confirm the selected articles in the UI user Action screen. Then, the store/business can track and trace the proof of the shopper's collection.
Due to security reasons, the shopper's sensitive personal information should not be stored within Fluent OMS. Therefore, the proof of collection should be stored at a third-party storage.
Enable entering of Rejection Reason Code during pick confirm in Fluent Store
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
This idea/solution will provide a new feature where the Store User can enter the rejection reason code during the Pick Confirm Process.
This feature allows specifying the rejection reason for fulfillment on the picking step of wave processing. The user can select the rejection reason code when the picked item list is confirmed as the first step of wave processing.
Enable location store users to update store hours
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Each location has an opening hours setup that can be used for store activities. One activity could be during the fulfillment allocation phase, where the fulfillment expiry time for a store is calculated, giving store staff sufficient time to process the order before it expires.
Since opening hours can change week by week, we have created this guide to showcase how you can enable Store Managers to make these changes directly in the Fluent Store Web App.
Extended Component For Unified View Of Location, Networks & Catalogues Data
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Provides a unified view of locations, networks, and associated catalogues.
Easy for setup validation, store rollouts, and business visibility for location-to-network mappings.
Includes search, predefined filters, and highlighting for relationship tracing.
Helps to maintain data validity by identifying unused or missing associations
Custom UI Field Component on Add Network to Location user action
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
This component simplifies the addition of networks to locations by providing an easy to use selector of available networks
The basic principles can be used in other scenarios where complex fields and values may be required
Create a Template helper to display the createdOn date in a specific time zone
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
This article provides an example on how to create a simple template helper which can be used in the mystique manifest.
With this template helper, the user is able to see the order in "local" created date/time. For example, the order was placed at Adelaide and the customer service representative in Sydney would like to see the order date time in Adelaide time zone.
Here are the steps to implement the template helper by using
Component SDK
:
Create a new function in component SDK
Import and register the template in index.tsx
Add the template to the mystique manifest in the setting
Configure a drawer via manifest
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Drawers can be added in any mystique components by modifying the mystique manifest.
The drawer’s custom data source can be defined via queries and variables.
Provides Product Availability via UI custom component
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Provide accurate product availability information to user.
Implement a user-friendly search and filter functionality to help users find products quickly.
Include clear and concise product descriptions, along with images.
Offer alternative suggestions for out-of-stock items.
Enable quick access filters for users with a custom Predefined Filter component
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Predefined Filters:
Provide a way to access commonly used search parameters with a single click, enhancing the user experience.
User Efficiency:
Predefined filters are designed to save time and streamline workflows.
Customization:
Users may have the ability to create and save their own filters for recurrent use (via manual Manifest changing).
Consistency:
Predefined filters ensure that the same criteria are used for searching, leading to consistent results.
Learning Curve:
New users can quickly become proficient in finding the information they need due to the intuitive nature of predefined filters.
Integration:
These features should seamlessly integrate with the user interface for maximum effectiveness.
Display REST API Data in Standard Library Components
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
For Frontend (React) Developers who are familiar with using the
Fluent OMX Component SDK
Build a REST API Data Provider Component to enable the
standard Component Library
to render data from the
Fluent Platform REST APIs
Learn how to override the data provided to components
Learn how to support template value props for dynamic input
Learn how to decorate the query results for enabling
`byName`
attributes access in the manifest
Add and Edit Customer Address by using custom UI component
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Address Validation:
Ensure that the address entered by the user is valid and correctly formatted to avoid shipping issues.
Default Address:
Allow customers to set a default address for a quicker checkout process.
Edit Capability:
Provide an option for users to edit customer address details in case of errors or changes.
User Experience:
Design the add and edit address process to be user-friendly and accessible, with clear instructions and error messages.
Quick Search in UI by using Custom UI Component
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Quick Search Functionality:
Enables users to find information rapidly by typing keywords or phrases.
User Efficiency:
Quick search is designed to save time and streamline workflows.
Learning Curve:
New users can quickly become proficient in finding the information they need due to the intuitive nature of quick search.
Integration:
These features should seamlessly integrate with the user interface for maximum effectiveness.
Manual Fulfillment Reassignment
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
This idea/solution will provide a new feature where the Store User can enter the rejection reason code during the Pick Confirm Process.
This feature allows customer service to reroute an existing
`fulfilment`
to a specific location that can fulfill the order.
Manual Inventory Position Changes through the UI
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
This idea/solution will provide an extended new feature where the Store User can update the Store inventory through the UI to ensure the OMS has the most accurate product inventory.
New custom UI component and rules to capture the user input in the UI user Action screen. Then, the backend will create a new Inventory Quantity entity and update the Inventory Position and the downstream workflow.
Create Customer via UI
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Comprehensive Data Entry:
Ensure that all necessary customer information is captured accurately to create a complete profile. This includes personal details, contact information, and any specific requirements or preferences.
Validation and Verification:
Implement validation checks to prevent errors during the data entry process. Verify that mandatory fields are not left blank.
User Experience:
Design the customer creation process to be user-friendly. Provide clear instructions and feedback during the process to enhance the user's experience and minimize the likelihood of errors.
Edit Customer via UI
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Data Modification:
Ensure that users can modify customer data, including the ability to correct typos in existing information.
Error Handling:
Implement error handling procedures in case the edit fails or invalid data is submitted.
User Experience:
Aim for a seamless and intuitive editing process to minimize the risk of user errors.
Enable Sorting in a Picklist
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Properties of CUSTOM_PICK_LIST_SORT_CONFIG Setting
Create a mystique manifest page for testing component Examples
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
A step-by-step guide to show how to create a new manifest page.
This new manifest page will be used to play around with Component SDK examples from the other articles.
Display JSON data in OMX
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
[Warning: empty required content area]
Display full attribute value on the Screen (specially on phone/tablet view)
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
In the current OMX (OMS webapp and STORE), depending on the user’s resolution, it will render the contents to fit within the screen. For some string that are longer than the screen’s width, The OMX will be showing “…" at the suffix.
To overcome this issue, you can use charCutoff in the manifest.
Migrate to the New Print Component
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
The new print component enables faster printing and additional features.
You can update to the new print component by updating the component name and adding the relevant configuration.