Recently Updated Guides

Some of the recently updated How-to Guides.

OMX Webapp UI - Search order by customer phone number or email

How-to Guide

This is an enhanced feature that allows users (e.g., Customer Service Representatives) to look up customer orders by using either the customer's email address or phone number.
This feature can be achieved by configuration in the setting manifest without any custom components nor custom rules.
This article will provide the following:
- code snippet of the search Order by Customer phone/email manifest
- Language settings
- Display the page on the left panel menu by adding a code snippet in the setting:
```
`fc.mystique.manifest.oms`
```

Module Recipe - How to create an Extension Module

How-to Guide

Describe the steps to create a new module with a custom plugin
TL;DR from module creation to installation:
Create:
```
`fluent module create`
```
Update
```
`resources/module.json`
```
with the module's version, dependencies and module name
Add in the source code + unit and integration tests under the
```
`plugins/`
```
folder

Bootstrap an account using the Fluent CLI

How-to Guide

Create a profile
Create a retailer
Configure and Install the Fluent Reference Modules
Configure and Install the Extension Data module
Validate the Account setup

Module Recipe - How to create an Extension Data Module

How-to Guide

Describe the steps to create a new Data Module
Use B2C Sample data for reference
Build and Install the Extension Data Module

Module Recipe - Plugin Setup and Installation Guide

How-to Guide

Create the new module:

`fluent module create -n <module-name> `

Populate the plugin structure in
```
`plugins/`
```
```
`rules/`
```
- Contains rules, unit tests and GraphQL queries/mutations
```
`types/`
```
- Stores model classes and extended DTOs
```
`util/`
```
- Holds service classes and utilities
Build the module:
```
`./scripts/build-module.sh`
```

Install the module:

`fluent module install dist/<module-name>-<version>.zip -p <profile> -r <retailer>`

Using Predefined Values in Order Tag Filters

How-to Guide

The
```
`tag1`
```
,
```
`tag2`
```
, and
```
`tag3`
```
filters allow users to filter orders based on an exact match of the entered value.
These filters can be configured to use predefined values instead of a text input field that is available out of the box, enhancing usability and consistency.

Enable the Status Filter with Predefined Values

How-to Guide

Target audience: Configurers or Fluent Partners.
The guide explains how to successfully configure the status filter with predefined values.

Configure Bulk Threshold Controls to manage Inventory and Virtual Positions Statuses

How-to Guide

Use Bulk Threshold Controls to manage Out of Stock and At Risk Statuses for Inventory and Virtual Positions
Create Control Groups for Inventory and/or Virtual Catalogs to respectively apply Bulk Threshold Controls
Configure Bulk Threshold Controls with:
- Context
- Threshold
- Status
- and Execution Order

Custom UI Field Component on Add Network to Location user action

How-to Guide

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

Switch Store Locations

How-to Guide

This guide shows you how to seamlessly switch Store Locations within the Fluent Store web app
This guide is aimed at In-Store users

Create a Custom Ruleset for Batch Inventory Input for Custom Quantity Types

How-to Guide

Preprocessing Disabled (Skip Enabled): If preprocessing is disabled (set to skip), all event items are passed as is, regardless of changes.
Preprocessing Enabled: If preprocessing is enabled, only changed items are passed through as events.
Event Structure: The batch input includes optional fields, and default values are set if they are not provided.
Event Name: If you specify a custom event name in the batch input, it will be used in the resulting event. If not, the default event name is
```
`"InventoryChanged"`
```
.

Azure AD & Microsoft Entra ID SAML Configuration: Unified Guide

How-to Guide

It is possible to use the generic SAML configuration to add an external identity provider that follows the SAML standard.
Steps to configure an external identity provider via SAML configuration

Azure AD & Microsoft Entra ID OIDC Configuration: Unified Guide

How-to Guide

Adding the application to PingOne
Registering application with Microsoft
Getting the client ID and client secret for the application
Setting up API permissions
Adding the identity provider in PingOne
Adding the Redirect URI to the Microsoft portal
Do not forget

Configuring the Unified View of Inventory: A Step-by-Step Guide

How-to Guide

The Unified View of Inventory (UVOI) is a powerful feature available out of the box. It offers comprehensive insights and real-time updates across inventory locations and sales channels.
To configure its full functionality, you need to create several settings that define default filter values and ensure filters are populated with appropriate statuses from workflows.
This guide will walk you through the configuration steps using examples from a reference solution. Note that the statuses and catalog names of these examples may differ from your specific implementation requirements.

Enable Batch Inventory Pre-Processing

How-to Guide

Inventory Batch Pre-Processing (BPP) occurs before batch inventory updates reach the workflow engine. If you rely on every incoming inventory item hitting the workflow, ensure you configure the job-level meta value appropriately or disable BPP at the relevant account/retailer level. However, we recommend using the job-level option for greater flexibility. Be sure to read through this article in full—especially the “Managing Batch Pre-Processing” section—before making any changes.
If enabled at an ACCOUNT level, every retailer under that ACCOUNT will have their batch inventory updates pre-processed
If enabled at RETAILER levels, it will only pre-process updates for that specific retailer
The RETAILER context setting overrides the ACCOUNT context setting. This allows you to enable the whole account and disable it for specific retailers.

Configure a Master Retailer Inventory Catalog notifying Sub-Retailer(s) Virtual Catalog(s)

