Modules

Modules

Modules settings

Subscriptions

Google Cloud Pub/Sub subscriptions settings

Google Cloud Pub/Sub topic name

Name of the Google Cloud Pub/Sub topic.

ID	module.subscriptions.pubsub.topic
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SUBSCRIPTIONS_PUBSUB_TOPIC
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Google Cloud Pub/Sub project name

Name of the Google Cloud Project which contains Pub/Sub topics and subscriptions.

ID	module.subscriptions.pubsub.project
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SUBSCRIPTIONS_PUBSUB_PROJECT
Deprecated environment variables	BOX_SUBSCRIPTIONS_PUBSUB_PROJECT
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Google Cloud Pub/Sub resource types

Specify resource types and boxes for which to publish notifications. If not set, messages for all resource types from all boxes are published.

<rt>:?<box-id>?( <rt>:?<box-id>?)*
// Examples:
//
// Notify only on Patient or Encounter resources
// change from any box.

"Patient Encounter"

// Notify on Patient changes from boxone or boxtwo
// and about Encounter from any box.

"Patient:boxone Patient:boxtwo Encounter"

ID	module.subscriptions.pubsub.resource-types
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SUBSCRIPTIONS_PUBSUB_RESOURCE_TYPES
Deprecated environment variables	BOX_SUBSCRIPTIONS_PUBSUB_RESOURCE__TYPES
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Google Cloud Pub/Sub service account email

Email of the Google Cloud Pub/Sub service account.

ID	module.subscriptions.pubsub.service-account.email
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SUBSCRIPTIONS_PUBSUB_SERVICE_ACCOUNT_EMAIL
Deprecated environment variables	BOX_SUBSCRIPTIONS_PUBSUB_SERVICE__ACCOUNT_EMAIL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Google Cloud Pub/Sub service account private key

Private key of the Google Cloud Pub/Sub service account.

ID	module.subscriptions.pubsub.service-account.private-key
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SUBSCRIPTIONS_PUBSUB_SERVICE_ACCOUNT_PRIVATE_KEY
Deprecated environment variables	BOX_SUBSCRIPTIONS_PUBSUB_SERVICE__ACCOUNT_PRIVATE__KEY
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	true — setting can be changed at runtime

Google Cloud Pub/Sub publish before save

If true, the resource will be published to the Pub/Sub topic before saving it to the database.

ID	module.subscriptions.pubsub.before-save
Type	Bool
Default value	(no default)
Environment variable	BOX_MODULE_SUBSCRIPTIONS_PUBSUB_BEFORE_SAVE
Deprecated environment variables	BOX_SUBSCRIPTIONS_PUBSUB_BEFORE__SAVE
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Google Cloud Pub/Sub emulator URL

URL of the Google Cloud Pub/Sub emulator. If set, the emulator will be used instead of the real Pub/Sub service.

ID	module.subscriptions.pubsub.emulator-url
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SUBSCRIPTIONS_PUBSUB_EMULATOR_URL
Deprecated environment variables	BOX_SUBSCRIPTIONS_PUBSUB_EMULATOR__URL
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

Notebooks

Aidbox notebooks settings

Notebook repository URL

Set repository to fetch published notebooks

ID	module.notebook.repo-url
Type	String
Default value	https://aidbox.app
Environment variable	BOX_MODULE_NOTEBOOK_REPO_URL
Deprecated environment variables	AIDBOX_NOTEBOOKS_REPO_URL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Environment variables
Hot reload	true — setting can be changed at runtime

Mail Provider

Mail Provider settings

Default provider type

Specifies the email service provider used for system-generated communications.

ID	provider.default.type
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_DEFAULT_TYPE
Deprecated environment variables	BOX_PROVIDER_DEFAULT__PROVIDER_TYPE
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Default provider from address

From address for the default provider

ID	provider.default.from
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_DEFAULT_FROM
Deprecated environment variables	BOX_PROVIDER_DEFAULT__FROM
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Default provider username

Username for the default provider

ID	provider.default.username
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_DEFAULT_USERNAME
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Default provider password

Password for the default provider

ID	provider.default.password
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_DEFAULT_PASSWORD
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	true — setting can be changed at runtime

Default provider URL

URL for the default provider

ID	provider.default.url
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_DEFAULT_URL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Default provider port

Port for the default provider

ID	provider.default.port
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_DEFAULT_PORT
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Default provider SSL

Enable SSL for the default provider

ID	provider.default.ssl
Type	Bool
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_DEFAULT_SSL
Deprecated environment variables	BOX_PROVIDER_DEFAULT__PROVIDER_SSL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Default provider TLS

Enable TLS for the default provider

ID	provider.default.tls
Type	Bool
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_DEFAULT_TLS
Deprecated environment variables	BOX_PROVIDER_DEFAULT__PROVIDER_TLS
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Default provider host

