Runtime Customization

Last modified: November 5, 2026

Introduction

You can use custom server settings to configure Mendix Runtime beyond the standard possibilities offered by Studio Pro.

Each custom setting consists of a name and a value. For example, to set the hash algorithm to BCRYPT you add a custom setting with name HashAlgorithm and value BCRYPT. For a more detailed list of settings and example values, consult full-documented-m2ee.yaml.

If you are running your app on Mendix Cloud or SAP Business Technology Platform, you can access these settings by opening your app in Projects and choosing Environments > Environment Details > Runtime > Custom Runtime Settings. For more information see:

  • the Runtime Tab section of Environment Details for information about Mendix Cloud
  • the Runtime tab section of Environment Details on SAP BTP for information about the SAP BTP

When you are running your app locally, you can set these values in a Configuration.

There is more information on how this is done in the Cloud Foundry buildpack in Custom Runtime Settings in the GitHub repo.

For Docker-based deployments, runtime configurations are set using environment variables as explained in the GitHub repo

For Windows-based deployments, runtime configurations are set from the Mendix Service Console under Configuration > Advanced Settings > Custom Mendix settings.

Duration/Interval Settings

Durations and intervals can be specified in the following formats:

General Settings

The following custom settings can be configured:

Name Description Default Value
ApplicationRootUrl see ApplicationRootUrl, below In Mendix Cloud, https://[domain].mendixcloud.com
CACertificates A comma-separated list of paths to CA certificates. Example: D:\App\CA1.pem, D:\App\CA2.pem, D:\App\CA3.pem, D:\App\CA4.pem
ClientCertificatePasswords Comma-separated list of passwords for Client Certificates (should match the ClientCertificates order). Example: pwd1, pwd2, pwd3, pwd4
ClientCertificates Comma-separated list of paths to Client Certificates. Example: D:\App\Mx1.pfx, D:\App\Mx2.pfx, D:\App\Mx3.pfx, D:\App\Mx4.pfx
ClientCertificateUsages Only use this when you have multiple client certificates and you want to configure specific certificates for specific servers.
This setting defines which service must use which client certificate. See NoClientCertificateUsages if you want to make sure that no client certificate is used for a certain host or web service. The value of ClientCertificateUsages must be a comma-separated list of key/value items. A key/value item must be specified as "identifier": "path to certificate".
For web services, use the imported web service name as the identifier.
For REST services, use the host name of the remote server as the identifier.
Please note that any backslash in the path must be doubled. The whole value must be enclosed by braces ({ }). For example:
NoClientCertificateUsages Comma-separated list of host names or imported web service names that should never be contacted using a client certificate.
ClusterManagerActionInterval The interval (in milliseconds) used for performing all cluster manager actions. These are actions such as unblocking users and removing invalid sessions. See Session Timing Constraints and Defaults in Advanced Custom Settings for important details about valid values and their relationship to other session settings. 300000 (5 minutes)
com.mendix.core.isClusterSlave Set to true on every node except the Cluster Leader in a high-availability scenario. This setting only applies when the Runtime is started through the administrative API (the leader-based startup model); it has no effect when the Runtime is started directly from a configuration file (the leaderless startup model), which is always the case for Mendix Portable Runtime. See Cluster Leader and Cluster Followers for details on both models.
false
com.mendix.core.LenientDateTimeParsing When set to true, the parseDateTime function will use more lenient parsing, as it did in Mendix 9. For example parseDateTime("yyyyMMdd", "2021-11-10") will return 2020-11-01 as a date if this is set to true, which is probably not the intended result.. If set to false, which is the default, this example will throw an error as it is expecting 20211110. It is recommended to not enable this setting to avoid unexpected results. false
com.mendix.core.SameSiteCookies The SameSite property can be included in all cookies that are returned by the embedded HTTP server. The possible values are Strict, Lax, and None. The default is Strict. Setting it to None is typically needed only when an application is embedded in an iframe of another application with a different domain. Newer browsers may require the connection to be secure (HTTPS) when set to None. If the connection is plain HTTP, then this setting must be changed to Strict (recommended) or Lax.
com.mendix.core.ScheduledEventsCleanupAge This setting specifies (in milliseconds) how old objects in the System.ScheduledEventInformation table have to be before they are removed from the database. See Scheduled Events - Legacy for more details. 365 days for projects migrated from Mendix 9 and 7 days for new projects or projects with an empty database.
com.mendix.core.ScheduledEventsCleanupBatchSize This setting specifies how many System.ScheduledEventInformation objects will be removed from the database each time the ScheduledEventInformation cleanup task runs. See Scheduled Events - Legacy for more details. 10000
com.mendix.core.SessionIdCookieName Defines the name of the cookie value which represents the session ID. Can be useful to change when running in a container which assumes a certain name for the session cookie. XASSESSIONID
com.mendix.core.StorageService Defines which storage service module will be used. The storage service module takes care of storing the actual files associated with System.FileDocument objects, such as uploaded files. Possible values are com.mendix.storage. localfilesystem, com.mendix.storage.s3, and com.mendix.storage.azure. com.mendix.storage.localfilesystem
com.mendix.core.UseMimeDecoderForBase64 The setting defines whether to use the Basic decoder (RFC 4648) or MIME decoder (RFC 2045) when decoding base64 binary data. The Basic decoder is recommended due to its strictness in not accepting any character outside the Base64 specification, see Security Considerations. This setting exists for reasons of backward compatibility.
false
com.mendix.storage.PerformDeleteFromStorage Defines whether a delete of a Mendix file document should result in an actual delete in the storage service. A reason to not perform an actual delete in the storage service can be when it is also used as a backup service. The options are:
  • AllFiles – Deletes files from file storage
  • TemporaryFiles – Deletes files which were created during a transaction but not referenced by any file document from file storage
  • NoFiles – No files are deleted from file storage.
