Console Server Configuration

In addition to changing the server type, there are some console configuration items that can also be configured from within the console itself.

Settings

Advanced tab

Changes to these setting are stored in a configuration file with the application itself. The following is a list of the console configuration settings in the file configuration.properties. This file can be found in the Composable Architecture Platform HOME folder under Applications/console/[build number]/WEB-INF/classes. The explanation for each item equally applies to the console setup:

Setting	Details
Home	The home folder for the console. Configuration and rule sets will be stored within subfolders under this folder. The folder must exist, and the console application server user must have read and write authority to it. The value can be an absolute or relative file path.
Languages	A CSV list of the languages supported (and made available) in the console.
Locales	A CSV list of the locales that map to the languages installed.
Schema	The database schema used for the console configuration database.
Catalog	The database catalog used for the console configuration database.
DriverClass	The name of the actual JDBC driver class as it is loaded by the connection pool. Even though configuration information could be stored in DB2 (or some other production level database), it is recommended to use the default Derby driver for configuration. In production environments, the Derby driver should not be configured for use within the product. This will ensure that it is impossible to write a rule set that modifies the product’s own configurations.
DriverConnection	The connection string used by the JDBC driver to connect to the database.
DriverUser DriverPassword	The user ID and password to use for the JDBC connection
MailServer	This is the system wide SMTP server used for all sending of emails from within the Composable Architecture Platform console (mostly password notifications).
MailUser MailPassword	If the SMTP server requires authentication, specify the user ID and password in these settings.
MailingHost	The name of the host being used to identify the sending host in any email. This value allows the emails to link back to the original web page.
MailingSender	The email address used to send password reset notifications and user ID notifications
MailUseSSL	Specifies if the mail server uses SSL for connectivity. If yes, this value should be set to "true" otherwise it should be "false" or not exist
MailUseTLS	Specifies if the mail server uses StartTLS for connectivity. If yes, this value should be set to "true" otherwise it should be "false" or not exist
AuthenticationPlugins	A list of plug-ins that can alter the logon behaviour of the Composable Architecture Platform console.
UpdateServer	The URL of the Composable Architecture Platform update server. This server will be checked regularly for new available updates. This setting is optional.
ProxyHost ProxyPort ProxyUser ProxyPass ProxyDomain	These settings are used to define a proxy server that the console must pass through to access the update server or other www based services. These settings are optional, however, if the ProxyHost is set, all other settings must be defined. If the web proxy used NTML authentication, the proxy host should be the fully qualified name of the proxy (for example: myproxy.mycompany.com) and the ProxyDomain must also be set to the local domain. For other non-Microsoft proxies, the ProxyDomain should be blank.
UserRegEx PassRegEx	These settings specify how user IDs and passwords are validated in the form of regular expressions. The default is to require a minimum of five characters/numbers, but alternatives can be specified here. Please note that the regular expression format is as used by JavaScript.
MasterConsole MasterId MasterPwd	These settings change the behaviour of the console from being a master console to being a slave console (Cluster Node). To make a console a slave console for cluster management, the MasterConsole setting must contain a URL pointing to the root web path of the master console (for example: https://192.168.1.1/console). The use of SSL is recommended for a master console connection. The MasterId and MasterPwd refers to the corresponding values specified for this slave console in the master console. Please see the section on managing large clusters for more information.
AccessManager	The access manager field can be used to override the method for user authentication. The currently supported access managers are for either the SAML or LDAP Authentication Plugins. This is set on the AccessManager property as follows: LDAP software.tomorrow.authenticate.LDAPAuthenticationPlugin SAML software.tomorrow.authenticate.SAMLAuthenticationPlugin Additional properties are required for either the LDAP and SAML Authentication Plugins. Please see below.
LDAPDomain LDAPHost LDAPSearchBase LDAPTimeZone	These properties are used to define how the console connects to an LDAP server when the LDAP Authentication Plugin is set as the access manager The LDAP Domain is set as follows: LDAPDomain=mycompany.com The LDAP Host is set as follows: LDAPHost=ldap://myldaphost.mycompany.com The LDAP Search base is used to locate the correct segment in the LDAP server. A typical configuration would be: LDAPSearchBase=DC=mycompany,DC=com The LDAP TimeZone denotes the time zone that will be used for the users authenticated via LDAP. For example: LDAPTimeZone=GMT
SAMLMetaData	This property is used to define how the console connects to an identity provider (IdP) using SAML when the SAML Authentication Plugin is set as the access manager. SAML metadata value is the XML document which contains information necessary for interaction with SAML-enabled identity or service providers or the http reference to the meta data URL. SAMLMetaData=[XML or HTTP reference to meta data URL]