Configuration properties

The following table contains a list of properties in the IBM® Forms Experience Builder Builder_config.properties file. You can adjust the settings listed in the file, or add your own for a custom configuration.

Table 1. List of properties in the Builder_config.properties configuration file.
Comment description Sample value provided

For WebSphere® Application Server only, configure the VMM login. This setting is mandatory. These entries contain the J2C alias or the user name and password for the WebSphere Application Server administrative user. By default, Forms Experience Builder uses J2C alias febAdmin to authenticate with VMM. You must configure it here if you want to change the J2C alias name.

You must have WebSphere Application Server administrative user credentials to run Forms Experience Builder

 
ibm.was.MemberManager.adminAlias = febAdmin
ibm.was.MemberManager.adminUser = <Administrative user name>
ibm.was.MemberManager.adminPass = <Administrative user password>

If you use LDAP within WebSphere Application Server, there are a number of properties that look up user and group information. If your LDAP uses different property keys than the ones set by default, update the property keys here so that user and group look up function correctly.

If you are using LDAP within WebSphere Application Server, the ibm.was.MemberManager.userProps.loginName key describes the LDAP property used as the login ID. Each loginName must be unique. The default setting is uid.

The ibm.was.MemberManager.userProps.id key represents a unique key for the user. This key must be identical to the loginName. The default setting is uid.

The ibm.was.MemberManager.groupProps.id key is used to represent a unique key for the group. The value is the LDAP property that is used. For example, cn, represents Common Name. The default setting is cn.

The ibm.was.MemberManager.userProps.email key is the email address of the user. Forms Experience Builder uses this email address to send notifications and other emails to the user. The default setting is mail.

The ibm.was.MemberManager.userProps.displayName is used to display the name of the user, instead of the login id. The default setting is cn.

ibm.was.MemberManager.userProps.loginName = mail

ibm.was.MemberManager.userProps.id = mail

ibm.was.MemberManager.groupProps.id = name

ibm.was.MemberManager.userProps.email = mail

ibm.was.MemberManager.userProps.displayName = cn

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 server. If you change this value, any existing applications must be manually redeployed to apply the change. For more information, see JavaScript API for Forms Experience Builder.

Note: Setting this parameter to “false” might expose users to malicious JavaScript. Only set to “false” in a secured environment where Forms Experience Builder applications are created by trusted users.

ibm.nitro.ApplicationCompilerService.secureJS = true

Provides HTML content that is shown at the end of the login screen. Can be used for status messages, or help.

ibm.nitro.InfoEntryPoint.dailyInfo = Welcome to IBM Forms Experience Builder

List of allowed (WhiteList), and not allowed (BlackList) of mimetypes, and the number of maximum file sizes for Application File uploads.

appFilesWhiteList – A space separated list of:
  • mimetypes – text/plain application/vnd.xfdl
  • partial mimetypes – text/audio/ /plain
  • file extensions – GIF PDF XML
  • default value – empty (everything is allowed)
appFilesBlackList – A space separated list of:
  • mimetypes – text/plain application/vnd.xfdl
  • partial mimetypes – text/audio/ /plain
  • file extensions – GIF PDF XML
  • default value – exe
appFilesMaxSize (size in kb) – A space separated list of:
  • mimetypes – text/plain application/ /vnd.xfdl
  • file extensions – GIF PDF XML or default as special type
  • default value – 5000

ibm.nitro.NitroConfig.appFilesWhiteList = css js html exe text/plain application/vnd.xfdl mov avi

ibm.nitro.NitroConfig.appFilesBlackList =exe

ibm.nitro.NitroConfig.appFilesMaxSize.10000 = default

ibm.nitro.NitroConfig.appFilesMaxSize.50000 = mov avi

List of allowed (WhiteList), and not allowed (BlackList) of mimetypes, and the number of maximum file sizes for the Attachment form item.

attachmentFilesWhiteList – A space separated list of:
  • mimetypes – text/plain application/vnd.xfdl
  • partial mimetypes – text/audio/ /plain
  • file extensions – GIF PDF XML
  • default value – empty (everything is allowed)
attachmentFilesBlackList – A space separated list of:
  • mimetypes – text/plain application/vnd.xfdl
  • partial mimetypes – text/audio/ /plain
  • file extensions – GIF PDF XML
  • default value – exe js html svg
attachmentFilesMaxSize (size in kb) – A space separated list of:
  • mimetypes – text/plain application/ /vnd.xfdl
  • file extensions – GIF PDF XML or default as special type
  • default value – 5000

ibm.nitro.NitroConfig.attachmentFilesWhiteList = css js html exe text/plain application/vnd.xfdl mov avi

ibm.nitro.NitroConfig.attachmentFilesBlackList =exe

ibm.nitro.NitroConfig.attachmentFilesMaxSize.10000 = default

ibm.nitro.NitroConfig.attachmentFilesMaxSize.50000 = mov avi

You can provide the user more contact information when the following error message is shown. If the message is “We are unable to process your request. If this error persists, report the problem to your administrator at adminInfo1, or adminInfo2, and provide error reference: XXX.” You provide adminInfo1 and adminInfo2. If you provide only adminInfo1, then the message is shortened.

ibm.nitro.NitroConfig.adminInfo1 = admin@yourcompany.com

ibm.nitro.NitroConfig.adminInfo2 = 1-800-GET-HELP

For WebSphere Application Server with DB2®, or Oracle. The maximum number of records that View Response counts up to when returning large record sets. Larger values are still returned, but the paging no longer accurately lists the total number of pages. Setting this value higher can have performance consequences for the server if there are many users viewing forms with large response lists.

ibm.nitro.NitroConfig.viewResponsesMaximumCount=2000

