Web.xml
Configuration
Copyright
2006, 2012 R. James Holton. All rights
reserved.
For most usage the default web.xml that ships with the release folder will suffice. However, there may be times when you wish to change it. This document describes the various option that the ESS system uses in the the web.xml.
ESS does not use any of the servlet configuration elements in the web.xml. All ESS classes are either run:
§ As a JSP compile class
§ As a JavaBean from within a JSP compiled class
§ As a instantiated class within a JSP compiled class or JavaBean
This simplifies the configuration requirements for the application server.
This is the web.xml that ships with the release folder in the "ess-apps/WEB-INF" folder:
<web-app>
<display-name>Development</display-name>
<description></description>
<context-param>
<param-name>DBUser</param-name>
<param-value>@@dbuser@@</param-value>
</context-param>
<context-param>
<param-name>DBPassword</param-name>
<param-value>@@dbpassword@@</param-value>
</context-param>
<context-param>
<param-name>DBDatabase</param-name>
<param-value> jdbc:mysql://localhost:3306/ess/zeroDateTimeBehavior=convertToNull</param-value>
</context-param>
<context-param>
<param-name>DBSQLTerminator</param-name>
<param-value>;</param-value>
</context-param>
<context-param>
<param-name>DBCompany</param-name>
<param-value>ess</param-value>
</context-param>
</web-app>
This web.xml normally works well with most installation is the Simple Installation Guide is followed. There are only four context paramters:
§ DBUser - Name of the user for database connectivity purposes
§ DBPassword - Password for database connectivity purposes
§ DBDatabase - This is the database connectivity string that is used. Some examples of valid connectivity strings are:
§ jdbc:mysql://localhost:3306/ess/zeroDateTimeBehavior=convertToNull
§ jdbc:odbc:adisoft
§ jdbc:mysql://localhost:3306/ess/zeroDateTimeBehavior=convertToNull&sessionVariables=wait_timeout=2147483
§ DBSQLTerminator - Character used to terminate SQL statements
§ DBCompany - Company pneumonic
In addition to these parameter the following context parameters can sometimes be used:
§ ESSSecurity - This parameter tells ESS if it is managing its own passwords or if it is relying on a blanket security system, such as SiteMinder, for access controls. Defaults to Application if not specified, which indicates that ESS is controlling its own password access. Options are:
§ Application - ESS is controlling access independent of a third-party security package
§ Host - ESS is under control of a third-party security package such as SiteMinder. This requires that the proper interface be programmed into the login JSP.
§ &sessionVariables=wait_timeout=2147483
§ wait_timeout can be from 1 to 2147483 where the number is the number of seconds. 28800 is the default which is 8 hours.
§ Note: in the web.xml file, the ‘&’is indicated by ‘&’
There is one session config element that is sometimes used in ess-app applications:
§ session-timeout - This specifies the number of minutes that a session that doesn't 'touch' the web server will be active. Important note: The ESS Web Front End and Audit modules actively ping the web server so they will not time-out as long as a user has an ESS screen on their browser if the time-out is set to 15 minutes or greater. If a session-timeout is not specified, the ESS session will timeout, if not being displayed in the browser window, based on that Application server's default (e.g., 30 minutes).
If you want to process receipt scans in the background one way to do this is to launch the receipt listener task as part of Tomcat’s initialization process. This is done thru a listener. The listener to add for the receipt scan is:
<listener>
<listener-class>ess.ReceiptConduitLaunch</listener-class>
</listener>
An alternative to running the listener is to run the receipt scan processor from the Audit and Administration menu.
Consult the webFullVersion.xml file located in the WEB-INF folder for a complete example of the above parameters.
Finally, if you are using the LDAP interface to manage your security, there are several elements to add to web.xml. Consult the separate document on using LDAP with ESS. It is titled, “LDAP Interface Instructions” (LDAPInstructions.txt) and will show you how to modify the web.xml file to interface to SLAP or AD via LDAP.
###