Skip to content

Configuration Item Section

Sébastien Gallou edited this page Oct 21, 2022 · 3 revisions

Section

This type allow user to make sections. They are used to group configuration items.

Non optionnal fields

Type descriptor

This field define the type as a section

"type" : "section"

Content

The content section contains all configuration fields that have to be in the section.

"content" : {
            "booleanParameter" : {
               "type" : "bool",
               "name" : "enabled",
               "description" : "Permit to enable the widget",
               "defaultValue" : "true"
            }

Optionnal fields

Checkbox to enable / disable the section

This parameter permit to add a checkbox at the top of the section that enable or disable the section. It can be used for example to have an advanced configuration section for expermiented users only. When the section is disabled, it collapse all the content of the section. If not set the default value is false.

"enableWithCheckBox" : "true"

Default value for enable / disable checkbox

This parameter permit set the default value of the checkbox that permit you to enable or disable the section. If not set the default value is false.

"checkbox": {
   "defaultValue": false
}

Example

"advancedParameters" : {
          "type" : "section",
          "name" : "Advanced parameters",
          "description" : "For advanced users only",
          "enableWithCheckBox" : "true",
          "enableWithCheckBoxDefaultValue" : "false",
          "content" : {
             "booleanParameter" : {
                "type" : "bool",
                "name" : "enabled",
                "description" : "Permit to enable the widget",
                "defaultValue" : "true"
             },
             "CurrentCoefficient" : {
                "type" : "decimal",
                "name" : "correction coefficient",
                "description" : "Set a correction coefficient to adjust the value",
                "defaultValue" : "0.0",
                "maximumValue" : "1.0",
                "minimumValue" : "-1.0",
                "precision" : "2"
             }
          }
       }
Clone this wiki locally