How-to Guide

Create your Master-Retailer Inventory Catalog
Create your Sub-Retailer(s) Virtual Catalog(s)
Configure your Inventory Catalog Workflow for Cross-Retailer events sending

Enable Phone Camera scanning in Fluent STORE Picking

How-to Guide

A step-by-step guide to enable phone camera scanning for product picking.
Configuration

Customise the Printable Pick List with GraphQL

How-to Guide

This feature gives the client greater flexibility in customising the pick list by extracting values via GraphQL.

The feature is not limited to a pick list but can be used on any entity as long as the data can be extracted by GraphQL.

This feature utilises the new print component

Create a new Inventory Feed via GraphQL API

How-to Guide

After following this guide a user will be able to create a new Inventory Feed
The output from this feed can be used to supply inventory availability data to any system
Additional steps will outline optional configuration that can be applied to Inventory Feeds

Overriding the default manifest

How-to Guide

The UX Framework in the Fluent platform automatically checks for configured manifests in Account settings. If none exist, the Fluent web app defaults to loading using baseline manifests within the platform, ensuring a seamless and standardized user experience.
To customize the main web app manifest or specific fragments, users should follow the naming convention, with the setting name for the main web app manifest file.
It is recommended to override the main manifest only when adding or removing fragments; otherwise, users can efficiently modify specific fragments by overriding them individually.

Submit Inventory Batches With Attributes

How-to Guide

Create new Inventory Batches using the Job API
Sample Inventory batch payload
Inventory batch details

Filter Panel: Configuration, Customization, and Best Practices

How-to Guide

This guide provides step-by-step instructions on setting up and customizing the Filter Panel component to filter data effectively, whether on standalone pages or embedded within the List component to filter an inner list.
Discover how to define data sources, integrate custom queries, and display query results seamlessly using descendant components.
Explore options to customize fields: modify field types, set default values, rearrange the field order, and remove unnecessary fields.
Unlock the component's key functionality—synchronizing filter data with the URL. This enables easy sharing of pre-filtered views through links.
Learn how to configure default filter values using settings for a streamlined and consistent user experience.

Complex Filter Configuration: Tips and Techniques

How-to Guide

This guide offers step-by-step instructions for setting up and customizing the Complex Filter component to achieve precise and efficient data filtering.
Learn how to set up data sources, use GraphQL queries, and display results easily with card components like Standard Card and Product Card.
Discover how to customize fields by changing their types, adjusting the field order, and removing unnecessary ones to make the filter simple and effective for your needs.

Convert workflow statuses list to CSV Excel table format

How-to Guide

A step-by-step guide how to convert workflow statuses list into CSV / Excel table format

Update Fulfilment Choice status via EVENT API

How-to Guide

An easy step-by-step guide on how to add a new ruleset to update fulfilmentChoice status.
This example can be used on the MULTI order type (mixed basket) workflow.

SSO: Configure Google Workspace connection via SAML

How-to Guide

This guide covers setting up an SSO connection between PingOne and Google Workspace using SAML.
Ensure you have admin access in PingOne and a Google Workspace account with an active subscription.
You need to register the application in Google Workspace to configure it as an external identity provider.

Enable Store Associates to assign Items to Parcels

How-to Guide

This guide is intended for implementers who are enabling the capability for Store Associates to assign items to parcels.
The guide outlines the steps to configure the assign items to parcels capability, including updating the necessary modules, workflows, settings, and user permissions to ensure smooth implementation in the Fluent Store.
Before proceeding with this guide, it is recommended that you are familiar with the following concepts: Adding a Workflow to your Retailer via API, How to Override the default manifest, How to Display Colored Dots, Configure Printable Order Labels, and Configure Printable Pack Slips.

Set up a new Account with Reference Modules and B2C sample data.

How-to Guide

Create a profile
Create a retailer
Install the Fluent Reference Modules
Install B2C Sample Data modules
Validate the Account set up

Using the Setting Form Component

How-to Guide

This page will guide you through placing the Setting Form Component on a page and customizing it for use by a business user. Key topics covered include:
- Adding the component to a page
- Using the component within an Accordion component
- Generating a schema for a setting
- Adding titles to individual fields
- Using the component with custom fields

Getting Started with the Fluent CLI

How-to Guide

Overview
Prerequisites
Installation
Next Steps

SSO: Configure JumpCloud connection via SAML

How-to Guide

It is possible to use the generic SAML configuration to add an external identity provider that follows the SAML standard
This page provides a guide on how to configure an external identity provider via SAML configuration.

Display JSON in Mystique (Admin Console)

How-to Guide

Often you might need to display JSON payload on the Admin Console
You can use a mustache helper, or you can display individual values with deep references

Storing HTTP links on Entities with Attributes (Admin Console)

How-to Guide

This guide is about displaying HTTP(S) links in Admin Console.
This can be achieved through a Mystique configuration.
Store a HTTP(S) link to a document e.g. packing slip as an attribute against an entity.
Display the attribute as a clickable link in the Admin Console.

Configure Printable Order Labels

How-to Guide

Use an HTML template to tailor the Order Labels to your specific needs.

This document provides step-by-step instructions for setting up and modifying fragments needed to customize generated PDFs.

Pack Field Component Sections Configuration in Fluent Store

How-to Guide

