Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

SHOW / DESCRIBE SETTINGS

Synopsis

SHOW SETTINGS

DESCRIBE SETTINGS [ category ]

Description

Displays project settings. SHOW SETTINGS provides a compact overview of all settings across all categories. DESCRIBE SETTINGS outputs the full settings in round-trippable MDL syntax that can be used to recreate the same configuration.

When DESCRIBE SETTINGS is called without a category, it outputs all settings. When a category is specified, only that category is shown.

The available settings categories are:

CategoryContents
MODELApplication-level settings: AfterStartupMicroflow, BeforeShutdownMicroflow, HashAlgorithm, JavaVersion, etc.
CONFIGURATIONRuntime configurations: DatabaseType, DatabaseUrl, HttpPortNumber, etc. Each named configuration is listed separately.
CONSTANTConstant value overrides per configuration. Shows which constants have non-default values in each configuration.
LANGUAGELocalization settings: DefaultLanguageCode and available languages.
WORKFLOWSWorkflow engine settings: UserEntity, DefaultTaskParallelism, etc.

Parameters

category (DESCRIBE only)
One of MODEL, CONFIGURATION, CONSTANT, LANGUAGE, or WORKFLOWS. If omitted, all categories are shown.

Examples

Show settings overview

SHOW SETTINGS;

Describe all settings in MDL format

DESCRIBE SETTINGS;

Describe model settings only

DESCRIBE SETTINGS MODEL;

Describe runtime configurations

DESCRIBE SETTINGS CONFIGURATION;

Describe workflow settings

DESCRIBE SETTINGS WORKFLOWS;

See Also

ALTER SETTINGS