Host for the default provider

ID	provider.default.host
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_DEFAULT_HOST
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Mailgun provider from address

From address for the Mailgun provider

ID	provider.mailgun.from
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_MAILGUN_FROM
Deprecated environment variables	BOX_PROVIDER_MAILGUN__PROVIDER_FROM
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Mailgun provider username

Username for the Mailgun provider

ID	provider.mailgun.username
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_MAILGUN_USERNAME
Deprecated environment variables	BOX_PROVIDER_MAILGUN__PROVIDER_USERNAME
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Mailgun provider password

Password for the Mailgun provider

ID	provider.mailgun.password
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_MAILGUN_PASSWORD
Deprecated environment variables	BOX_PROVIDER_MAILGUN__PROVIDER_PASSWORD
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	true — setting can be changed at runtime

Mailgun provider URL

URL for the Mailgun provider

ID	provider.mailgun.url
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_MAILGUN_URL
Deprecated environment variables	BOX_PROVIDER_MAILGUN__PROVIDER_URL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Postmark provider from address

From address for the Postmark provider

ID	provider.postmark.from
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_POSTMARK_FROM
Deprecated environment variables	BOX_PROVIDER_POSTMARK__PROVIDER_FROM
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Postmark provider API key

API key for the Postmark provider

ID	provider.postmark.api-key
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_POSTMARK_API_KEY
Deprecated environment variables	BOX_PROVIDER_POSTMARK__PROVIDER_API__KEY
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Environment variables
Hot reload	true — setting can be changed at runtime

SMTP provider from address

From address for the SMTP provider

ID	provider.smtp.from
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_SMTP_FROM
Deprecated environment variables	BOX_PROVIDER_SMTP__PROVIDER_FROM
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

SMTP provider host

Host for the SMTP provider

ID	provider.smtp.host
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_SMTP_HOST
Deprecated environment variables	BOX_PROVIDER_SMTP__PROVIDER_HOST
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

SMTP provider password

Password for the SMTP provider

ID	provider.smtp.password
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_SMTP_PASSWORD
Deprecated environment variables	BOX_PROVIDER_SMTP__PROVIDER_PASSWORD
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	true — setting can be changed at runtime

SMTP provider port

Port for the SMTP provider

ID	provider.smtp.port
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_SMTP_PORT
Deprecated environment variables	BOX_PROVIDER_SMTP__PROVIDER_PORT
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

SMTP provider SSL

Enable SSL for the SMTP provider

ID	provider.smtp.ssl
Type	Bool
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_SMTP_SSL
Deprecated environment variables	BOX_PROVIDER_SMTP__PROVIDER_SSL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

SMTP provider TLS

Enable TLS for the SMTP provider

ID	provider.smtp.tls
Type	Bool
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_SMTP_TLS
Deprecated environment variables	BOX_PROVIDER_SMTP__PROVIDER_TLS
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

SMTP provider username

Username for the SMTP provider

ID	provider.smtp.username
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_PROVIDER_SMTP_USERNAME
Deprecated environment variables	BOX_PROVIDER_SMTP__PROVIDER_USERNAME
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

SMARTbox

SMARTbox settings

Sandbox URL

URL for accessing sandbox environment

ID	module.smartbox.sandbox-url
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SMARTBOX_SANDBOX_URL
Deprecated environment variables	BOX_SMARTBOX_SANDBOX__URL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Terms of use URL

URL for accessing terms of use

ID	module.smartbox.terms-of-use-url
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SMARTBOX_TERMS_OF_USE_URL
Deprecated environment variables	BOX_SMARTBOX_TERMS__OF__USE__URL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Sandbox basic

Basic authentication credentials for sandbox

ID	module.smartbox.sandbox-basic
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SMARTBOX_SANDBOX_BASIC
Deprecated environment variables	BOX_SMARTBOX_SANDBOX__BASIC
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	true — setting can be changed at runtime

Sandbox admin

Admin credentials for sandbox access

ID	module.smartbox.sandbox-admin
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SMARTBOX_SANDBOX_ADMIN
Deprecated environment variables	BOX_SMARTBOX_SANDBOX__ADMIN
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Environment variables
Hot reload	false — setting requires system restart

Session logs link

Link to access session logs

ID	module.smartbox.session-logs-link
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SMARTBOX_SESSION_LOGS_LINK
Deprecated environment variables	BOX_SMARTBOX_SESSION__LOGS__LINK
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

MDM

MDM settings

Default MDM model

The default MDM model used for $match operation. Will be used if no model is specified with the model query parameter.

ID	module.mdm.default-patient-model
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_DEFAULT_PATIENT_MODEL
Deprecated environment variables	BOX_MDM_DEFAULT_PATIENT_MODEL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Forms

