Fluent Commerce Logo
Docs
Sign In

Enable the Status Filter with Predefined Values

How-to Guide

Author:

Fluent Commerce staff

Changed on:

6 Dec 2023

Key Points

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

Steps

Step arrow right iconPrerequisits

  • Filter by status is added to the list. See how to add a filter here.
  • Mutations createSetting and updateSettingare enabled in the manifest.
  • A user has an assigned role with the following permissions:
    a. SETTING_VIEW
    b. SETTING_CREATE
    c. SETTING_UPDATE

Step arrow right iconStep 1.

Begin by specifying the list of predefined values you intend to add to the status filter.

Step arrow right iconStep 2.

Identify the datasource name associated with the list. For instance, if you are working with the "Virtual Positions" list, the datasource name would be

`virtualPositions`
.

Step arrow right iconStep 3.

Create a setting at the ACCOUNT / RETAILER level, and populate the following details:

  • Name: Follow the pattern
    `fc.{name of datasource for list}.states.`
    When the datasource name ends with an "s", remember to remove the last letter. For example, for the "Virtual Positions" list, the setting name for the status filter should be: fc.virtualPosition.states. Sometimes the datasource is consisting of multiple words, in that case we need to use the last word. For instance, in the manifest for the inventory positions page, the datasource is named
    `inventoryCatalogue.inventoryPositions.`
    For this to work, the setting has to be named
    `fc.inventoryPosition.states.`
  • Context: Specify either
    `ACCOUNT`
    or
    `RETAILER`
    , depending on the context.
  • Context ID: Provide the relevant context ID. For instance, use the retailer's ID if working within the RETAILER context.
  • Value Type: Choose
    `JSON`
    .
  • Value: Input predefined status options in JSON format like this:
1{
2  "options": [
3    {
4      "value": "ACTIVE",
5      "label": "ACTIVE"
6    },
7    {
8      "value": "INACTIVE",
9      "label": "INACTIVE"
10    },
11    {
12      "value": "CREATED",
13      "label": "CREATED"
14    }
15  ]
16}

Language: plain_text

Name: Predefined status options example

Description:

[Warning: empty required content area]
Fluent Commerce staff

Fluent Commerce staff

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