Skip to main content

defaultEnabled property

note

Work in progress.

Purpose​

Specify whether the current object is initially enabled.

Syntax​

{
  "cdlOptions | cdlComponents": [
    {
      "name": "...",
      ...
      "defaultEnabled": true | false | "<expression>",
      ...
    }
  ]
}

The value of the defaultEnabled property is either the true or false constant or a string that evaluates to a boolean value.

If the value is a constant, it is evaluated when parsing the file. If the value is a string, it is evaluated in a separate step that processes the entire configuration hierarchy before processing the requirements.

Default value​

If missing, the default is true, the object is enabled.

Description​

The configuration hierarchies are usually large, and not all objects are required in a specific configuration, so there is a need to individually enable or disable them.

This property controls the initial state of the object, as goal expressions can enable individual objects to satisfy requirements. Objects marked as enabled can still be active or inactive.

Disabling a component or package automatically disables all children objects.

Example​

An object can replicate the enabled state of another object:

{
  "cdlOptions": [
    {
      "name": "one",
      ...
      "defaultEnabled": "isEnabled('two')",
      ...
    }
  ]
}

eCos reference​

  • none