This guide will walk you through configuring the main sections of the Pack Wizard: Unpacked Items, Packed Items, Rejected Items, and the scanner, enabling you to tailor it to your specific requirements.
The default configuration does not include a list of parcel types with predefined dimensions. It only displays basic details of the items being packed (such as image, product name, and reference) and allows users to select from four predefined reasons for rejecting items.

Appeasement Workflow

How-to Guide

User action capability is used to create a Refund against an Order. Order workflow should be extended to have a rule to capture appeasement requests and then process them by looking up the billing account of that customer and creating a credit memo of that refund amount.
It is possible to configure Appeasement functionality via UI and via Postman.

Configure Printable Pack Slips

How-to Guide

The Pack Slips can be customized using an HTML template.
This guide outlines the setup and fragment modifications required for generated PDF customization.

Enable Fluent Store on your Existing Account

How-to Guide

Verify Compatibility: Ensure your existing account meets all prerequisites for enabling Fluent Store.
Follow Step-by-Step Guide: Adhere to the provided instructions to enable Fluent Store on your account seamlessly.
Utilize Support Resources: Refer to the official documentation and support channels for any issues or queries.

Adobe Commerce Connector Setup and Configuration

How-to Guide

This guide covers setting up a fresh new Adobe Connector in the below-required systems:
- Fluent OMS information details (account credentials, client secret, etc.)
- Adobe Commerce
This guide does not cover:
- The standard setup of Fluent OMS, this guide is explicitly for the Fluent Adobe Connector configuration.
- Detail on how to migrate an existing Adobe Commerce to use Fluent OMS.
Please get in touch with Fluent Expert Services for guidance on any migration.

Switch Retailers

How-to Guide

This guide shows you how to seamlessly switch Retailers within the Fluent Order Management System web app.
This guide is aimed at multi-retailer Admin users.

Add a new order and fulfillment type to Fluent Store

How-to Guide

Understanding the default Order and Fulfilment Types
Users with SETTING_VIEW, SETTING_CREATE, and SETTING_UPDATE permissions can add new order and fulfilment types to Fluent Store.
A guide to add a new Order Type to customise the Fluent Store
A guide to adding a new Fulfilment Type to customise the Fluent Store

Hiding WaveCreate button if there are no awaiting_wave fulfilment for the location.

How-to Guide

OOTB, the create wave button on Fluent Store will always be displayed whether there are pending fulfilments or not.
It’s possible to only display the button when there are pending waves when a condition is added.

Adding a Setting to a Workflow

How-to Guide

It’s possible to add settings to a workflow via Json in order to improve the performance and the functionality of the workflow.

Create an empty Workflow

How-to Guide

A new Workflow creation requires the correct permissions for the user, and a valid workflow JSON file (schema,
```
`entityType`
```
and statuses/rulesets).

Adding Header Components to an OMX Web App (Store, OMS, Inventory etc)

How-to Guide

A step-by-step guide on how to add a custom help menu to the header to serve as inspiration for other custom components that can be added

Display Order Items On The Customer Collection Screen

How-to Guide

It’s possible to enhance Service Point to show order items from the current order on the collection screen.
This can be achieved by adding a specific setting and making sure that the user’s role has the appropriate permissions.

Install Fluent Modules into your sandbox

How-to Guide

step-by-step guide on how to install modules into your OMS sandbox

Settings Template

How-to Guide

Settings Template

Enable quick access filters for users with a custom Predefined Filter component

How-to Guide

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.

Cash on Delivery workflow action

How-to Guide

Understanding the Market: Recognizing the importance of Cash on Delivery (CoD) in markets like India, where it is a preferred payment method.
Global Adaptability: The workflow's design serves a global audience, providing a template that can be customised for regions where upfront payment is not the norm.
Seamless Integration: Ensuring the CoD process is smoothly incorporated into the existing order journey to enhance customer experience.
Operational Efficiency: Streamlining the CoD transaction to ensure quick and secure payment collection at the point of delivery.

Display REST API Data in Standard Library Components

How-to Guide

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

Debugging the Component SDK

How-to Guide

Using Chrome developer tools and IDEA Webstorm to debug Fluent component SDK
This article will only work for Chrome desktop browser

Enable bulk order Cancel in the UI by using the action property in the LIST component

How-to Guide

To enable cancelling orders via the UI the cancel order ruleset needs to be used
Update the mystique manifest to show the list action.

Order Revision Workflow Templates Overview

How-to Guide

Order Revision implementation can be done either from the UI or via Postman.
This implementation requires workflow changes and adding a few specific settings. The detailed process is covered in this article.

Revise Order

How-to Guide

Order Revision User Guide

Displaying order attributes byName in Fluent Store in PACK screen

How-to Guide

step by step to teach you how to add order attribute values into the PACK screen in STORE APP
the byName function will allow OMS to display the specific attribute value on the UI.

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

Add and Edit Customer Address by using custom UI component

How-to Guide

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

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.

Configure extended address for Return Orders

How-to Guide

Extend the Order Module schema
Modify the Rule for Return Order creation and the Order Workflow Return Order Ruleset
Update the Order Management Manifest

Image capture of Returned Goods during Return

How-to Guide

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.

Enable entering of Rejection Reason Code during pick confirm in Fluent Store

How-to Guide

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.

Manual Fulfillment Reassignment

How-to Guide

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.

