Properties
Overview
Universal Controller contains three types of configurable properties:
Universal Controller Start-up Properties (uc.properties) | Universal Controller start-up properties are the default properties contained in the uc.properties file when the Controller is installed. These properties are required for Controller start-up and operation. |
|---|---|
Universal Controller System Properties | Universal Controller system properties define Controller system information and performance. They have their values set during installation. Note In a High Availability environment, all Universal Controller cluster nodes share the same database; therefore, updating Universal Controller System Properties for one cluster node applies to all cluster nodes. |
Command Line Interface (CLI) Properties | CLI provides a sample configuration file, |
Note
Properties for Universal Message Service (OMS) are installed as configuration file options when OMS is installed as a component of Universal Agent. The values for these options are set during the installation. There are several configuration methods available for changing these values.
Universal Controller Start-up Properties (uc.properties)
The uc.properties file is read by the Controller, which is started by Tomcat.
The uc.properties file resides here:
[tomcat directory]\conf
Note
The backslash character in a property value must be escaped as a double backslash.
For example:
example.path=c:\\stonebranch\\uc
Property Name | Description | Default |
|---|---|---|
For MySQL: |
|
|
| Allows the retrieval of output with extended unicode characters. If the property is not set, character encoding will not be used in the JDBC URL. HTML |
|
| Database type. Specify this property if you are using a MySQL database. |
|
| JDBC connect URL. Specify this property if you are using a MySQL database. |
|
For SQLServer |
|
|
| Database type. Specify this property if you are using a SQLServer database. |
|
| JDBC connect URL. Specify this property if you are using a SQLServer database. |
|
For Oracle |
|
|
| Database type. Specify this property if you are using an Oracle database. |
|
| JDBC connect URL. Specify this property if you are using an Oracle database. |
|
For All Databases |
|
|
| IMPORTANT If you specify a database name in this property and in uc.db.url, the names must be the same. Name for the Controller database. | uc |
| Database password that will be replaced by | (none) |
| Encrypted version of | (none) |
| Sets the minimum number of idle connections to maintain in the Server connection pool, or zero to create none. | 1 |
| Sets the minimum number of idle connections to maintain in the Client connection pool, or zero to create none. | 1 |
| Sets the maximum number of connections that can be allocated by the Server connection pool at a given time. Note The installer overrides the default by configuring a maximum number of 40 in the | 30 |
| Sets the maximum number of connections that can be allocated by the Client connection pool at a given time. | 30 |
| Sets the maximum number of connections that can be allocated by the Reserved connection pool at a given time. | 30 |
| Sets the minimum number of idle connections to maintain in the Reserved connection pool, or zero to create none. | 1 |
| Allows additional options to be appended to the JDBC URL generated by Universal Controller. HTML | (none) |
| Login ID that the Controller will use to log in to your database. | root |
For LDAP: |
|
|
| When this property is set to true, any Groups synchronized indirectly (that is, through a User's memberOf attribute) will honor the Group search filter and Group OU filters under the LDAP Advanced Settings section. Note The code default for this property, which is used if this property is not set, is false. | true |
| IMPORTANT This property should be set to true only if your Groups being synchronized from AD have at most one parent Group. When synchronizing Groups, the default behavior in the Controller is to copy the members of a Sub Group into the Parent Group. | false |
| IMPORTANT This property should be set to false only when synchronizing Groups from AD, and the number of values for the member attribute exceeds the When synchronizing Groups, the default behavior in the Controller is to use the multi-valued member attribute to update the members for a Group; however, AD limits the number of values returned for an attribute, which can result in Group members being removed unexpectedly. This limit is determined by the | true |
| IMPORTANT This property should be set to false only if your LDAP server supports paged results. | true |
| IMPORTANT This property should be set to true only if your LDAP server does not support the User Membership Attribute (for example, memberOf). Synchronizes LDAP users indirectly based on group membership. This only applies to groups that users are direct members of.
Note The Note There is currently no support for nested groups if the User Membership Attribute is not supported by the LDAP server. | false |
| IMPORTANT This property should not be set to true if group membership for users is static, since there is extra overhead to process the groups, which may impact login performance. When this property is set to true, LDAP group memberships for existing LDAP users are updated upon successful login. Note When dynamically creating a new LDAP user at login, the user will be added only to groups that it is a direct member of. Likewise, when updating an existing LDAP user at login, the user will be removed from any groups that it is not a direct member of. Therefore, it is not recommended that you enable this property if a group hierarchy exists, since the user will be removed from any parent groups when logging in. (Group membership for the parent groups will be restored the next time the LDAP refresh runs; however, this can take up to 24 hours.) | false |
For Single Sign-On: |
|
|
| Configures the log level for the SAML framework: ALL, TRACE, DEBUG, INFO, WARN, or ERROR. | INFO |
| Specifies how long, in seconds, users can single sign-on after their initial authentication with the Identity Provider (based on value AuthInstance of the Authentication statement). Some Identity Providers allow users to stay authenticated for longer periods than this, so you might need to change the default value. | 7200 |
Other Properties: |
|
|
| Limits the number of XML entity expansions.
| 1 |
| Accepted input date formats for Date Functions and Stored Procedure parameters. For example: |
|
| Directory location from where files can be attached for a specific Cluster Node / Server. You must specify a location in this property in order for the Attach Local File field to display in the Email Task and Email Notifications Details. This property is local to the Cluster Node and must be specified on each Node based upon the path for that Node. Each Node can have a different path, but they should point to the same shared physical location in order to achieve the expected behavior. Best practices would be to use the same path in each Node. |
|
| Number of seconds for Email Notification output timeout. | 180 |
| Java key manager algorithm.
If no value is specified, the configured JVM default will be used. |
|
| If multiple certificates reside in the keystore that could match the OMS server's certificate request, specifying an alias ensures that the intended client certificate is presented to the OMS server. |
|
| Location of the keystore which holds certificates and keys. |
|
| Password (if required) for the keystore that will be replaced by |
|
| Java key manager provider.
If no value is specified, the configured JVM default will be used. |
|
| The Controller uses the Catalina:type=Manager MBean for the User Sessions feature. |
|
| Sets the OMS service timeout value specifying the number of seconds of inactivity before a timeout exception will be thrown. For example, you will see the following in the uc.log: Default (180 seconds)
uc.oms.service_timeout=300
| 180 seconds |
| Maximum number of days after which an overdue trigger is considered "stale/expired." | 2 |
| Port number used by Tomcat. | 8080 |
| Java trust manager algorithm.
| SunX509 |
| Java trust manager provider.
| SunJSSE |
| Comma-separated list of SSL/TLS protocols that can be used for Controller/OMS communications.
|
|
| Location of the keystore which holds certificates and keys. | properties/cacerts |
| Password (if required) for the keystore that will be replaced by | changeit |
| Encrypted version of |