Additionally, we have legacy options true (same as AllFiles) and false (same as TemporaryFiles) which will be deprecated in the future.		 true
com.mendix.core.ProcessedTasksCleanupAge This setting specifies (in milliseconds) how old objects in the System.ProcessedQueueTask have to be before they are removed from the database. See Task Queue for more details. 365 days for projects migrated from Mendix 9 and 7 days for new projects or projects with an empty database.
com.mendix.core.ProcessedTasksCleanupBatchSize This setting specifies how many System.ProcessedQueueTask objects will be removed from the database each time the ProcessedTask cleanup action runs. See Task Queue for more details. 10000
com.mendix.services.publish.AllowWebServiceUserBasicAuthenticationInODataAndREST Set to true to allow web service users to access published OData and REST services when using basic authentication. false
EnableApacheCommonsLogging Some libraries used by the Mendix runtime use Apache Commons for logging. By default these log messages are suppressed. Set this value to true to receive the log messages from these libraries in the Mendix logs. false
HashAlgorithm Specifies the hash algorithm used to generate hash values for attributes of the HashString type, such as the password of a user. This setting overrides the setting in Studio Pro, see Hash Algorithm. Possible values are BCRYPT, SSHA256, SHA256 (not recommended) and MD5 (not recommended). To override the default BCrypt cost, you can specify BCRYPT:cost, where 'cost' is a number between 10 and 30. An example value is BCRYPT:12. BCRYPT
http.client.CleanupAfterSeconds For the call REST service and call web service activities, the first request to a new host will create an HTTP client that will handle subsequent requests. When there are no new requests to the host for the specified time, the HTTP client will be cleaned up. A value of 0 means no cleanup.
355 (355 seconds)
http.client.MaxConnectionsPerRoute The maximum number of connections for a route for call REST service and call web service activities.
2
http.client.MaxConnectionsTotal The maximum number of connections allowed across all routes for the call REST service and call web service activities.
20
HttpClient.ValidateAfterInactivityMs When set, pooled HTTP connections are validated after the specified number of milliseconds of inactivity before being reused. This helps detect stale connections in environments where intermediaries (for example, firewalls and load balancers) silently drop connections. Applies to the Call REST service and Call web service activities. Disabled. Introduced in Mendix 11.6.12, 11.12.5, and 11.15.0
JavaKeyStorePassword Password for the default Java keystore. changeit
MyScheduledEvents A comma-separated string with the names of the events. Please don't forget the name of the module (a name can be, for example, CRM.UpdateCustomerStatistics).
ScheduledEventExecution Specify which scheduled events should be executed. Choices are ALL, NONE, or SPECIFIED. In the case of SPECIFIED, enumerate the scheduled events using the MyScheduledEvents configuration option described below.
NONE
SessionKeepAliveUpdatesInterval Defines how often a runtime writes session LastActive dates in its memory back to the database. See Session Timing Constraints and Defaults in Advanced Custom Settings for important details about valid values and their relationship to other session settings. 100000 (100 seconds)
SessionTimeout Defines after how much time a session becomes invalid (in milliseconds). After that timeout, a session becomes eligible for removal. The session will not be destroyed until the next time a scheduled task runs to clean up the active sessions.
600000 (10 minutes)
AbsoluteSessionTimeout Defines after how much time a session becomes invalid (in milliseconds). After that timeout, a session becomes eligible for removal. As opposed to the SessionTimeout, the AbsoluteSessionTimeout timeout is not affected by user interactions. This does not override SessionTimeout, sessions also become invalid if SessionTimeout is reached. The session will be destroyed in the same way as for SessionTimeout, above. If the setting is not set then this behavior is disabled, which is the default. Disabled. Introduced in Mendix 11.4.0.
SessionValidationTimeout Defines the maximum caching time (in milliseconds) for sessions. This means that after signing out of a session, the session might still be accessible for the configured time on other nodes of the cluster, but only if that node has handled a previous request on that session just before the logout happened. Lowering it makes the cluster more secure, because the chance that the session is still accessible within the configured time window is smaller. However, this also requires more frequent roundtrips to the database (which impacts performance). Increasing the timeout has the opposite effect 30000 (30 seconds)
Headers A JSON object containing custom headers as key/value pairs, and can be used to define a Content-Security-Policy. For example, { "Content-Security-Policy": "script-src 'nonce-{{ NONCE }}'" }. {}
TaskQueue.ShutdownGracePeriod Time in ms to wait for task in a task queue to finish when shutting down. 10000 (10 seconds)
TempPath The location of the temporary files. [deployment folder]\data\tmp
TrackWebServiceUserLastLogin Defines whether to update a user's LastLogin field on each login when logging in to a published REST, OData, or web service. When this happens a database update query has to be sent and this can have performance consequences on heavy load systems. When this setting is set to false, no database interaction is necessary. true
UploadedFilesPath The location of the uploaded files. A valid path can be: \\FileServer\CustomerPortalFiles. [deployment folder]\data\files
EnableFileDocumentCaching Defines whether file documents should be cached. Only enable this if you are sure that the file documents will not contain sensitive information. Images are always cached. false
mapping.import.MaxJsonReadingLength The maximum length of the JSON string received from the remote which can be processed with import mapping. Use this setting when you expect a string which is longer than the default. See Import Mappings for more information. 20000000 (dependent on library version)
LastActionExecutionUpdateBatchSize This setting specifies how many sessions should be updated per batch when updating the LastActionExecution attribute in the periodic system task. 1000 Introduced in Mendix 11.6.1 and 11.7.0.
SessionKeepAliveUpdateBatchSize This setting specifies how many sessions should be updated per batch when updating the LastActive attribute in the periodic system task. 1000 Introduced in Mendix 11.6.1 and 11.7.0.
UseOldExceptionBehavior Allows you to set the exception message and wrapping behavior in the Mendix Runtime Server to the behavior below Mendix version 11.6.0. From Mendix 11.6.0 we changed the way messages are constructed to prevent the actual cause of the error being hidden in the details and exception wrapping is reduced significantly.

