Introduction to the Manifest Document
Essential knowledge
Changed on:
23 Sept 2024
Overview
[Warning: empty required content area]Key points
[Warning: empty required content area]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...
Note: This video does not have audio.
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...
Note: This video does not have audio.
Account level setting
Creating 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
`fc_fashion_admin`Note: This video does not have audio.Since 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.
Since 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...Note: This video does not have audio.Learn more about configuring the manifest document.