Skip to content

Configuration Item Enumeration

Sébastien Gallou edited this page Apr 18, 2017 · 2 revisions

Enumeration

This type describe a value taken from a list

Non optionnal fields

Type descriptor

This field define the type as enumeration

"type" : "enum"

List of values

This field define the list of values that can be set to the parameter

"values" : {
             "12H" : "12 hours",
             "24H" : "24 hours"
          }

Optionnal fields

Sort

Allow to sort alphabetically the enumeration (sort on the values). If not defined, the enumeration combobox is sorted by key

"sort" : "true"

Default Value

The defaultValue field permit to set the default value of the parameter. If not set the default value is the first items in the values list

"defaultValue" : "12H"

Example

"timeFormat" : {
      "name" : "time format",
      "description" : "Permit to change the time format of the clock",
      "type" : "enum",
      "values" : {
         "12H" : "12 hours",
         "24H" : "24 hours"
      },
      "defaultValue" : "12H"
   }
Clone this wiki locally