Settings related to Zen Project for backward compatibility. Read d͟e͟t͟a͟i͟l͟s͟ .

Zen project entrypoint

Entrypoint for zen project to start from.

IDzen-project.entrypoint
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_ENTRYPOINT
Deprecated environment variablesAIDBOX_ZEN_ENTRYPOINT ,
BOX_PROJECT_ENTRYPOINT
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Zen project entry

Environment variable is used to specify zen project entry namespace

IDzen-project.entry
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_ENTRY
Deprecated environment variablesAIDBOX_ZEN_ENTRY
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Load zen namespace as EDN

Used to load a single namespace represented as EDN

IDzen-project.load
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_LOAD
Deprecated environment variablesAIDBOX_ZEN_LOAD
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

URL or path to the zen project source

Source of the zen project using the following syntax <source>:<format>:<path>[,<source>:<format>:<path>]*.

IDzen-project.paths
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_PATHS
Deprecated environment variablesAIDBOX_ZEN_PATHS
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Zen project git protocol

Either https or ssh. Assumes local directory if omitted.

IDzen-project.git.protocol
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_GIT_PROTOCOL
Deprecated environment variablesBOX_PROJECT_GIT_PROTOCOL
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Zen project git URL

Where to clone your project from. Aidbox substitutes it to git clone <url> command.

IDzen-project.git.url
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_GIT_URL
Deprecated environment variablesBOX_PROJECT_GIT_URL
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Zen project git access token

Token to access HTTPS private repository

IDzen-project.git.access-token
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_GIT_ACCESS_TOKEN
Deprecated environment variablesBOX_PROJECT_GIT_ACCESS__TOKEN
Sensitivetrue — value will be masked in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Zen project git checkout

Git branch or commit

IDzen-project.git.checkout
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_GIT_CHECKOUT
Deprecated environment variablesBOX_PROJECT_GIT_CHECKOUT
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Zen project target path

Clone the repository into a directory. Default value is a directory in /tmp

IDzen-project.git.target-path
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_GIT_TARGET_PATH
Deprecated environment variablesBOX_PROJECT_GIT_TARGET__PATH
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Path to the zen project inside a git repository

The value of the setting should be set to a path starting with a repository name.

IDzen-project.git.sub-path
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_GIT_SUB_PATH
Deprecated environment variablesBOX_PROJECT_GIT_SUB__PATH
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Zen dev mode

Enables watcher which reloads zen namespaces when they change.

IDzen-project.dev.mode
TypeBool
Default valuefalse
Environment variableBOX_ZEN_PROJECT_DEV_MODE
Deprecated environment variablesAIDBOX_ZEN_DEV_MODE
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Task executor service workers

The default number of task executor service workers.

IDzen-project.default-service-workers
TypeInt
Default value3
Environment variableBOX_ZEN_PROJECT_DEFAULT_SERVICE_WORKERS
Deprecated environment variablesAIDBOX_ZEN_DEFAULT_SERVICE_WORKERS
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Zen config expose

Show zen Aidbox config in zen UI and on $config endpoint

IDzen-project.config.expose
TypeBool
Default valuefalse
Environment variableBOX_ZEN_PROJECT_CONFIG_EXPOSE
Deprecated environment variablesAIDBOX_ZEN_CONFIG_EXPOSE
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Sync indexes on startup

If enabled, Aidbox synchronizes managed index on startup

IDzen-project.index.sync-on-start
TypeBool
Default valuefalse
Environment variableBOX_ZEN_PROJECT_INDEX_SYNC_ON_START
Deprecated environment variablesBOX_INDEX_SYNC__ON__START
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Manifest to zen migration

IDzen-project.manifest-to-zen-migration
TypeString
Default value(no default)
Environment variableBOX_ZEN_PROJECT_MANIFEST_TO_ZEN_MIGRATION
Deprecated environment variablesBOX_FEATURES_MANIFEST__TO__ZEN__MIGRATION
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Enable zen-FHIR search parameters

Aidbox zen packages may contain search parameters.

