Multi-State

Overview

A Multi-State Field is a configurable data field used to represent discrete states visually within an application. It is commonly used to indicate status, progress, or completion levels.

Supported visual formats include:

• Red / Amber / Green (RAG)
• Extended colour scales (RAGBB)
• Custom Colours (selection from RYAOGBB)
• Harvey Ball indicators (percentage-based)

Multi-State Fields support between 2 and 8 distinct states, depending on the selected subtype.

• Example

• Configuration Properties

• Sub-Type Options

  • 1. RAG (Red–Amber–Green)

  • 2. RAGBB (Extended Scale)

  • 3. Harvey Ball (Percentage-Based)

  • 4. Harvey Ball (Two-State)

  • 5. Harvey Ball (Tri-State)

  • 6. Custom Colours

• Advanced Configurations (incl. Expressions)

Example

Configuring a new Multi-State Field

To create a new Multi-State Field, you must first be in the 'Fields' section of AppStudio, here you will be able to click the 'Add Field'  button in at least one of the highlighted locations below.

This will open the following page where you can scroll down and select the Multi-State Field tile or search for it in the top right bar:

Configuration Properties

These are the core properties to set on all Multi-State Fields:

• Label: User-facing name displayed in the workspace UI
• Identifier: Unique system ID (alphanumeric, must start with a letter, minimum 3 characters). This should reflect the label for ease of understanding when used in Import/Export/APIs.
• Type: The sort of Field that is being configured - With some types this can be edited in the future providing the data type is cross-compatible.

Sub-Type Options

The following sub-types define the available Multi-State configurations, including their visual states and corresponding numeric mappings.

1. RAG (Red–Amber–Green)

States: Unset, Red, Amber, Green
_Numeric Backing Values: 0, 5, 4, 3

2. RAGBB (Extended Scale)

States: Unset, Red, Amber, Green, Blue, Black
_Numeric Backing Values: 0, 5, 4, 3, 2, 1

3. Harvey Ball (Percentage-Based)

States: Unset, 25%, 50%, 75%, 100%
_Numeric Backing Values: 0, 25, 50, 75, 100

4. Harvey Ball (Two-State)

States: Unset, 100%
_Numeric Backing Values: 0, 100

5. Harvey Ball (Tri-State)

States: Unset, 50%, 100%
_Numeric Backing Values: 0, 50, 100

6. Custom Colours

Allows user-defined colour selection for flexible status representation.

Available colours: Green, Yellow, Amber, Orange, Red, Blue, Black
States: Unset (always included) + selected colours

_Numeric Backing Values:

• Unset is always 0
• Selected colours are assigned sequential numeric values starting from 1
• Values follow the fixed order: Black → Blue → Green → Yellow → Amber → Orange → Red
• Only selected colours are assigned values, in this order

Example:
If Green, Red and Black are selected:

• 0 = Unset
• 1 = Black
• 2 = Green
• 3 = Red

Note: Changing colour selections, or switching from predefined types (RAG or RAGBB) to Custom Colours, requires manual intervention to:

• Update backing numeric values
• Review and adjust any dependent logic (e.g. expressions, workflows, filters) where these values are used

Failure to do so may result in inconsistent or incorrect behaviour.

Advanced Configurations

Expressions: These are logic statements that are capable of determining the value for a Field and can perform an extremely wide range of tasks. For more information see here.

A typical example of an expression is one that sets RAG Status based on Score once a process is complete:

if([Completed] <> 'Complete', 'Unset',
  if([Score] > 80, 'Green',
    if([Score] > 60, 'Amber', 'Red')
  )
)

Include in Free Text Quick Filter: Makes the Field searchable from within a Report in order to filter down Records. It will return all records that contain the Search Text in Fields that have this property checked.

Exclude This Field From Templated Record Copies: If toggled, the data in this field will be excluded from future copies of Records, whenever 'Template Copy' is selected for the copy.