Forms settings

Questionnaire.url prefix

URL prefix that will be used in URL generation for new forms

ID	module.sdc.builder.form-url-prefix
Type	String
Default value	http://forms.aidbox.io/questionnaire/
Environment variable	BOX_MODULE_SDC_BUILDER_FORM_URL_PREFIX
Deprecated environment variables	BOX_SDC_BUILDER_FORM_URL_PREFIX
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

OpenAI API key

API key for OpenAI service

ID	module.sdc.openai-api-key
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SDC_OPENAI_API_KEY
Deprecated environment variables	BOX_SDC_OPENAI_API_KEY
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	true — setting can be changed at runtime

Gemini API key

API key for Gemini service

ID	aidbox.modules.sdc.gemini-api-key
Type	String
Default value	(no default)
Environment variable	BOX_SDC_GEMINI_API_KEY
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	true — setting can be changed at runtime

Default language for UI

Language used as default in Form Builder and Form Renderer

ID	module.sdc.language
Type	String
Default value	en
Environment variable	BOX_MODULE_SDC_LANGUAGE
Deprecated environment variables	BOX_SDC_LANGUAGE
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Default form theme

Theme that will be used in all forms

ID	module.sdc.theme
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SDC_THEME
Deprecated environment variables	BOX_SDC_THEME
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Hide builder's back button

Hide back button in UI Form Builder

ID	module.sdc.builder.hide-back-button
Type	Bool
Default value	(no default)
Environment variable	BOX_MODULE_SDC_BUILDER_HIDE_BACK_BUTTON
Deprecated environment variables	BOX_SDC_BUILDER_HIDE_BACK_BUTTON
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Form's redirect-on-submit URL

Redirect URI that will be used on form submit/amend button click

ID	module.sdc.form.redirect-on-submit
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SDC_FORM_REDIRECT_ON_SUBMIT
Deprecated environment variables	BOX_SDC_FORM_REDIRECT_ON_SUBMIT
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Form's redirect-on-save URL

Redirect URI that will be used on form save/close button click

ID	module.sdc.form.redirect-on-save
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_SDC_FORM_REDIRECT_ON_SAVE
Deprecated environment variables	BOX_SDC_FORM_REDIRECT_ON_SAVE
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

GraphQL

GraphQL settings

Warmup GraphQL cache on startup

Warmup GraphQL API cache on startup. When false, cache will be warmed up on first request.

ID	module.graphql.warmup-on-startup
Type	Bool
Default value	(no default)
Environment variable	BOX_MODULE_GRAPHQL_WARMUP_ON_STARTUP
Deprecated environment variables	BOX_FEATURES_GRAPHQL_WARMUP__ON__STARTUP
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

Allow reference to any resource

Enable GraphQL API (rev)include for reference with target - any

ID	module.graphql.reference-any
Type	Bool
Default value	(no default)
Environment variable	BOX_MODULE_GRAPHQL_REFERENCE_ANY
Deprecated environment variables	BOX_FEATURES_GRAPHQL_REFERENCE__ANY
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

GraphQL timeout

GraphQL API query timeout in seconds: Set to zero to disable.

ID	module.graphql.timeout
Type	Int
Default value	60
Environment variable	BOX_MODULE_GRAPHQL_TIMEOUT
Deprecated environment variables	BOX_FEATURES_GRAPHQL_TIMEOUT
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

GraphQL access control mode

Access control in GraphQL API

ID	module.graphql.access-control
Type	Enum
Values	rest-search — Additionally authorization checks access to corresponding search queries disabled — Only access to GraphQL endpoint is verified
Default value	disabled
Environment variable	BOX_MODULE_GRAPHQL_ACCESS_CONTROL
Deprecated environment variables	BOX_FEATURES_GRAPHQL_ACCESS__CONTROL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Webpush

Webpush settings

Public Key

ECDH/BC/prime256v1 Public Key

ID	module.webpush.public-key
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_WEBPUSH_PUBLIC_KEY
Deprecated environment variables	BOX_FEATURES_WEBPUSH_KEYPAIR_PUBLIC
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Private Key

ECDH/BC/prime256v1 Private Key

ID	module.webpush.private-key
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_WEBPUSH_PRIVATE_KEY
Deprecated environment variables	BOX_FEATURES_WEBPUSH_KEYPAIR_PRIVATE
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	true — setting can be changed at runtime

JWT mail

JWT.sub field value needs to be either a URL or a mailto email address. If a push service needs to reach out to sender, it can find contact information from the JWT.

ID	module.webpush.jwt-mail
Type	String
Default value	(no default)
Environment variable	BOX_MODULE_WEBPUSH_JWT_MAIL
Deprecated environment variables	BOX_FEATURES_WEBPUSH_JWT_MAIL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

Usage Statistics

Usage Statistics