Download the VS Code Workspace for configuring Manifests
We've provided a VS Code Workspace project, which comes preconfigured with the Manifest Schemas to enable Auto-Complete in VS Code.Simply download the attached Zip file, extract it on your computer, and open the workspace file in VS Code.Technical Issues If you are facing a technical issue in production, contact the support team via the support portal. The support ticket guide provides more information on resolving your problem efficiently.Documentation FeedbackPlease use the Feedback button throughout the website to let us know if you want us to action something or provide feedback on your experience. If you can't see the feedback button, please try disabling AdBlock. You can also provide feedback by contacting us directly at docs@fluentcommerce.com.
Community SupportGet help from our partner community by joining the builders portal and collaborating in the builders forums.Tailored Project HelpIf you need tailored help on your environment, speak with our Expert Services team. Check available Expert Services Packages. Connector Framework HelpQuestions can be sent directly to the Connector Framework product team via connector-framework@fluentcommerce.com.Builders PortalIf you’d like help with anything Builders Portal or Docs related, please get in touch via docs@fluentcommerce.com, visit our Help & Feedback page on Docs. Please download the zip here.Introduction to the Manifest Document
The Manifest document describes the structure and layout of a Fluent Web App, including the navigation, and all pages within the application.
The manifest document is added as an ACCOUNT level setting.The name defined in the manifest determines the URL path required to access the Fluent Web App.For example, a manifest declaring a name or "mywebapp" would be accessible via the following URL:`https://[ACCOUNTID].sandbox.apps.fluentcommerce.com/mywebapp/`The manifest also determines the context of the Web App, either "retailer" or "location", and delivers Role based visibility management, so that each Web App and screen can be configured based on each client's unique organisational structure.
The manifest also defines the data to be provided to the page via GraphQL queries.Watch the video below to see a simple new manifest document structure...Creating a new manifest
How to create a new manifest documentCreating a Web App is as simple as creating an Account level setting with the following naming convention:`fc.mystique.manifest.[appName]`...where [appName] is the name of the web app. The Setting should be a JSON type, and store the manifest document in the JSON value. To access the web app, you would use the following URL:`https://[ACCOUNTID].sandbox.apps.fluentcommerce.com/[appName]/`Each Fluent Web App should a define Name, a Title, a Context, and a set of Routes.The Context is the scope of interaction with the Fluent Order Management system.For example, the Fluent Store Web App is set to a Location Context, since all the actions and data present within the Web App are specific to an individual Store.A Retailer Context Web App would provide Retailer scoped actions and data management.Routes are the URL paths that point to Pages or screens.There are 3 types of Routes that can be configured in a Manifest:- A Page Route - which is a direct link to a page
- A Section Route - which is a navigation grouping header
- A Reference Route - which is a reference to another manifest document called a fragment, which allows you to split and manage large manifests in separate documents
Watch the video below to see how to create a new app...To follow along on your own training account, log in to Fluent Admin Console using the FC_FASHION retailer user: `fc_fashion_admin`Setting up the manifest document
This video shows how to set up the manifest documentSince this web app was configured to a ``location`` context in the manifest, use a Location user login, such as `F_syd@fcfashion.com.au`, to log in and view the empty app.
Note: Don't worry about the "error" text displayed - we'll fix this next!Let's add a simple Page route to the Manifest:A Page Route should be set to type "page", declare a relative URL path, use a foundation or page based component, and optionally a nav configuration for the main menu.Once you have your first page, you can now set your web app's home path.Let's see it in action...How to add a blank page
This video shows how to add a blank pageLearn more about configuring the manifest document.