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:
| Category | Contents |
|---|---|
MODEL | Application-level settings: AfterStartupMicroflow, BeforeShutdownMicroflow, HashAlgorithm, JavaVersion, etc. |
CONFIGURATION | Runtime configurations: DatabaseType, DatabaseUrl, HttpPortNumber, etc. Each named configuration is listed separately. |
CONSTANT | Constant value overrides per configuration. Shows which constants have non-default values in each configuration. An override whose value is private — stored on the developer’s workstation rather than in the shared model — is reported as (private); its value is not in the project and mxcli cannot show it. |
LANGUAGE | Localization settings: DefaultLanguageCode and available languages. |
WORKFLOWS | Workflow engine settings: UserEntity, DefaultTaskParallelism, etc. |
Parameters
- category (DESCRIBE only)
- One of
MODEL,CONFIGURATION,CONSTANT,LANGUAGE, orWORKFLOWS. 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;
List workflow groups
SHOW WORKFLOW GROUPS;
Lists the workflow groups from App Settings ▸ Workflows ▸ Groups with their
descriptions. It reads the project settings directly, so no catalog refresh is
needed. Groups are created with
ALTER SETTINGS WORKFLOWS ... GROUP.
Describe workflow settings
DESCRIBE SETTINGS WORKFLOWS;