Skip to main content

The defaultEnabled definition

note

Work in progress.

Purpose

Specify whether the current object is initially enabled.

Syntax

{
"cdlOptions": {
"<name>": {
...
"defaultEnable": true | false | "<expression>",
...
}
}
}

The value of the defaultEnable 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, all objects are enabled.

Description

The configuration hierarchies are usually large, and not all objects are required in a specific configuration, so the need to individually enable/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 child objects.

Example

An object can replicate the enabled state of another object:

{
"cdlOptions": {
"one": {
...
"defaultEnable": "isEnabled('two')",
...
}
}
}

eCos reference

  • none