This change means that error messages will be different and have a significantly less deep exception nesting. Consequently, code which depends on finding some specific exception hardcoded at X levels deep (using exception.getCause().getCause() for example), will probably fail.

To restore the previous behavior, set UseOldExceptionBehavior to true.		 false Introduced in Mendix 11.6.0.

ApplicationRootUrl

The ApplicationRootUrl setting is used to specify the protocol, domain, and path to your application. This can be used within Java actions to get the public location of the application, for example when including a URL to the application when sending emails from a scheduled event.

There are two main ways that you might use to host multiple applications.

  • Routing based on a (sub)domain
  • Routing based on a subpath

Say we are hosting two apps: App1 and App2. In domain-based routing, every app gets its own domain (for example. app1.domain.com and app2.domain.com). In subpath-based routing, this would be on a subpath, for example domain.com/app1 and domain.com/app2.

When setting up either routing variant, most content is correctly served automatically as it is relative to the path in which it is being served. Exceptions to this include:

  1. Client components that automatically forward/route you to a top-level domain
  2. Content that specifies a full path to your public domain/path

For the first case, domain-based routing is generally more stable, although path-based routing is also possible.

Examples of the second case are OData contracts, sending mails to your organization, and any place you want to render a static URL in your application. For this case it is possible to specify the ApplicationRootUrl.

