Fluent Commerce Logo
Docs
Sign In

Overriding the default manifest

How-to Guide

Author:

Fluent Commerce

Changed on:

8 Oct 2024

Key Points

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

Steps

Step arrow right iconGeneral Information

By default, the UX Framework will check if any manifests are configured in the Account settings. The Fluent web app will be loaded using the baseline manifests within the platform if no settings exist.

The setting name for the main web app manifest file should match the following convention:

`fc.mystique.manifest.<web-app-name>`

Fragment manifest names are not enforced; however, they typically use the following convention:

`fc.mystique.manifest.<web-app-name>.fragment.<fragment-name>`

Should you wish to customize any part of the default Fluent web app, you can override the relevant manifest by copying the base manifest fragment into an account setting.

To access the baseline manifests, see the tables below:

Fluent Order Management 

Fluent Store

Manifest Category

Available Template Links

Store

Store Manifest

Waves

Waves Fragment

Waves Fragment (Assigning Items to Parcels Capability)

Pack

Pack Fragment

Orders awaiting Pick

Orders awaiting pick

Waves In Progress

Waves In Progress

Waves Completed

Waves Completed

Customer Collections

Customer Collections

Arrivals

Arrivals Fragment

Carrier Collections

Carrier Collections Fragment

Uncollected

Uncollected Fragment

Returns

Returns Fragment

Fluent Big Inventory

Manifest Category

Available Template Links

Big Inventory

Big Inventory Manifest

Sources

Sources Fragment

Feeds

Feeds Fragment

Products

Products Fragment

Inventory

Inventory Fragment

Stores

Stores Fragment

Insights

Insights Fragment

Admin

Admin Fragment

For details on configuring the components and the manifest document, see the Config Guide and the Component Library.

Step arrow right iconEditing Manifest documents

Using a text editor that provides JSON syntax highlighting and validation is recommended to modify the JSON values before saving them in an Account setting.

Some suggested editors / IDEs include:

  • Sublime Text
  • Visual Studio Code
  • IntelliJ

Step arrow right iconSaving the manifests to your account

Manifest documents should be stored as a JSON Setting in the Account context. Settings can be created and updated in either of the following ways:

  • Manually via the Fluent Big Inventory app (Admin section)
  • via the GraphQL Settings API

An example setting:

Field

Sample Value

Name

`fc.mystique.manifest.inventory.fragment.inventory`

Type

JSON

JSON Value

`{ ... <YOUR MANIFEST JSON HERE> ... }`

Context

ACCOUNT

Context ID

0

When loading the web app in the browser, the UX Framework identifies if there are any referenced manifest settings on the account. It overrides the baseline manifests to load your tailored configuration.

Step arrow right iconAdding new fragments to your web app

You can also add entirely new fragments to your web app. To do this, you must override the main web app manifest and add a new reference route to the manifest setting.

Read more about configuring Reference Routes here. 

Step arrow right iconConfiguring Workflows

To get to market quickly, you can use the Fluent platform's pre-built workflows or support your business processes by configuring workflows and custom rules with the Rules SDK.

The Workflow Engine (aka Rubix) is the engine that drives the Fluent platform. The Workflow Engine enables business process orchestration and workflow automation, underpinning each Fluent app's specific feature sets and functionality. The Workflow Engine is also built to be highly scalable and provide high-performance workflow execution across any domain. If you would like more details, you can see How it Works.

Fluent Commerce

Fluent Commerce

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

Fluent Logo