Validate Customer ID at Pickup

How-to Guide

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.

Manual Inventory Position Changes through the UI

How-to Guide

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

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

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

Properties of CUSTOM_PICK_LIST_SORT_CONFIG Setting

Enable Return Order in ServicePoint

How-to Guide

Step-by-step configuration guide to enable Returns functionality in ServicePoint.
The configurations include the following:
- User Role assignments
- Settings
- workflows

Fluent STORE - Manager Approval Process for ReturnOrder

How-to Guide

A Client Business Requirement:
- The returnOrder created by Store Staff must require a Manager’s Approval
- 2-step process to ensure the customer is refunding the right products/amount. This is done through workflow and roles/permissions modifications.

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

Configure a drawer via manifest

How-to Guide

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.

Settings Creation and Editing Mutations

How-to Guide

A setting can be added or modified directly via UI.
A new setting requires its name, context, the identifier of the context, the value, and the value type.

Updating a Workflow

How-to Guide

A Workflow can be updated as long as the user has the right permissions.
A Workflow can be updated via the IMPORT/EXPORT button or via API.

Creating a new connector with the Connector SDK

How-to Guide

The Connector SDK generates a blank Maven starting project for your custom integrations.

Deploy and Run your Rules SDK project

How-to Guide

A step-by-step guide to deploy your custom Rules Plugin and run the project.
A fully setup and functioning Fluent Account is required.
An API User with the
```
`DEVELOPER`
```
role (Note: If using a Training Account, the Account Admin already has this role applied)

Write your first custom Rule using the Fluent Rules SDK (Hello World)

How-to Guide

A step-by-Step guide to creating your first custom Rule to log "Hello World"

Create a new Rules SDK Plugin Project

How-to Guide

A step-by-step guide to creating Rule SDK Plugin Project.
The Rules SDK comes with a Maven Archetype for generating a new Rules Plugin Project, and a handy script file to run the project generation steps.
A fully setup and functioning Fluent Account is required as of this activity.

Setup your Development Environment for Rules SDK

How-to Guide

Step-by-step guide to setup Rule SDK in your local Environment.

Rules SDK - Debugging Rules

How-to Guide

the best approaches to debugging your custom rules and plugins
Debugging locally in your IDE can be done as per standard Java practice while running rules in Unit Tests or with the TestExecutor.
Debugging on Sandbox - The primary mechanism for debugging on a deployed environment is by activity tracking or Orchestration Audit Events. You can easily query these for any context via the Event API, or the Admin Console.

Create a Fluent GraphQL API in Postman

How-to Guide

Open Postman, click Import, then choose "Upload Files" in the dialog box.
Upload the GraphQL SDL File named
```
`fluent-graphql.graphql`
```
.
Confirm settings, including "Include deprecated fields," and click Import; a success message confirms installation in the APIs tab.

Configure UI to display IPU and IPC reports

How-to Guide

The Fluent Big Inventory Web app is pre-configured with certain standard functions.
The IPU and IPC reports functionality is not a part of the default configuration.
This guide will enable users to configure the web app to display the IPU/IPC reports.

Enable Store Associates to select Fulfilments to add to Waves

How-to Guide

This guide explains how to enable Store Associates to select Fulfillments to add to a Wave in Fluent Store.
Once this capability is enabled in Fluent Store, Store Associates can filter and select Fulfilments (including by custom attributes) to be added to a new Wave.
This guide will require knowledge of how to configure your manifest and workflow. If you wish to extend this functionality even further, you'll need to be able to compose rules.

Manage and view Inventory Feed Runs

How-to Guide

Inventory Feed runs can be individually tracked for their status and data about the run
A user will know how to analyse Inventory Feed Runs from this guide

GraphQL mutation removeUserRolesFromUser

How-to Guide

Quick Example of how to use GraphQL mutation
```
`removeUserRolesFromUser`
```

SCIM Local Development Setup

How-to Guide

Local development uses localstack to emulate AWS services
AWS CLI Configuration is optional
IntelliJ and Eclipse / STS Setup in local environment

Role Creation and Editing Mutations

How-to Guide

When creating or editing roles, ensure to define permissions accurately to maintain system security.
Follow the best practices for naming conventions and role descriptions for easier management and clarity.
Test role changes in a controlled environment before applying them to the live system to avoid unintended access issues.

Enable location switcher in Fluent Store

How-to Guide

Location context switcher allows you to switch the location without having to log off and back in with the specific credentials. This is feasible as long as the user permissions are configured accordingly.
The context switcher requires a few manifest modifications, which are detailed in the article below.

Supporting SKU with multiple barcodes during the picking

How-to Guide

A typical scenario where the EAN 13 barcode (e.g.,
```
`0123456789123`
```
) and sometimes the barcode on the physical product might not include the leading 0. So when the product gets scanned, it will return
```
`123456789123`
```
rather than
```
`0123456789123`
```
, and the Pick screen will not be able to find the product from the pick list.
We can utilize product attributes to include possible barcodes and to include fields.

Authenticating (logging in) into Fluent

How-to Guide

Login into Fluent Web Apps
Multi-Factor Authentication
Session Timeout

Update your Plugin Project for JDK 17+

How-to Guide

A step-by-step guide to update your plugin Project for SDK 17+

Convert a JSON Introspection result to Schema Definition Language (SDL)

How-to Guide