Multiple External Domains

Mendix systems like OData that generate content based on a http request to the server, will use the headers passed (for example, by a proxy) to generate content. These headers are X-Forwarded-Proto, X-Forwarded-Scheme, X-Forwarded-Host, X-Forwarded-Port, X-Forwarded-Prefix and Host. For Mendix 10 and above, ApplicationRootUrl will take precedence over these headers. If you host a single application on two or more domains, you will have to choose one of the domains to represent the public-facing URL.

Log File Settings

The settings below influence the behavior of the log files. These settings can only be used on premises. In the cloud, these settings do not change any behavior.

Name Description Default Value
LogFileName The name of the log file. The log files (actual log file plus back-up files) will be placed in the folder specified by the setting log path. Application.log
MaxLogFileSize The maximum size per log file. When the log file reaches this maximum size, the log file will be backed up and a new empty log file will be used. 2097152 (2 MB)
MaxLogFileCount The maximum count of log files preserved (actual file plus back-up files). When the maximum count is reached, the oldest backup file will be removed. 10

Database Settings

Common Settings

Name Description Default Value
ClientQueryTimeout Defines the timeout in seconds for most of the database queries which are executed to load data into client widgets, like data grids. After the duration as specified here, a query will be canceled and an exception will be thrown.
DatabaseType Defines the database engine which is used as the Mendix database. Valid values are HSQLDB, MYSQL, ORACLE, POSTGRESQL, SAPHANA, and SQLSERVER.
DatabaseUserName Name required for authentication to the database.
DatabasePassword Password for the DatabaseUserName supplied above.
DatabaseHost The host name and optionally the TCP port number of the database. Use a colon (:) as separator between the host name and port number. Possible values are: db.url.org, db.url.org:1521, 10.0.0.5, and10.0.0.5:1433. It is possible to use a plain IPv6 address by enclosing it in brackets (for example, [::1]:5432).
This will be overridden if you supply DatabaseJdbcUrl.
DatabaseName The name of the database or schema used by the Mendix app
Some database types require this even if a DatabaseJdbcUrl is defined.
DatabaseJdbcUrl Defines the JDBC URL to use for the database connection (which overrides the other database connection settings).
DatabaseUseSsl When true, the connection will be made using SSL without certificate validation. If you need certificate validation, use DatabaseJdbcUrl instead.
When false, the connection will be made without SSL (this is only relevant for SQL Server, which uses SSL by default).
DatabaseUseIntegratedSecurity This setting defines whether integrated security will be used to authenticate to SQL Server. If true, user name and password will not be used.
Ensure that the proper domain user for accessing the SQL Server is authenticated on the runtime server using the kinit command.		 false
LogMinDurationQuery Defines whether database queries are logged via the ConnectionBus_Queries log node if they finished after the number of milliseconds specified here. By default, only the relevant SQL query will be logged. Set the log level of the ConnectionBus_Queries log node to TRACE to show more information about the page or the microflow which leads to this query.
OracleServiceName Defines the SERVICE_NAME when you have a connection with an Oracle DBMS.
DataStorage.EnableDiagnostics This setting can be used to generate a uniqueness constraint violation report. false
UseNetworkTimeout This setting is applied to PostgreSQL. It affects the timeout mechanism used when reserving new ids for Mendix objects. If set to true, the socket level request timeout is used. In that case, the request timeout is handled within the operating system. If set to false, the timeout is handled by Mendix runtime. For other databases, timeouts are always handled by Mendix runtime. true
JdbcLoginTimeout This setting defines the database connection establishment time in milliseconds. 5000 (5 seconds)
DataStorage.OptimizeSecurityColumns When true, query columns generated to evaluate XPath constraints in access rules are optimized to true if the runtime can determine that the value will always be true for the objects that the query returns. This is almost always an improvement, but we have seen cases where the PostgreSQL query planner has worse performance for the simpler query. true

