Fluent Commerce Logo
Docs
Sign In

Getting Started Configuring Fluent Store

Essential knowledge

Author:

Fluent Commerce

Changed on:

10 July 2024

Overview

The Fluent Store web app is a preconfigured baseline web app which can be used as a starting point for your projects.

The default UX templates are hosted on the platform, so there is no need to create the manifest settings yourself, unless you need to customize the existing baseline configuration.

Key points

  • Instructions on how to override the default manifest document
  • Details on where to find baseline manifests and configuration guides
  • Recommendations for text editors to use when editing manifest documents
  • Guidance on saving manifest documents to your account
  • Information on adding new fragments to your web app

Configuring Fluent Store

Watch this quick demonstration showing a few examples of configuring Fluent Store.


Accessing the baseline Fluent Store

The Fluent Store app is available on the following URL:

`https://<ACCOUNT_ID>.sandbox.apps.fluentcommerce.com/store/`


Configuring Fluent Store

Should you wish to tailor the Fluent Store app for Client specific needs, you should override the default Fluent Store template, but add your own manifest to the Account Settings.

What can be configured?

Here are a few examples of what can be configured on Fluent store:

  • Update entity statuses on wizard steps to match the workflows on your account
  • Configure more steps in the pick and pack process to match the pick and pack process followed in your store
  • Add more screens to add more capabilities for the store user. Example: You may want to add a screen to display order details, or list of products available at your store, or inventory available at your store and other stores.
  • Add, remove or update Dashboard tiles
  • Add or remove columns on lists or details on cards
  • Update formatting of data fields
  • ...and much more!
How to override a default manifest document

By default, the UX Framework will check to see if there are any manifests configured in the Account settings. If no settings exist, Fluent Store will be loaded using the baseline manifests within the platform.

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, typically use the following convention:

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

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

To access the baseline manifests, see the table below:

Manifest

Link

Store

Store Manifest

Waves

Waves 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

For details on how to configure the components and the manifest document, see the Config Guide and the Component Library.

Editing Manifest documents

It is recommended to use a text editor that provides JSON syntax highlighting and validation to modify the JSON values, prior to saving in an Account setting.

Some suggested editors / IDEs include:

  • Sublime Text
  • Visual Studio Code
  • IntelliJ
Saving the manifests to your account

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

An example setting:

Field

Sample Value

Name

`fc.mystique.manifest.store.fragment.waves`

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, and overrides the baseline manifests to load your tailored configuration.

Adding new fragments to your web app

You may also wish to add completely new fragments to your web app. To do this, you will need to override the main web app manifest and add a new reference route to the manifest setting.

Read more about configuring Reference Routes here.

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