Converting JSON Introspection to SDL allows for a human-readable format of GraphQL schema, which is essential for documentation and understanding the API structure.
Tools such as GraphQL Voyager and Apollo Studio can automate the conversion process, providing a visual representation and SDL output without manual coding.
Understanding the structure of the introspection query result is crucial for manually converting the JSON to SDL, should automated tools not be available or suitable.

Generate a Collection of the Fluent GraphQL API

How-to Guide

Prerequisites
Steps to Follow

Fluent OMS session timeout configuration for SSO users with Azure as an external IDP

How-to Guide

The article offers a step-by-step configuration for setting up Fluent OMS session timeout specifically tailored for Single Sign-On (SSO) users.
It focuses on configuring session timeout within Fluent OMS while utilizing Azure as the external Identity Provider (IDP).

Configure session timeout for SSO users with external IDPs (Okta)

How-to Guide

Configure Fluent OMS session timeout for SSO users with external IDPs (Okta)

Customise the Printable Pick List Setting

How-to Guide

To aid with the picking process, Users can download a printable pick list that details the items required to complete the outstanding fulfilments. Customisable via a setting, the custom pick list allows developers to define their own fields and layouts to create a more efficient picking process.
Enabling the Custom Pick List

Identify Inventory Failed Events

How-to Guide

Detect Inventory problems or anomalies with the Total Failures card on the Sources Dashboard.
Identify the specific failure events with advanced filtering on the Events page.
Understand the what, where, and why of the event failure by using the Event Details Drawer.

Displaying the date time in OMS and STORE web apps

How-to Guide

Fluent OMS apps support time-zone-specific display of date and time values in the UI.
It is a good practice to store the date-time value in UTC format and let the OMS UI display the value based on the user's locale.

Azure Single Logout configuration

How-to Guide

The article offers detailed instructions for setting up Single Logout (SLO) for Azure AD, serving as an external identity provider.
Users can establish a robust authentication system by following the precise steps outlined, enhancing security and efficiency.

Product Availability Enrichment

How-to Guide

You would first need to have access to a Fluent account, and have
```
`localstack`
```
container running.
There are two possible cache configurations: In-memory cache or External cache.

Adobe Commerce Connector Package Installation

How-to Guide

Prior to installing the Adobe connector package, make sure that the versions are compatible.
In order to install the connector package, you would need to back up the system and the data base, download the package, enable the module and confirm the installation.

Creating Mystique Manifest list page by using graphQL query with Pycharm

How-to Guide

This tool is a quick easy way to generate manifest List Page by just providing a GQL query (with edges/node)

Troubleshoot PENDING status on Create Retailer Batch

How-to Guide

Create retailer batch can get stuck in PENDING status in a few case scenarios (incorrect payload, missing settings...)
When this occurs, it’s not possible to create any new retailers on the account
The only way to resolve this is though an SRE ticket

Display full attribute value on the Screen (specially on phone/tablet view)

How-to Guide

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.

SCIM Connector Roles Configuration

How-to Guide

When an enterprise application needs to be configured in Azure, App roles need to be added on Azure Active Directory, and dynamic roles need to be set up on Fluent OMS.
it’s possible to manage the roles individually or via Group management on Microsoft Entra.

Create and Edit Inventory Catalogues

How-to Guide

An Inventory Catalogue can be created and edited via the UI.
To create a new Inventory Catalogue or edit an existing one, the user needs to have the right permissions, and the required mutations need to be enabled in the manifest.

Colored Thresholds for Gauge Charts Configuration

How-to Guide

Shows Implementers how to configure colored thresholds for gauge charts.
All configurations are described for the Sources and Feeds reference manifest fragments.

Creating and Editing Product Catalogues

How-to Guide

A Product Catalogue can be created and modified via the UI.
To create a new Product Catalogue or to edit the existing one, the user needs to have the right permissions, and the required mutations need to be enabled in the manifest.

Virtual Catalogue Creation and Editing Mutations

How-to Guide

A Virtual Catalogue can be created and modified via the UI.
In order to create a new Virtual Catalogue or to edit the existing one, the user needs to have the right permissions, and the required mutations need to be enabled in the manifest.

Page Filter Select configuration via Manifest

How-to Guide

This guide shows Implementers how to configure Page Filter Select via Manifest.
All configurations are described based on fc.mystique.manifest.inventory.fragment.feeds manifest fragment.

Colorful Dots Statuses Configuration Guide

How-to Guide

Setting Example
Defining the Dot for Each Value in the Cell
Setting Naming Convention

Install Core Reference Module into your sandbox

How-to Guide

steps on how to install modules into your OMS sandbox

commercetools Connector v2.0.0 Migration Steps

How-to Guide

The 2.0 Commerce tools connector offers a range of new capabilities in regards to configurations, availability calls and DSK context creation.
The migration requires a few Java changes and configuration changes that are covered in detail in this article.

commercetools Local Development Setup

How-to Guide

Local development uses localstack to emulate AWS services
AWS CLI Configuration is optional
IntelliJ and Eclipse / STS Setup in local environment

commercetools Package Installation

How-to Guide

In order to utilize the commercetools connector, you would need to download the Java-based commercetools Fluent Connector and make sure you have the right dependencies and tools.
Development and deployment: The development environment needs to be configured with the correct credentials. The build and run are done via dockers and scripts. CloudFormation can be leveraged for production deployment.
Connect SDK and commercetools Connector should have matching versions for increased stability.