Maximum number of records that are permitted for export from the View Responses page at one time. If the number of records to be exported exceeds the number set by this property, the export is stopped, and an error message is shown.

Note: The default value of 20,000 is supported for base systems. Setting the value higher results in poor performance, depending on result set size and server hardware.

ibm.nitro.NitroConfig.maximumRecordsToRetrieve=25000

Indicates the base URI used for critical functions, including editing applications, and email. Must include everything necessary to connect to the Forms Experience Builder context, for example, /forms. With this entry, all emailed links, and absolute links visible during Forms Experience Builder design time start with the following base URI regardless of what the user enters in the address bar.

ibm.nitro.NitroConfig.serverURI = http://host:9080/forms

As of Forms Experience Builder 8.5.1 anonymous access is no longer allowed by default. To complete a Forms Experience Builder application or survey, users must authenticate with a valid user ID and password.

ibm.nitro.NitroConfig.blockAnonAccess=redirect

Where:
  • enabled - anonymous access is blocked
  • disabled - anonymous access is allowed
  • redirect - redirects the user to authenticate
    Note: Redirection is not available for Forms Experience Builder with WebSphere Portal.
Default: redirect

When a user attempts to access a Forms Experience Builder application anonymously, an error message is displayed. The default message is “Anonymous access blocked”. You can change the default message to provide additional information to the user.

ibm.nitro.NitroConfig.anonBlockedMsg=Anonymous access blocked

By default when you export data from applications, emails are also exported. You can exclude emails from the export by changing the property value to “false”.

ibm.nitro.NitroConfig.exportDataWithEmails=true

Where:
  • true - emails are exported with application data
  • false - emails are not exported with application data
Default: true

If Forms Experience Builder detects an unsupported browser, a warning message is displayed to the user. The user can still see the form after the warning message is closed.

detectBrowser=warn

Where:
  • warn - The user is warned that the browser is unsupported. A list of supported browsers is displayed in the warning message. When the user closes the warning message, the form is displayed.
  • ignore - The user is not warned that the browser is unsupported, and the form is displayed.
Default: warn
When you use Forms Experience Builder with WebSphere Application Server Liberty, enter your SMTP host name and user name to configure mail sessions.
Note: These properties are only for WebSphere Application Server Liberty. Do not use them if your Forms Experience Builder deployment uses WebSphere Application Server.

ibm.SendMailService.mailConfig.mail_smtp_host=<SMTP host name >

ibm.SendMailService.mailConfig.mail_smtp_port=<SMTP port name >

ibm.SendMailService.mailConfig.mail_smtp_user=<SMTP login name>

If the mail server requires authentication, use the following property:

ibm.SendMailService.mailConfig.mail_smtp_auth=true

You must then use the following property to provide the login password for authentication:

ibm.SendMailService.mailConfig.mail_smtp_auth_password=<SMTP login password>

If the mail server does not require authentication, set ibm.SendMailService.mailConfig.mail_smtp_auth= to false.

If you want to specify the “From” value in emails sent from a Forms Experience Builder server, use the following property:

ibm.SendMailService.mailConfig.mail_smtp_from=<specified value>

The value of this parameter tells Forms Experience Builder where to redirect user after log off. If the parameter is not configured or left blank, the user is redirected to the login page

ibm.nitro.LogoutServlet.postLogoutRedirectURL=http://example_url.com/signout

Defines a form designer specified white-list of domains and HTTP actions allowed for URL-based services.

domain - The domain property implicitly allows sub-domains. For example, a domain property of example.com allows URLs such as https://www.example.com/anything,http://api.example.com/anything , or https://example.com/anything.

The https or http protocol included in the domain property is respected. For example, a domain property of https://api.example.com only allows calls to secure SSL https://api.example.com/anything and not to non-secure http://api.example.com/anything.

actions - A comma-separated list of the HTTP actions allowed for a particular domain. Valid values are GET, PUT, POST, and DELETE. If the actions value is missing, no actions are allowed.
Note: This white-list has no effect on service descriptions and custom service transports that were installed on the server by the administrator.

ibm.nitro.NitroConfig.servicesWhitelist.enabled = true

ibm.nitro.NitroConfig.servicesWhitelist.1.domain = example.com
ibm.nitro.NitroConfig.servicesWhitelist.1.actions = GET
ibm.nitro.NitroConfig.servicesWhitelist.2.domain = https://securehost.com
ibm.nitro.NitroConfig.servicesWhitelist.2.actions = GET, POST,PUT
Use this setting to control the X-Frame-Options response header for Forms Experience Builder pages. For example, to keep Forms Experience Builder from being embedded in third-party sites, use ibm.nitro.NitroConfig.xFrameOptions = SAMEORIGIN. ibm.nitro.NitroConfig.xFrameOptions = SAMEORIGIN
Enables integration with IBM Watson Content Hub. This allows Forms Experience Builder applications to select assets from IBM Watson Content Hub. ibm.nitro.NitroConfig.wchEnabled=false
Where:
  • true - enables a choice in the design experience that allows a design user to select assets from IBM Watson Content Hub (a Watson Content Hub subscription is required)
  • false - feature remains disabled

Default: false
IBM Watson Content Hub API URL. This setting is optional. When set in the config, all Forms Experience Builder users will use the same Watson Content Hub tenant for selecting assets. When it's not set, Forms Experience Builder design users can set their own Watson Content Hub API URL at the time of use.

ibm.nitro.NitroConfig.wchEnabled=true is required for this setting to work.

 ibm.nitro.NitroConfig.wchApiUrl=https://my1.digitalexperience.ibm.com/api/<guid>
Parent topic: Configuring the properties file