Enable this setting to load these search parameters into Aidbox. If disabled, only the pre-bundled and user-created search parameters are available.

This setting has no effect if FHIR-Schema validator is enabled.

IDzen-project.search.zen-fhir
TypeEnum
Valuesenable
disable
Default value(no default)
Environment variableBOX_ZEN_PROJECT_SEARCH_ZEN_FHIR
Deprecated environment variablesBOX_SEARCH_ZEN__FHIR
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Check bindings

Disable validation of FHIR terminology bindings

IDzen-project.validation.value-set-mode
TypeBool
Default valuetrue
Environment variableBOX_ZEN_PROJECT_VALIDATION_VALUE_SET_MODE
Deprecated environment variablesAIDBOX_FEATURES_VALIDATION_VALUE__SET_MODE ,
BOX_FEATURES_VALIDATION_VALUE__SET_MODE
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaEnvironment variables
Hot reloadfalse — setting requires system restart

Use SQL backward-compatible with old zen search

For some time zen-search generated slightly different SQL expressions.

Turn on this feature if you use zen-search and do not wish to update indexes.

IDzen-project.search.resource-compat
TypeBool
Default valuetrue
Environment variableBOX_ZEN_PROJECT_SEARCH_RESOURCE_COMPAT
Deprecated environment variablesBOX_SEARCH_RESOURCE__COMPAT
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Enable terminology import

Enable terminology import.

IDzen-project.terminology.import.enable
TypeBool
Default valuetrue
Environment variableBOX_ZEN_PROJECT_TERMINOLOGY_IMPORT_ENABLE
Deprecated environment variablesBOX_FEATURES_TERMINOLOGY_IMPORT_ENABLE
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Enable terminology sync

Enable terminology sync.

IDzen-project.terminology.import.sync
TypeBool
Default valuefalse
Environment variableBOX_ZEN_PROJECT_TERMINOLOGY_IMPORT_SYNC
Deprecated environment variablesBOX_FEATURES_TERMINOLOGY_IMPORT_SYNC
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Build FTR index on startup

Build FTR index on startup.

IDzen-project.ftr.build-index-on-startup.enable
TypeBool
Default valuetrue
Environment variableBOX_ZEN_PROJECT_FTR_BUILD_INDEX_ON_STARTUP_ENABLE
Deprecated environment variablesBOX_FEATURES_FTR_BUILD__INDEX__ON__STARTUP_ENABLE
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Sync FTR index on Aidbox start

Sync FTR index on Aidbox start.

IDzen-project.ftr.build-index-on-startup.sync
TypeBool
Default valuefalse
Environment variableBOX_ZEN_PROJECT_FTR_BUILD_INDEX_ON_STARTUP_SYNC
Deprecated environment variablesBOX_FEATURES_FTR_BUILD__INDEX__ON__STARTUP_SYNC
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Enable incremental updates of the FTR index

Enable incremental updates of the FTR index

IDzen-project.ftr.incremental-index-updates.enable
TypeBool
Default valuetrue
Environment variableBOX_ZEN_PROJECT_FTR_INCREMENTAL_INDEX_UPDATES_ENABLE
Deprecated environment variablesBOX_FEATURES_FTR_INCREMENTAL__INDEX__UPDATES_ENABLE
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Load FTR index into Aidbox DB

Load FTR index into Aidbox DB

IDzen-project.ftr.pull.enable
TypeBool
Default valuefalse
Environment variableBOX_ZEN_PROJECT_FTR_PULL_ENABLE
Deprecated environment variablesBOX_FEATURES_FTR_PULL_ENABLE
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Load FTR index synchronously

Block Aidbox start until FTR index is loaded into Aidbox DB.

IDzen-project.ftr.pull.sync
TypeBool
Default valuefalse
Environment variableBOX_ZEN_PROJECT_FTR_PULL_SYNC
Deprecated environment variablesBOX_FEATURES_FTR_PULL_SYNC
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart

Last updated 2025-07-15T00:23:17Z