commercetools Setup

How-to Guide

In order to integrate commercetools API, an API Client needs to be created on commercetools.
When this is completed, you will need to proceed with the commercetools connect SDK installation to enable the connector.

Adding a Rule to your Workflow

How-to Guide

Working with Rules
Adding a Rule via the UI
Adding a Rule via the Workflow JSON

Update an existing Inventory Feed via GraphQL API

How-to Guide

After following this guide a user will be able to update an existing Inventory Feed
Various updates are available once an Inventory Feed has been created and started running

Troubleshooting Inventory Feeds

How-to Guide

This section will detail a few common issues and troubleshooting options for Inventory Feeds.

Create Multiple Articles for a Fulfillment

How-to Guide

Create Multiple Articles for a Fulfillment

Enable article barcode scanning

How-to Guide

Working with barcodes

Enable "Update Customer" UI mutation as User Action

How-to Guide

enable updateCustomer on the UI via manifest modifications

Bulk update Location Hours using Postman Runner

How-to Guide

Perform a bulk mutation update on the Location hours.
Requires Postman and Pycharm

SSO Enablement Process

How-to Guide

In order to configure the SSO, you would need to first sign the DPA, define the number of required SSO users, and raise a support ticket.
Second step is to configure your company IDP in Ping Identity.
Third step is to test to test to make sure that the user can log in.

Configure Fluent OMS session timeout for SSO users without external IDPs

How-to Guide

Session timeout for Fluent OMS can be configured for SSO users without external IDPs via Ping Identity.
In order to configure the timeout, you would need to configure Access token time to live and the authentication policy on Ping Identity.

Assign Articles to Storage Areas

How-to Guide

This guide shows you how to assign an article to a Storage Area as part of the Scan to Storage Area feature of the baseline Fluent Store web app
Prerequisites
Step-by-step guide

Add Comment Workflow Template Overview

How-to Guide

Configuration

Enable Navbar Badges

How-to Guide

Overview
Who is this guide for?
Steps to enable navigation bar badges with an example

Introspect the Fluent GraphQL Schema using Postman

How-to Guide

To Introspect the Fluent GraphQL schema, run an Introspection Query against the Fluent GraphQL API Endpoint. Below is the raw GraphQL Introspection Query.

Configure complex calculation in Manifest

How-to Guide

This article describes how to configure complex calculation in Manifest
Target audience: Architect, Partner Developer, Partner BA.

Adding a Ruleset to your Workflow

How-to Guide

Adding a Ruleset via the UI
Adding a Ruleset via JSON

Enable GraphQL Auto Complete in Postman

How-to Guide

Prerequisites
Steps to Follow

Add a Comment to Order

How-to Guide

A Comment provides an additional piece of information to the entity it is related to.
An Order can contain multiple comments associated with it.

Configure ServicePoint Dashboard

How-to Guide

Overview
Configuring the Dashboard
User Role and Permission
Understanding Dashboard View
Customization Example

Password Reset Overview

How-to Guide

This page helps to understand the new functionality that helps users to change own password during the authentication process.
This is only applicable to users who doesn't use corporate identity to login into Fluent OMX.
If you use corporate identity to log into Fluent, please contact internal IT team or administrator and follow internal process for changing password.

Example of how to use Fragment in GQL within Fluent. We will be using fulfilments

How-to Guide

Example on how to use fragments in GQL

User Editing Mutation

How-to Guide

A user can be edited directly on the Fluent OMS UI.
It’s only possible to ADD roles to the user on the UI. Removing roles is not feasible from the UI.

Guide - Customise a Pick List

How-to Guide

How to customise a Pick List

Appease Customer

How-to Guide

Custom Service Personnel have an ability to appease a customer in certain situations by providing a refund for an existing customer order.
This functionality is available via OMS for orders of all types in all statuses.

Add Order line / Order Item Search Page into Fluent Store

How-to Guide

A step by step guide on how to create Order Line / Order Item search page in Fluent Store

Pick an Order

How-to Guide

Selecting fulfilments to add to a wave and create wave
Generating standard or custom pick list
(Optional) Scanning items to pick via the ENFORCE_BARCODE_SCAN setting.

Upgrade an Existing Plugin to the latest SDK

How-to Guide

Upgrade an Existing Plugin to the latest SDK

Manual Event with Run-Once Workflow

How-to Guide

The Fluent platform allows sending events with a workflow "attached" in the meta section of the event. This means that Rubix will execute the rulesets and rules which have been passed through as part of the event. This is especially useful to manually execute particular rules on an entity and is mostly used for operational purposes.

Enable Storage Scanning

How-to Guide

To enable the storage scanning feature in Service Point the following setup and workflow changes are required

Log Action & Events

How-to Guide

In the fluent platform, a log action allows to generate a specific log event when a rule executes.

Control Group Creation and Editing Mutations

How-to Guide

Control groups can be created and modified via the UI.
In order to create or modify Control Groups, the user needs to have the correct permissions.

Setting Editing Mutation

How-to Guide

A setting can be modified directly on Fluent OMS UI.

Change the Delivery Address

How-to Guide

Customer Service Personnel can change the home delivery (HD) addresses for HD orders.
This functionality is available via Fluent OMS for HD orders PENDING_PAYMENT, BOOKED, CREATED, PICK_PACK statuses.

