ALTER SETTINGS
Synopsis
ALTER SETTINGS MODEL key = value
ALTER SETTINGS CONFIGURATION 'name' key = value
ALTER SETTINGS CONSTANT 'name' VALUE 'value' IN CONFIGURATION 'config'
ALTER SETTINGS LANGUAGE key = value
ALTER SETTINGS WORKFLOWS key = value
Description
Modifies project settings by category. Each category has its own syntax and available keys.
MODEL settings control application-level behavior such as the after-startup microflow, hashing algorithm, and Java version.
CONFIGURATION settings control named runtime configurations. Each project can have multiple configurations (e.g., default, staging, production). Settings include database type, database URL, HTTP port number, and other runtime parameters. The configuration name must be enclosed in single quotes.
CONSTANT settings override the default value of a project constant within a specific runtime configuration. Both the constant name and the configuration name must be enclosed in single quotes.
LANGUAGE settings control localization, primarily the default language code.
WORKFLOWS settings control the workflow engine, including the user entity used for workflow tasks and default task parallelism.
Parameters
- key
- The setting name to modify. Available keys depend on the category.
- value
- The new value for the setting. String values must be enclosed in single quotes.
- name (CONFIGURATION, CONSTANT)
- The name of the configuration or constant, enclosed in single quotes.
- config (CONSTANT only)
- The name of the runtime configuration where the constant override applies, enclosed in single quotes.
Examples
Set the after-startup microflow
ALTER SETTINGS MODEL AfterStartupMicroflow = 'MyModule.ACT_Startup';
Configure database type
ALTER SETTINGS CONFIGURATION 'default' DatabaseType = 'POSTGRESQL';
Set database URL for a configuration
ALTER SETTINGS CONFIGURATION 'production' DatabaseUrl = 'jdbc:postgresql://dbhost:5432/myapp';
Override a constant in a configuration
ALTER SETTINGS CONSTANT 'MyModule.ApiBaseUrl' VALUE 'https://api.staging.example.com' IN CONFIGURATION 'staging';
Set the default language
ALTER SETTINGS LANGUAGE DefaultLanguageCode = 'en_US';
Configure workflow user entity
ALTER SETTINGS WORKFLOWS UserEntity = 'Administration.Account';
Set Java version
ALTER SETTINGS MODEL JavaVersion = '17';