Connection Pooling

The settings below are used to define the database connection pooling behavior. Mendix Runtime uses a pool of reusable database connections. You can, for example, define how many connections can be used. Connection pooling is implemented using the Apache Commons Object-pooling API.

These settings are configured per runtime instance. If you have scaled your application, the number of connections on the database side will be multiplied by the number of runtime instances. For example, if you set ConnectionPoolingMaxIdle to 50 and scale your app to 2 runtime instances, each runtime instance will create at most 50 connections, but on the database side this will lead to a maximum of 100 connections.

Name Value Default Value
ConnectionPoolingMaxWait When the maximum number of "active" objects has been reached, the pool is said to be "exhausted." The "when exhausted" action used by the connection bus is WHEN_EXHAUSTED_BLOCK. Sets the maximum amount of time (in milliseconds) the borrowObject() method should block before throwing an exception when the pool is exhausted. When less than or equal to 0, the borrowObject() method may block indefinitely. (!) 10000 (10 seconds)
ConnectionPoolingMaxActive Sets the cap on the total number of active instances from the pool. 50
ConnectionPoolingMaxIdle Sets the cap on the number of "idle" instances in the pool. 50
ConnectionPoolingMinIdle Sets the minimum number of objects allowed in the pool before the evictor thread (if active) spawns new objects. Note that no objects are created when numActive + numIdle >= maxActive. This setting has no effect if the idle object evictor is disabled (as in, if timeBetweenEvictionRunsMillis <= 0). 0
ConnectionPoolingTimeBetweenEvictionRunsMillis Sets the number of milliseconds to sleep between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run. 300 000 (5 minutes)
ConnectionPoolingSoftMinEvictableIdleTimeMillis Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any), with the extra condition that at least minIdle objects remain in the pool. When non-positive, no objects will be evicted from the pool due to idle time alone. 300 000 (5 minutes)
ConnectionPoolingNumTestsPerEvictionRun Sets the maximum number of objects to examine during each run of the idle object evictor thread (if any). When a negative value is supplied, ceil(getNumIdle())/ abs(getNumTestsPerEvictionRun()) tests will be run. This means that when the value is -n, roughly one nth of the idle objects will be tested per run. -3
ConnectionPoolingTestOnBorrow If true, a database connection will be validated by the connection pool before returning it to the application. This can be useful in situations where database connections can be closed by processes outside of the Mendix runtime, like firewalls. false
ConnectionPoolingTestOnCreate If true, a database connection will be validated by the connection pool after being created. false
ConnectionPoolingTestOnReturn If true, a database connection will be validated by the connection pool when it is returned to the pool by the application. false
ConnectionPoolingTestWhileIdle If true, all idle database connections will be validated when the idle object evictor runs. false

Migration Settings

The settings below are used to define the source database from which all data should be copied to the main database. You have to specify the settings below only once. The main database should exist and should be empty. During the app start-up, the data will be copied if the settings below are specified. Remove the settings afterward, because they are not needed anymore.

Before the data copying process starts, the main database structure will be generated based on the source database structure. This is necessary to make sure all the data is copied without any problems, especially in cases where the source database has a larger element value than the current domain model specifies.

