This page contains a listing of the available unanet.properties that can be configured in your system.
Note that most of these values can be managed via the Admin >> Properties screen in your system and that any entries defined in the unanet.properties file will override the value set via that screen in the user interface (for that specific front end web server).
This page presents an alphabetical listing of available properties with links to the descriptions of each property (as they appear on the Admin >> Properties screen).
If your installation includes the use of multiple front end web servers, you may want to have different values for the same property on each front end. Using this unanet.properties file can allow you to accommodate that need (whereas those properties defined via the Admin >> Properties screen will be shared by all front end servers -- unless overridden by entries in the unanet.properties file on a particular front end).
Additionally, any properties that you configure via this property file, can no longer be managed via the Admin >> Properties screen. This may be useful for properties that you do not want your typical Unanet Administrator to be able to modify (i.e. some should only be modifiable by system administrators with access to a server).
This file can be viewed/edited with any standard text editor. All property files are located in your config directory.
WARNING - All changes to the unanet.properties file should take place in the file located in your config directory. DO NOT attempt to modify the copy of the unanet.properties file packaged within the unanet.war file (this can result in unpredictable system behavior).
Topics covered on this help page include:
Property Setting Syntax (how to format the property entries)
You may also be interested in:
Admin >> Properties (to manage property settings via the user interface)
Examples |
|
When defining your parameters, enter the parameter name (exactly as spelled --- cutting and pasting from this page is recommended), followed by the equals symbol ("="), and your overriding value with no spaces between the property and the equal sign -- or the equal sign and the beginning of the property value. Also, the parameter names and values are case sensitive unless otherwise noted. |
For example, if setting the email option to true, you would enter: unatime.email=true Do not enter as: unatime.email = true <==== incorrect |
The table below contains a listing of all published unanet.properties values. You can click on a particular property and view additional information about that property, including; descriptions, default values, related properties, as well as the name / location of that property as it appears on the Admin >> Properties screen.
Should you decide to maintain the unanet.properties within the ascii text file, you'll be editing a file that resembles the sample below. A sample unanet.properties file is included in your config directory by default with a number of common entries commented out.
############################################################################## # Note: Any line beginning with a pound sign (#) is treated as a comment. # Changes will not take effect until you restart your servlet engine. # # There are two methods of configuring the various features in Unanet: # # 1) Configure the properties directly in the user interface by going # to the Admin->Properties menu item (for administrators only). These # values are stored in your Unanet database and are used by any front # end that is not overriding them. Any changes made through the user # interface take effect immediately (no servlet restart necessary). # # 2) Use this file to specify the property values using their property # ID. Any change made in this file will NOT take effect until the # Unanet servlet (ie Tomcat) is restarted. The values specified # in this file will ALWAYS override the user interface settings. # There are two reasons this may be useful or even necessary: # # A) You may need to ensure that no one can change certain critical # features through the user interface. By placing them in this # file, you guarantee that they cannot be changed through the # user interface. # # B) You may have multiple front-end servers pointing to your Unanet # database. It is sometimes necessary to specify different # settings for each front end. For example, perhaps the file # structure is different on each front end and you need to # specify different log files or temp directories. # # When you do use this file to override property settings, the property # will appear grayed out in the user interface page. # # See the Unanet documentation for more information on how to customize your # Unanet system and for a complete list of properties. ############################################################################## ############################################################################## # E-mail Information # To enable email, set unatime.email to true and set the mail.host to your # SMTP server. You may also want to set unatime.email.default_from_address # to something meaningful to your system -- it is used when the sender email # cannot be determined. ############################################################################## #unatime.email=false #mail.host=(SMTP Server Name Goes Here) #unatime.email.default_from_address=unanet@localhost ############################################################################## # Temp Directory Setting # You should make sure you uncomment and set this directory property. We # recommend setting it to the "temp" directory under your main unanet folder. ############################################################################## #unanet.temp_directory=c:/unanet/temp ############################################################################## # You should also specify a log file that will contain all the logging info # by setting the unanet.log.output property. A full path can be specified to # anywhere that is writable by the user running the servlet engine, but we # recommend keeping the log file in the servlet engine's log directory. We # have provided an example. Please # uncomment and make sure you change the path if you have # installed the servlet engine in another location. ############################################################################## ### Example entry for Tomcat #unanet.log.output=c:/Program Files/Apache Software Foundation/Tomcat/logs/unanet_runtime.log ############################################################################## # Unanet logging level # You can control the level of detail which gets logged by the Unanet system # by setting the unanet.log.level. Valid values are OFF, SEVERE, WARNING, # INFO, CONFIG, FINE, FINER, FINEST or ALL. The default value if INFO. # Please see help documentation for more details. ############################################################################## #unanet.log.level=FINE |