Change Address Workflow Template Overview

How-to Guide

User action capability is used to update the Delivery Info of an Order.

Enable Order Activity View in STORE webapps

How-to Guide

2 main steps to enable order activity view in STORE app.
- add OMS plugin to your store fragment,
- add EVENT_VIEW permission to your location user

User Creation and Editing Mutations

How-to Guide

A user can be created and modified via UI.
The user creation requires the associated Location, Retailer, Role, and Context. It’s also possible to add extra attributes.
It’s only possible to ADD roles to the user on the UI. Removing roles is not feasible from the UI.

Dev Environment Setup for working with the Connect SDK

How-to Guide

This article providfes you with templates to setup your local environment for developing with the Connect SDK
Local development uses a Docker localstack to emulate AWS services.

Test web app UI layout on the Phone / Tablet via computer Chrome Browser

How-to Guide

how to use Computer Chrome Browser to view Phone / Tablet layout
A handy way to test the layout on your computer without using an actual phone

Raise a Support Request for Reference Modules

How-to Guide

Before raising a ticket, review the reference module setup and configuration guides, Use the Event API to validate the workflow process executed, including source Event, Rulesets, and Rules, and Check all Settings, Users, Roles, Auth Tokens, etc. before raising an issue.

Support is provided for reference modules, which are Core, Order, Fulfilment, and Inventory.

Raise a Support Request for Reference Modules with a Fluent Retail Support (FRS) ticket.

Bulk Extracts with GraphQL

How-to Guide

A python script can be used for ad-hoc extracts of a large number of GQL entities into a CSV file.
Currently the Fluent platform does not support any bulk extracts.
This scripts helps to extract data in bulk using the pagination functionality provided by the schema.
Depending on the amount of data that is extracted the script might run for a while.
The above codes are provided as is and are for reference purposes.

Weather Updates

How-to Guide

In this guide, we will go through some basic features of the SDK by creating a connector from scratch that can receive or retrieve weather updates and push them to a Fluent setting.

If you wish to bypass this guide and look at the result, feel free to download the sources.

Adding a User Action to your Workflow

How-to Guide

User actions allow to manually trigger specific events in the Workflow.
User Actions can be added, changed, or removed.
User actions can be added via UI or via the Workflow JSON.

Ability to display full attribute value on the Screen (specially on phone/tablet view)

How-to Guide

A trick to display the full value regardless of the user's screen size

SSO - Multi-Factor Authentication (MFA) Configuration

How-to Guide

In order to enable MFA, you need to log into pingOne to make sure that MFA is enabled for Fluent App and for the logged user.
You would then need to log in the system via Fluent’s self service link.
Once this has been completed, a new authentication method needs to be added on Ping Identity.

Configure UI for Mixed Baskets

How-to Guide

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.

Debugging ShippIt Connector issues

How-to Guide

This guide covers the common symptoms and associated steps to debug issues with the ShippIt Connector.
In most cases, if there is an issue, the most likely symptom is if Fluent Store shows the consignment entity status as FAILED.

Enable Fluent Store Multi-Parcel

How-to Guide

This document serves as a practical hands-on guide to enable Multi-Parcel in your account.
It is recommended to be used alongside the Multi-Parcel field document.

Collecting Attributes via a User Action

How-to Guide

Adding Attribute details via the UI
Adding Attribute details via the Workflow JSON

Enable Retailer Context Switcher functionality

How-to Guide

Retailer context switcher allows you to switch the retailer without having to log off and back in with the specific credentials. This is feasible as long as the user permissions are configured accordingly.
The context switcher requires a few manifest modifications, which are detailed in the article below.

Kafka Connector built on top of Connect SDK

How-to Guide

The User can configure Kafka Connector on top of the Connect SDK.
Some configuration is required.

SCIM Connector Setup and Configuration Overview

How-to Guide

The overview of the SCIM Connector Setup and Configuration

SCIM Connector Provisioning Configuration

How-to Guide

You can configure provisioning function for Fluent OMS in Azure Active Directory.
You would first need to have access to Microsoft Azure Portal to update the credentials and map the relevant attributes. Next step is triggering the start/stop provisioning form the portal.

SCIM Connector Credential/Secret Configuration

How-to Guide

A guide on how to set up SCIM Secret Configuration

Configure Okta connection via SAML

How-to Guide

Register application with Okta
Add the identity provider in PingOne
Add Metadata URL
Continue IDP Configuration
Do not forget

Configure an order with requested delivery dates

How-to Guide

You will understand how to configure workflows to adjust delivery dates for processing orders to suit your business needs.
You will learn about the necessary settings and their functionalities.

Environment Setup

How-to Guide

Local Developer Setup
Fluent Platform Sandbox
Fluent Platform Production

Connector Deployment Cloudformation

How-to Guide

Prerequisites
Manual Deployments
Stack Provisioned

Salesforce Service Cloud (SFSC) Connector Installation Guide

How-to Guide

The Salesforce Service Cloud (SFSC) connector can be downloaded on Salesforce marketplace (Appexchange).
In order to launch the connector: A SFSC administrator would need to download the Fluent OMS app from Salesforce App Exchange and deploy it within the SF organisation. API configurations and settings would then need to be added on Fluent OMS app to complete the set up.