Name Value Default Value
SourceBuiltInDatabasePath Defines the file location of the built-in source database. This setting is only necessary if a non-default location of the built-in database has to be used to copy the data from. [deployment folder]/data/database
SourceDatabaseHost The host name and optionally the TCP port number of the source database. Use a colon as separator between host name and port number. Possible values are: db.url.org, db.url.org:1521, 10.0.0.5, or 10.0.0.5:1433. It's possible to use a plain IPv6 address by enclosing it in brackets (for example, [::1]:5432).
SourceDatabaseJdbcUrl Defines the JDBC URL to use for the source database connection (which overrides the other source database connection settings).
SourceDatabaseName The name of the source database.
SourceDatabasePassword The password for the connection to the source database.
SourceDatabaseType The type of the source database. Possible values: HSQLDB, MYSQL, ORACLE, POSTGRESQL, SAPHANA, or SQLSERVER.
SourceDatabaseUseIntegratedSecurity This setting defines whether integrated security will be used to authenticate to SQL Server. If true, user name and password will not be used. See DatabaseUseIntegratedSecurity for more information. false
SourceDatabaseUseSsl When true, the connection to the source database will be made using SSL without certificate validation. If you need certificate validation, use SourceDatabaseJdbcUrl instead.
When false, the connection to the source database will be made without SSL (this is only relevant for SQL Server, which uses SSL by default).
SourceDatabaseUserName The user name for the connection to the source database.
SourceOracleServiceName Defines the SERVICE_NAME when you have a connection with an Oracle DBMS as source.

S3 Storage Service Settings

The settings described below influence the behavior of the Amazon S3 Storage Service module. This module can be used for both Amazon S3 Storage and IBM Cloud Object Storage.

Name Description Default Value
com.mendix.storage.s3.AccessKeyId Acts as the username to authenticate with the S3 service.
com.mendix.storage.s3.SecretAccessKey Acts as the password to authenticate with the S3 service.
com.mendix.storage.s3.BucketName Name of the bucket where the files are stored on S3.
com.mendix.storage.s3.ResourceNamePrefix Prefix for the keys under which objects are stored. Separators are not added automatically to keys. For keys like prefix/key1, com.mendix.storage.s3.ResourceNamePrefix should have value prefix/.
com.mendix.storage.s3.ResourceNameSuffix Suffix for the keys under which objects are stored. This can be used when S3 buckets are divided into different segments for different users with different credentials (for example, store objects as [key].customer1 for customer1 and as [key].customer2 for customer2). Separators are not added automatically to keys. For keys like key1.customer1, com.mendix.storage.s3.ResourceNameSuffix should have value .customer1.
com.mendix.storage.s3.Region Sets the region in which the S3 bucket is located. This will be used to determine the service endpoint, unless overridden in com.mendix.storage.s3.EndPoint. This setting will also be used as the signing region for requests.

