Domino Leap configuration settings

Domino Leap configuration settings are in VoltConfig.nsf in the volt folder of your Domino data directory (volt/VoltConfig.nsf). Use the Notes client or the Domino Administrator client to modify a configuration setting.

To modify a configuration setting, complete the following steps:
  1. Use Notes or the Administrator client to open volt/VoltConfig.nsf.
  2. Select All Settings.
  3. Find the setting you want to modify. For more information, see Common configuration settings.
  4. Open the setting document.
  5. Click Edit to modify the setting.
  6. If the setting is disabled, click Enable Setting.
  7. If necessary, modify the Setting Value field. See the description of each setting for a list of legal values.
  8. Click Done and select Yes to save your changes.

Domino Leap typically reads a setting change within a minute or two. If your change does not take effect automatically, you may need to restart the HTTP process.

Common configuration settings

The following table lists the most commonly used Domino Leap configuration settings. You can find additional configuration settings in VoltConfig.nsf. In each case, the document in VoltConfig.nsf includes a description of the setting.
Setting Description

appStats.timerEnabled

appStats.refreshHour

appStats.refreshDays

 By default, the timer is enabled and the collection time is set to 3am daily local server timer.
Note: Depending on the volume of applications, statistics collection may take 10+ minutes, adjust the timer and frequency to server quiet time.
appStats.timerEnabled:

Enable Application Statistics collection.

To disable Application Statistics collection, set to false.

Default value: true

appStats.refreshHour:

Sets the hour of day to start Application Statistics collection.

Value 0 to 23, indicating the hour of day to start the statistics collection process.

Default value: 3

appStats.refreshDays:

Sets the Application Statistics collection day. Use full names of day of the week, separated by a comma, semicolon, or space.

Valid values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

Default value: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

customThemes.[ID].displayName

customThemes.[ID].location

customThemes.[ID].isDefault

customThemes.[ID].nl.[LOCALE]

The customThemes config settings define a list of customer-provided themes that can be used in Domino Leap applications.

For each theme, two parameters must be set:
  • customThemes.[ID].displayName
  • customThemes.[ID].location

[ID] - An identifier for the custom theme (e.g. "corpTheme1"). The id can contain the letters 'a' through 'z' and numbers, and must start with a letter.

displayName - The theme name to be displayed in the Domino Leap authoring UI.

location -The full URL of the theme's .css file.

For each theme, there are 2 optional parameters:
  • customThemes.[ID].isDefault
  • customThemes.[ID].nl.[LOCALE]

isDefault - If set to true, designates the theme as the default selection for new applications.

nl.[LOCALE] - For globalization support of the theme's display name. [LOCALE] is the locale code that identifies the language (e.g.,"en", "fr", "fr_CA", "zh").

After modifying these settings, restart the http task to see the changes in the authoring environment. If the location property of a theme is modified, any deployed applications using that custom theme need to be redeployed for changes to take affect.

Example:

customThemes.corpTheme1.displayName = Corporate Theme 1
customThemes.corpTheme1.nl.fr = Thème d'entreprise 1
customThemes.corpTheme1.nl.zh = 企业主题1
customThemes.corpTheme1.isDefault = true
customThemes.corpTheme1.location =https://mycompany.com/theme1.css

imageDomainWhitelist.enabled=true

imageDomainWhitelist.[N].domain

The imageDomainWhitelist config settings define a list of domains from where app users are allowed to upload images to a Rich Text Entry field.

In addition to setting imageDomainWhitelist.enabled=true for each domain, an additional parameter must be set: imageDomainWhitelist.[N].domain = Where "[N]" is an integer number identifying that domain. For more information, see the imageDomainWhitelist documents in VoltConfig.nsf.

Default value: true
purgeOrphanFilesHours

In some circumstances, files attached to either application designs or user-submitted records can become orphaned if the primary design or record element is removed outside the normal process. File records which are older than this number of hours and are no longer associated with an existing primary record are removed by a clean-up agent in VoltBuilder.nsf.

Default value: 48
reauthInNewWindow Helps with seamless re-authentication when Leap is using an external IdP (in SAML or OIDC configurations), so that Leap users do not lose their work. When set to true, the authentication flow is presented in a pop-up window, which is typically adequate for most external IdPs. It is recommended to use this setting in conjunction with:
ibm.nitro.NitroConfig.reauthOnFailedRequest

Default value: False

Example:
ibm.nitro.NitroConfig.reauthInNewWindow=true
reauthOnFailedRequest Helps with seamless re-authentication when Leap is using an external IdP (in SAML or OIDC configurations) so that Leap users do not lose their work. When set to true, a failed XHR request triggers the authentication flow. A failed request is the typical result when an SAML or OIDC session has timed-out. It is recommended to use this setting in conjunction with:
ibm.nitro.NitroConfig.reauthInNewWindow

Known Limitations: There is no mechanism in the browser for the Leap code to distinguish a session time-out failure from other types of failures, such as a loss of internet connectivity. Enabling this setting means that any XHR request failure will trigger an authentication flow, even if it is not appropriate. However, for the majority of cases this setting will help Leap users to not lose their work, therefore it is recommended.

Default value: False

Example:
ibm.nitro.NitroConfig.reauthOnFailedRequest=true
runtimeResources.[N] Additional web resources to load into the Domino Leap UI for leveraging the Custom Widget API. The values from these settings will be injected into the <head> section of Domino Leap's HTML pages
secureJS
Enables or disables JavaScript security in run time forms. When a form designer adds custom JavaScript to an application, this flag applies security settings to the custom JavaScript. This flag applies to the entire Domino Leap server for all users.
Note: Setting this parameter to false might expose users to malicious JavaScript. Only set to false in a secured environment where Domino Leap applications are created by trusted users.

If you change this value, any existing applications must be manually redeployed to apply the change. For more information, see JavaScript API for Domino Leap.

Default value: true
serverURI

For certain scenarios is it necessary to indicate the front-end base URI used for Domino Leap. All URI's that Domino Leap generates will be based on this value.

The value must include everything necessary to connect to the Domino Leap context.

Example:

http://volt.example.com/volt-apps

With this entry, all emailed links, and absolute links visible during Domino Leap design time start with this base URI regardless of what the user enters in the address bar.

servicesWhitelist.enabled

servicesWhitelist.[N].actions

servicesWhitelist.[N].domain

The servicesWhitelist config settings define a white list of domains and HTTP actions that app authors are allowed to call directly from their applications using URL based services.

In addition to setting servicesWhitelist.enabled=true, for each service two additional parameters must be set:
  • servicesWhitelist.[N].domain =
  • servicesWhitelist.[N].actions =

Where "[N]" is an integer number identifying that service. For more information, see the servicesWhitelist documents in VoltConfig.nsf.

Default value: true
useDominoInternetMail

When set to true, Domino Leap sends an email using the Internet address of the target user. If the user was found in an LDAP directory (via Domino directory assistance), the Internet address may be a more reliable way to route mail to the user. If the user was found in a Domino directory, the Internet address corresponds to the INTERNETADDRESS field in the user's person document.

When set to false, Domino Leap sends an email using the User ID of the user, letting the router determine the correct internet address to use if sending outside the Domino domain.

Default value: true