SCIM Connector Package Installation

How-to Guide

The SCIM connector is a Java based project that enables seamless integration with the SCIM. In order to install the SCIM Connector, you’d need to make sure you have the right dockers and tools. Next step is setting up the local environment, configuring the connector, and finally deploying the connector.
The SCIM connector and connect SDK versions need to be aligned.

Migrate to the New Print Component

How-to Guide

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.

Enable a Return Summary

How-to Guide

A dynamic total Refund Summary can be configured into the Returns Wizard, on both Fluent Store and Fluent OMS.
In order to configure the returns summary, to would need to enable to returns workflow, add the appropriate setting and modify the manifest.

Inventory File Loader

How-to Guide

The SDK allows to import data into Fluent OMS via batch jobs.
The data can be stored in an Amazon S3 bucket and imported into Fluent OMS via API.
The inventory job handler requires various settings that need to be defined in the account’s settings list ( location-pattern, archive-folder... )

Configure displaying of Shipment section in Order Item Details drawer

How-to Guide

The Shipment clock section in Order item Details is not shown by default. This functionality can be turned on via a setting.

Enable Fluent Store Multi-Parcel

How-to Guide

A practical hands on guide to enable Multi-Parcel in your account. It is recommended to be used alongside the Multi-Parcel field document.
Articles are now called Parcels.
This guide is aimed at technical implementors who are looking to enable In-Store Associates to capture multiple parcels per fulfilment.
Step-by-step setup multi parcel feature in Fluent Store.

Enable Add Comment functionality

How-to Guide

Comments can be added to Fluent OMS web app by modifying the manifest, this article covers the required steps.

Create a Custom Printable Pack Slip

How-to Guide

The Pack Slip on Fluent Store can be customised via an HTML template.
This guide will take you through the setup and fragment changes required to customise the Pack Slip.

Enable the Scan to Storage Area feature

How-to Guide

Enabling scan to storage area is only possible on Fluent store (not on Service Point).
This guide will take you through the setup and workflow changes required to enable the Storage Area Scanning feature in Fluent Store.

Configure Order List View

How-to Guide

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.

Adding an Entity to your Workflow

How-to Guide

It’s possible to add a new entity to an existing Workflow by modifying the original Workflow. In order to do so, a “CREATED” status and a CREATE Ruleset need to be added for the new entity.
This is not feasible via “ADD RULESET".

Committing a change to a Workflow

How-to Guide

It’s possible to commit a Workflow change via the UI as long as the user has the right permissions.

Adding or modifying Categories in a Workflow

How-to Guide

A category represents a lifecycle phase in the WorKFlow, it appears as a vertical column in the WF UI.
Within each lifecycle, we can have one or multiple statuses.

Adding a State to your Workflow

How-to Guide

It’s possible to add a new state into an existing WorkFlow by adding a new status to the
```
`Statuses array`
```
of the workflow JSON.

Adding a Trigger to a Ruleset

How-to Guide

A Trigger defines when a User Action is applicable to the given entity.
A trigger can be added via UI or via JSON. If there’s not trigger status for a ruleset, then all statuses are considered as trigger.

Displaying Inventory Quantity sum and count on the Inventory Position UI Page

How-to Guide

You can show the Inventory Quantity sum and count in the UI via modifications of the manifest
```
`sum`
```
and
```
`count`
```
values are retrieved via custom queries and then displayed in the UI

Restrict a store user to login into OMS webapps

How-to Guide

In the default reference mystique manifest, a store user can log in to OMS web apps, and sometimes, the user can see other location data within the OMS web apps.
One way to solve this issue is to introduce the “
```
`role`
```
” in the
```
`fc.mystique.manifest.oms`
```
context.

Enable Chinese Language in OMS webapps

How-to Guide

This document describes how to enable the Chinese language in Fluent OMS webapps.
There are 2 Chinese Languages in writing: Traditional and Simplified. The Simplified Chinese are mainly used in Mainland China and Traditional Chinese are typically used in Taiwan, Hong Kong and Macau.

Fluent STORE: capture Driver Name and Vehicle Number in the Carrier Collection Screen

How-to Guide

A simple way to add user action to capture driver name and vehicle number in the carrier collection process.

setting up Article barcode scanning in Webapps STORE

How-to Guide

Step by step to demonstrate how to add dc.scanner.barcode component into the Customer Collections page. A full reference can be found here

Restrict UserAction button visibility by using user roles

How-to Guide

The below example demonstrates how the visibility of the CREATE WAVE button in Fluent STORE can be customised via roles, permissions, and the manifest.

Control webapps STORE AND OMS UI by using roles and action in manifest

How-to Guide

describes how to set up the user to see the “query” only page or “edit” entity page by using User Roles and UserAction in Manifest.
The below example demonstrates where "Finance" users in "query" only mode on OMS data and "CustomerService" cancel orders and other user actions.

Enable multi-parcel pack screen in Fluent Store

How-to Guide

A Guide for enabling Multi-parcel with ES starter Pack via workflow, settings and manifest modifications.

Enable Japanese language in Fluent OMS / STORE

How-to Guide

enable Japanese language in OMS via settings modifications

Print current Page in OMS Webapps

How-to Guide

a trick on how to print the current list page to the printer

Add Order List Page into Fluent Store

How-to Guide

Guide for a user to add an order list page into Fluent Store.