managedChoiceValue

This reference describes the full structure of managedChoiceValue. Paths include nested objects, list items and conditional branches. A branch selected by kind, contract or mode only admits its own properties.

Structure and values

Field	Options / expected values	Description
kind	"choice"	Required. Selects the variant and the properties admitted in this branch.
labelLocale	string; min length 2; max length 100; /^[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*(?![\s\S])/u	Required. Defines label Locale for this object. Observe the type, variants and bounds in the Options column.
choices	Array<closed object>; min length 1; max length 1000	Required. Defines choices for this object. Observe the type, variants and bounds in the Options column.
choices[].key	string; min length 1; max length 120; /^[a-z][a-z0-9-]*(?![\s\S])/u	Required. Stable semantic identifier used by references; changing it changes identity.
choices[].labels	Record<string; min length 2; max length 100; /^[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*(?![\s\S])/u, string; min length 1; max length 4000>	Required. Defines labels for this object. Observe the type, variants and bounds in the Options column.

Reading the contract

A path ending in [] describes each list item; {key} describes each dictionary value. The ↻ marker refers to the same recursive expression. Closed objects reject additional properties. Semantic validation denotes an additional check: matching a type does not make a reference, permission or transition valid. References must resolve in the Model and the current user context.

An older variant cannot accept properties belonging to a newer variant. The compiler checks the version and consistency of the complete Model.

Structural example

This fragment passes the schema for this section. Its business references must be defined in the enclosing Model.

{
  "kind": "choice",
  "labelLocale": "client",
  "choices": [
    {
      "key": "client",
      "labels": {}
    }
  ]
}

Related references

Complete Model index · Build a Model

Applied examples : Required text and business choices

Company uses required text input; Status uses a declared list of choices.

Configuration

Contract object managedChoiceValue. Properties and accepted values.

{
  "kind": "choice",
  "labelLocale": "client",
  "choices": [
    {
      "key": "client",
      "labels": {}
    }
  ]
}

Variation and connection

Fragment placed in forms[].fields[]. Properties and accepted values.

{
  "contract": "WorkspaceFormControl@2",
  "repeatable": false,
  "key": "status",
  "label": "Status",
  "input": "choice",
  "binding": {
    "kind": "field",
    "fieldKey": "status"
  },
  "required": true,
  "ruleKeys": [],
  "options": [
    "prospect",
    "active"
  ]
}

UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

1. Client identity
2. Notes and follow-up
3. Settings
4. Linked quotes

SurfaceClients / North StudioExample

managedChoiceValuemanagedChoiceValue

Clients

MODEL CONTEXTNorth StudioDeclarative configuration

kind

choice

labelLocale

client

choices

1 item

Values above follow the configuration fragment; references resolve in the complete Model.