In Mendix version 11.6.0 and above, this setting is mandatory. The runtime will not start if this setting is not configured.
com.mendix.storage.s3.EndPoint Overrides the default endpoint. This setting is required when the storage is on a non-AWS location (for example, IBM Cloud Object Storage). Both the endpoint (for example, s3.example.com) or the full URL (including the protocol) are supported (for example, https://s3.example.com). Note that when setting a custom endpoint, path style access will be enabled. For more information, see Class S3ClientOptions.
com.mendix.storage.s3.UseV2Auth Lets the authentication policy use Signature Version 2 instead of the default Signature Version 4. Set this setting to true when the endpoint does not support Signature Version 4.

This setting is not supported in Mendix version 11.6.0 and above.		 false
com.mendix.storage.s3.EncryptionKeys List of keys which can be used to encrypt and decrypt data at rest in S3. The right key to decrypt the data with is automatically selected depending on with which key it was encrypted. Each encryption key consists of a key id, the encryption algorithm and the actual key (Base64 encoded).

In Mendix version 11.6.0 and above, only AES encryption algorithm is supported. See S3 Encryption Key Update for migration information and how to configure the setting.
com.mendix.storage.s3.ForceGlobalBucketAccessEnabled The value true allows the server to route requests to a different region than specified in these settings (false disallows it). true
com.mendix.storage.s3.MaxConnections Overrides the default maximum connections limit in the S3 service. The default value is enough for most applications, so we do not recommend explicitly setting this to a custom value unless a larger maximum connections limit is absolutely necessary. DEFAULT_MAX_CONNECTIONS field of the ClientConfiguration interface in the AWS SDK for Java.
com.mendix.storage.s3.ClientExecutionTimeout Sets the amount of time (in milliseconds) to allow a call to the storage service to complete. A value of 0 means no timeout. For more information, see the AWS Java SDK. 0 (no timeout)
com.mendix.storage.s3.ConnectionTimeout Sets the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out. A value of 0 means infinity and is not recommended. For more information, see the AWS Java SDK. 10.000 (10 seconds)
com.mendix.storage.s3.SocketTimeout Sets the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed. A value of 0 means infinity and is not recommended. For more information, see the AWS Java SDK. 50.000 (50 seconds)
com.mendix.storage.s3.RequestTimeout Sets the amount of time to wait (in milliseconds) for the request to complete before giving up and timing out. A value of 0 means no timeout. For more information, see the AWS Java SDK. 0 (no timeout)
com.mendix.storage.s3.UseCACertificates Set this value to true to use the configured CACertificates for the connection to the S3 service. false
FileStorage.S3.DisableChunkedEncoding Set this value to true to disable chunked transfer encoding when uploading files to S3 storage. This setting can be useful when working with S3-compatible storage services that do not fully support chunked encoding.`
This setting was introduced in Mendix version 11.10.0 and 11.6.6 MTS		 false

Microsoft Azure SQL

These settings can be changed to use a Microsoft Azure SQL database for your Mendix application.

First, you need to create an Azure SQL database (for information on how to do this, see this SQL Database Tutorial). Make sure your Azure firewall settings allow your Mendix application to reach the Azure SQL database (by default, the Azure firewall does not allow external connections).

Name Description Default Value
DatabaseType SQLSERVER
DatabaseHost "your-database-host.database.windows.net:1433"
DatabaseName your-databasename
DatabaseUserName your-username
DatabasePassword your-password

Microsoft Azure Blob Storage Settings

These settings can be used to store files using the Microsoft Azure blob storage service. Server-side encryption can be configured through the Azure Portal (for more information, see Azure Storage encryption for data at rest).

Name Description Default Value
com.mendix.core.StorageService Has to be set to com.mendix.storage.azure to select Azure as the storage service.
com.mendix.storage.azure.AccountName Account name to authenticate with the Azure blob storage service.
com.mendix.storage.azure.AccountKey Account key to authenticate with the Azure blob storage service.
com.mendix.storage.azure.SharedAccessSignature Provides delegated access to resources in your storage account. For more information, see Shared Access Signature on docs.microsoft.com.
com.mendix.storage.azure.UseDefaultAzureCredential Enables the use of the credential information present in the running environment. For more information, see DefaultAzureCredential on Microsoft Learn.
com.mendix.storage.azure.BlobEndpoint¹ Set the blob endpoint. This setting is required when authentication by SharedAccessSignature or UseDefaultAzureCredential is used.
com.mendix.storage.azure.Container Name of the container containing the blob.
com.mendix.storage.azure.CreateContainerIfNotExists Indicates whether to check if the container exists, and creates it if it does not exist. true
com.mendix.storage.azure.ParallelismFactor Maximum number of parallel multi-part file uploads/downloads. We advise not changing this setting unless you experience slow file transfers for large files. Choosing larger values will lead to higher memory usage. 5
com.mendix.storage.azure.UseHttps For enabling or disabling secure connections using HTTPS. Can be true or false. true
com.mendix.storage.azure.TimeoutIntervalInMs Sets the amount of time (in milliseconds) to allow a call to the storage service to complete. For more information, see the Azure libraries. No timeout
com.mendix.storage.azure.MaximumExecutionTimeInMs Sets the maximum execution time (in milliseconds) to use when making this request. For more information, see the Azure libraries. No maximum time

Web Client Settings

The settings below influence the behavior of the Mendix web client.

Name Description Default Value
EnableKeepAlive Defines whether the web client sends a keep alive request every SessionTimeout/2 milliseconds in order to prevent a session timeout. Each click in the browser also acts as KeepAlive. Disabling this property will result in the user being logged out automatically after SessionTimeout milliseconds of inactivity (default 10 minutes), even if the browser remains open. See SessionTimeout for more information. true
com.mendix.offline.DeleteAutoCommittedObjectsAfterSync Defines if auto-committed created during offline synchronization will be deleted from the database immediately.
Deprecated – should only be changed if you have compatibility issues upgrading from Mendix version 9.		 true
com.mendix.offline.SynchronizationCleanupInterval This setting defines how often objects of type System.OfflineSynchronizationHistory are cleaned up. 90 (90 days)
com.mendix.webui.AuthTokenTimeout Determines how many minutes your token will remain valid before re-authenticating using your full credentials. If no value is set, the token will expire after One year. Introduced in Mendix 11.3. Use com.mendix.webui.HybridAppLoginTimeOut in earlier versions.
com.mendix.webui.HybridAppLoginTimeOut Legacy alias of com.mendix.webui.AuthTokenTimeout
com.mendix.webui.FeedbackSizeWarningThreshold A warning is logged when the feedback size exceeds the threshold. Feedback is sent from server to client to instruct (for example, to refresh objects or to open a page). They are serialized as "instructions" in the server response. If there are too many instructions, this can have performance implications, as they all have to be serialized to the client. For this reason, a warning is logged when the threshold is exceeded. 5000
com.mendix.webui.StateSizeWarningThreshold A warning is logged when the state size exceeds the threshold. The state consists of changes in objects and of objects not committed to the database (yet). If there is too much state, this will have performance implications, as the whole state has to be serialized to the client. For this reason, a warning is logged when the threshold is exceeded. 100
com.mendix.webui.CommittedObjectsThreshold The threshold controls how much data is sent back to the client after executing a microflow. By default, we send back full objects when they are changed or committed. When this threshold is reached, only object GUIDs are sent back instead so that the client knows about the changes while the amount of data sent over the network is reduced. The client will then retrieve the objects later on, if needed. 100
MaxRetrieveAmount The maximum number of objects the client is allowed to retrieve by list widgets using database datasource runtime operation.
When requesting more objects than allowed, the runtime will enforce the MaxRetrieveAmount by setting a limit on the query and will log the following warning: A retrieve action requested more objects than allowed by the MaxRetrieveAmount runtime setting. Amount requested: (...), MaxRetrieveAmount: (...).
This setting was introduced in Mendix version 11.8.0 and 11.6.5 MTS

Metrics Settings

The settings below configure metrics through micrometer. See Metrics for more information and the specification of the settings format.

Name Description Default Value
com.mendix.metrics.Type Enable access to Micrometer metrics through Java APIs micrometer
Metrics.Registries Registries to send metrics to
Metrics.ApplicationTags Common tags used for every meter

OpenTelemetry Settings

The setting below configures observability (metrics, tracing, logs) through OpenTelemetry. See OpenTelemetry for information on setting up OpenTelemetry.

Name Description Default Value
OpenTelemetry.MinimalMode Enable OpenTelemetry minimal tracing mode.
When true, only generates incoming or outgoing spans.
Introduced in Mendix version 11.15.0		 false

Proxy Settings

Http(s) Connections

The settings below configure the app to use a proxy for all connections, whether they are using the HTTP or HTTPS protocol. They are used in the following circumstances:

  1. In the integration microflow activities call web service, call REST service, send REST request, and call external action.
  2. In the external object microflow activities send external object and delete external object.
  3. When retrieving an external entity data using a consumed OData service.
  4. When calling the Mendix runtime API Core.Http().executeHttpRequest and HttpConfiguration.getInstance().getProxyConfiguration().

These settings can be set either as JVM properties or as custom Runtime settings. When both the JVM property and custom runtime setting are set, the app uses the custom runtime setting.

Name Description Default Value
http.proxyHost Defines the hostname of the HTTP proxy server.
http.proxyPort Defines the port number of the HTTP proxy server.
http.proxyUser Defines the user of the HTTP proxy server.
http.proxyPassword Defines the password of the HTTP proxy server.
http.nonProxyHosts See below

License Server

The settings below configure the app to use a proxy to reach the Mendix license server.

Name Description Default Value
https.proxyHost Defines the hostname of the HTTPS proxy server.
https.proxyPort Defines the port number of the HTTPS proxy server.
https.proxyUser Defines the user of the HTTPS proxy server.
https.proxyPassword Defines the password of the HTTPS proxy server.
http.nonProxyHosts See below

Non-Proxy Hosts

The http.nonProxyHosts setting defines a list of hosts that should be reached directly, bypassing the proxy. This is a list of patterns separated by '|'.

This setting applies to both http(s) connections and the license server:

  • Http(s) connections – the patterns may start or end with a '*' for wildcards
  • License server – the runtime ignores wildcards