Zen Project

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.

ID

zen-project.entrypoint

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_ENTRYPOINT

Deprecated environment variables

AIDBOX_ZEN_ENTRYPOINT , BOX_PROJECT_ENTRYPOINT

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” setting requires system restart

Zen project entry

Environment variable is used to specify zen project entry namespace

ID

zen-project.entry

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_ENTRY

Deprecated environment variables

AIDBOX_ZEN_ENTRY

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Load zen namespace as EDN

Used to load a single namespace represented as EDN

ID

zen-project.load

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_LOAD

Deprecated environment variables

AIDBOX_ZEN_LOAD

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” 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>]*.

ID

zen-project.paths

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_PATHS

Deprecated environment variables

AIDBOX_ZEN_PATHS

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” setting requires system restart

Zen project git protocol

Either https or ssh. Assumes local directory if omitted.

ID

zen-project.git.protocol

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_GIT_PROTOCOL

Deprecated environment variables

BOX_PROJECT_GIT_PROTOCOL

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” setting requires system restart

Zen project git URL

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

ID

zen-project.git.url

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_GIT_URL

Deprecated environment variables

BOX_PROJECT_GIT_URL

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” setting requires system restart

Zen project git access token

Token to access HTTPS private repository

ID

zen-project.git.access-token

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_GIT_ACCESS_TOKEN

Deprecated environment variables

BOX_PROJECT_GIT_ACCESS__TOKEN

Sensitive

true β€” value will be masked in Admin UI

Set via

Environment variables

Hot reload

false β€” setting requires system restart

Zen project git checkout

Git branch or commit

ID

zen-project.git.checkout

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_GIT_CHECKOUT

Deprecated environment variables

BOX_PROJECT_GIT_CHECKOUT

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” setting requires system restart

Zen project target path

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

ID

zen-project.git.target-path

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_GIT_TARGET_PATH

Deprecated environment variables

BOX_PROJECT_GIT_TARGET__PATH

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” 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.

ID

zen-project.git.sub-path

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_GIT_SUB_PATH

Deprecated environment variables

BOX_PROJECT_GIT_SUB__PATH

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” setting requires system restart

Zen dev mode

Enables watcher which reloads zen namespaces when they change.

ID

zen-project.dev.mode

Type

Bool

Default value

false

Environment variable

BOX_ZEN_PROJECT_DEV_MODE

Deprecated environment variables

AIDBOX_ZEN_DEV_MODE

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” setting requires system restart

Task executor service workers

The default number of task executor service workers.

ID

zen-project.default-service-workers

Type

Int

Default value

3

Environment variable

BOX_ZEN_PROJECT_DEFAULT_SERVICE_WORKERS

Deprecated environment variables

AIDBOX_ZEN_DEFAULT_SERVICE_WORKERS

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Zen config expose

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

ID

zen-project.config.expose

Type

Bool

Default value

false

Environment variable

BOX_ZEN_PROJECT_CONFIG_EXPOSE

Deprecated environment variables

AIDBOX_ZEN_CONFIG_EXPOSE

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” setting requires system restart

Sync indexes on startup

If enabled, Aidbox synchronizes managed index on startup

ID

zen-project.index.sync-on-start

Type

Bool

Default value

false

Environment variable

BOX_ZEN_PROJECT_INDEX_SYNC_ON_START

Deprecated environment variables

BOX_INDEX_SYNC__ON__START

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Manifest to zen migration

ID

zen-project.manifest-to-zen-migration

Type

String

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_MANIFEST_TO_ZEN_MIGRATION

Deprecated environment variables

BOX_FEATURES_MANIFEST__TO__ZEN__MIGRATION

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” 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.

ID

zen-project.search.zen-fhir

Type

Enum

Values

enable disable

Default value

(no default)

Environment variable

BOX_ZEN_PROJECT_SEARCH_ZEN_FHIR

Deprecated environment variables

BOX_SEARCH_ZEN__FHIR

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Check bindings

Disable validation of FHIR terminology bindings

ID

zen-project.validation.value-set-mode

Type

Bool

Default value

true

Environment variable

BOX_ZEN_PROJECT_VALIDATION_VALUE_SET_MODE

Deprecated environment variables

AIDBOX_FEATURES_VALIDATION_VALUE__SET_MODE , BOX_FEATURES_VALIDATION_VALUE__SET_MODE

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Environment variables

Hot reload

false β€” 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.

ID

zen-project.search.resource-compat

Type

Bool

Default value

true

Environment variable

BOX_ZEN_PROJECT_SEARCH_RESOURCE_COMPAT

Deprecated environment variables

BOX_SEARCH_RESOURCE__COMPAT

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Enable terminology import

Enable terminology import.

ID

zen-project.terminology.import.enable

Type

Bool

Default value

true

Environment variable

BOX_ZEN_PROJECT_TERMINOLOGY_IMPORT_ENABLE

Deprecated environment variables

BOX_FEATURES_TERMINOLOGY_IMPORT_ENABLE

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Enable terminology sync

Enable terminology sync.

ID

zen-project.terminology.import.sync

Type

Bool

Default value

false

Environment variable

BOX_ZEN_PROJECT_TERMINOLOGY_IMPORT_SYNC

Deprecated environment variables

BOX_FEATURES_TERMINOLOGY_IMPORT_SYNC

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Build FTR index on startup

Build FTR index on startup.

ID

zen-project.ftr.build-index-on-startup.enable

Type

Bool

Default value

true

Environment variable

BOX_ZEN_PROJECT_FTR_BUILD_INDEX_ON_STARTUP_ENABLE

Deprecated environment variables

BOX_FEATURES_FTR_BUILD__INDEX__ON__STARTUP_ENABLE

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Sync FTR index on Aidbox start

Sync FTR index on Aidbox start.

ID

zen-project.ftr.build-index-on-startup.sync

Type

Bool

Default value

false

Environment variable

BOX_ZEN_PROJECT_FTR_BUILD_INDEX_ON_STARTUP_SYNC

Deprecated environment variables

BOX_FEATURES_FTR_BUILD__INDEX__ON__STARTUP_SYNC

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Enable incremental updates of the FTR index

Enable incremental updates of the FTR index

ID

zen-project.ftr.incremental-index-updates.enable

Type

Bool

Default value

true

Environment variable

BOX_ZEN_PROJECT_FTR_INCREMENTAL_INDEX_UPDATES_ENABLE

Deprecated environment variables

BOX_FEATURES_FTR_INCREMENTAL__INDEX__UPDATES_ENABLE

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Load FTR index into Aidbox DB

Load FTR index into Aidbox DB

ID

zen-project.ftr.pull.enable

Type

Bool

Default value

false

Environment variable

BOX_ZEN_PROJECT_FTR_PULL_ENABLE

Deprecated environment variables

BOX_FEATURES_FTR_PULL_ENABLE

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Load FTR index synchronously

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

ID

zen-project.ftr.pull.sync

Type

Bool

Default value

false

Environment variable

BOX_ZEN_PROJECT_FTR_PULL_SYNC

Deprecated environment variables

BOX_FEATURES_FTR_PULL_SYNC

Sensitive

false β€” value will be visible in plaintext in Admin UI

Set via

Admin UI β†’ Settings Environment variables

Hot reload

false β€” setting requires system restart

Last updated

Was this helpful?