6.1 Configuration Settings

The WebAccess servlet is controlled by configuration settings and by the HTTP requests it receives (see Configuring the Servlet). Configuration settings are loaded when the servlet starts up and exist throughout the life of the servlet. HTTP requests received by the servlet cause the servlet to carry out those requests, often by calling a provider.

All settings in the configuration file are accessible as variables in the templates. Blank lines or lines that begin with # are ignored. Each of the settings in the configuration file consists of the name of a setting, followed by an equals sign (=), followed by the value for the setting, as follows:

Value

Meaning

Admin.WebConsole.enable

Specifies whether to allow the Administration Web Console tool to be available from a URL (http://<server>/servlet/webacc?action=Admin.Open): true or false.

Admin.WebConsole.username

Specifies the user name to use when logging on to the Administration Web Console.

Admin.WebConsole.password

Specifies the password to use when logging on to the Administration Web Console.

Application.Display.version

Specifies the product version or name of the GroupWise WebAccess Application. (For example, 8.0.)

Application.Module.version

Specifies the specific service pack version of the GroupWise WebAccess Application. (For example, 8.0.3.)

Application.Copyright.year

Specifies the copyright year of the GroupWise WebAccess Application.

Document.View. excludeDocExtensions

Specifies the view option is not allowed, only for the specified document types. To allow the view option for all document extensions, do not set this option. Extensions are comma delimited with no white space between entries. (For example, txt,doc,xls,ppt.)

Document.View.maxSize

Specifies a maximum size limit for an attachment to be viewed. When reading an item with an attachment larger than the specified size, the view link for that attachment is not available.

Document.ViewNative. docExtensions

Specifies that the view native option is allowed only for the specified document types. To allow the view native option for all document extensions, do not set this option. Extensions are comma delimited with no white space between entries. (For example, txt,doc,xls, ppt.)

File.Upload.path

Specifies the name of the directory where attachments are uploaded they are added to messages. Attachments will be temporarily stored in the specified directory until the message has been successfully sent or canceled.

Help.url

Specifies the root of the URL for the HTML help files. The language directory and default.htm will be added to this URL to form the complete URL for the help file. For example, if com/novell/webaccess/help is specified, the final URL (assuming the language is English) will be com/novell/webaccess/help/en/default.htm.

Home.Speller.url

Specifies the URL used to invoke the Speller Servlet from the template files. This value is useful if the filter string (/servlet/) is changed to something other than the default.

Language.default

Specifies the default user interface language (as a two-character ISO language code).

Log.Console.enable

Specifies whether console logging is enabled (true = enabled).

Log.enable

Specifies whether file logging is enabled (true = enabled).

Log.language

Specifies the language of the log file (as a two-character ISO language code).

Log.level

Specifies the level of logging:

  • normal
  • verbose
  • diagnostic

Log.maxAge

Specifies the number of days that log files should be kept. Files older than the number of days specified will be deleted.

Log.maxSize

Specifies the maximum accumulated size (in kilobytes) of all the files in the log directory. When the accumulated size exceeds the specified size, the oldest files will be deleted.

Logout.url

Specifies the URL of the page that should be presented when the user logs out of WebAccess. If not present, the login page will be returned.

Logout.Url.xxx

Specifies a logout URL for a specific interface. (For example, Logout.Url.frames=http://www.novell.com.) Each interface (such as simple, webclip, etc.,) can have its own logout URL.

Log.path

Specifies the path where log files are to be written.

Log.timeStamp

Specifies the date/time format to use when time stamping entries in the log file.

Provider.default

Specifies the name of the provider to use (when no provider is specified) in an HTTP request.

Provider.GWAP. BusySearch.timeOut

Specifies the number of minutes to allow a GWAP provider the busy search operation.

Provider.GWAP.class

Specifies that there is a provider named GWAP, and specifies the class file that implements this provider.

Provider.GWAP.Config.file

Specifies the path to the configuration file for the GWAP provider.

Provider.LDAP.class

Specifies that there is a provider named LDAP, and specifies the class file that implements this provider.

Provider.LDAP.Config.file

Specifies the path to the configuration file for the LDAP provider.

Provider.xxxx.class

Specifies that the name between Provider. and .class is a provider that can be specified in HTTP requests (see Specifying a Provider).

Security.Authenticate.header

Specifies what remote computers are trusted for receiving the authentication header. Multiple addresses can be on the line, separated by commas. (They can be any misture of IP addresses or Domain names.)

Security.Authenticate.Header. start

Specifies the default template to use to merge the results of the login when using the authentication header instead of a login page form.

Security.HtmlDocument. disableScripts

Specifies whether WebAccess should disable potential security risks in HTML documents: true or false.

Security.HtmlAttachment. disableScripts

Specifies whether WebAccess should disable potential security risks in HTML attachments: true or false.

Security.Logout.Url. xxx.xxx.xxx.xxx

Specifies a logout URL for a specific trusted server. (For example, Security.Logout.Url.<IP address OR doman name>=http://www.novell.com.) Each trusted server can have its own logout URL.

Security.timeout

Specifies the number of minutes of inactivity before the servlet drops a user's session.

Security.Timeout.path

Specifies the directory where timeout information is temporarily stored so that after a successful re-authentication, a users session can be restored.

Security.UseClientIP.enable

Specifies whether the client’s IP address to secure sessions: true or false.

Security.UseClientCookie.enable

Specifies whether to allow sessions to be secured using session coookies. This general setting is overridden by individual UI template settings. (For example, Templates.Interface.1.useCookie=true.)

Templates.Accept.[n].id

Specifies the accept string sent by a browser request. (For example, text/x-hdml.) This value is used if the UserAgent string does not match.

Templates.Accept.[n].interface

Specifies which set of templates to use for the identified broswer. (For example, simple and wml.)

Templates.Applets.url

Specifies the root of the URL where the applets are located and allows applets to exist on a different server. The default location of applets is beneath the web server's document root directory, so this setting allows you to move the applets to another root directory, but the directory structure (com\novell\webaccess\. . .) beneath the root must remain intact.

Templates.Cache.enable

Specifies if templates should be cached:

  • true The template will be compiled the first time it is encountered by the servlet and cached for future access.

  • false The template is reloaded and compiled each time it is referenced, which is useful if you are modifying templates and want to see changes without restarting the server.

Templates.Cache.size

Specifies the size of the template cache (in kilobytes). See Adjusting the Cache Size. The actual amount of cache space used is big enough to hold the currently cached templates only.

Templates.Debug.enable

Specifies if the templates should be compiled in debug mode (true = Enable debug).

When compiled in debug mode, there may be more information available if you're having trouble getting a template to process completely. Some error messages may be more specific about where in the template an error is occurring. Also, when the template is being processed, the template will be dumped to the console window as it processed. This will allow you to see just how far the template processing was able to progress before encountering a problem in the template.

Templates.Images.url

Specifies the root of the URL where the image files are located and allows images to exist on a different server. The default location of images is beneath the web server's document root directory, so this setting allows you to move the images to another root directory, but the directory structure (com\novell\webaccess\. . .) beneath the root must remain intact.

Templates.interface

Specifies the default interface to use (see Specifying a Template). This should be the name of a subdirectory under the directory specified in the Templates.path parameter. For example Templates.interface=frames. This value can be overridden by specifying User.interface when logging in (action=User.Login&User.interface=frames).

Templates.Interface.[n].id

Specifies a specific template directory for the application. (For example, frames and simple.)

Templates.Interface.[n]. contentType

Specifies the type of context the templates return to the browser. (For example, text/html or text/xml.)

Templates.Interface.[n]. disableCache

Specifies whether to set specific headers in the HTTP response to attempt to disable proxy server and browser cache when using this set of templates: true or false.

Templates.Interface.[n]. useCookie

Specifies whether to use session cookies to secure the user's sessions: true or false.

Templates.Java.package

Specifies the Java Package Name used by the template processor to locate files being used as string tables by the templates.

Templates.path

Specifies the path to the template files as a directory name. The directory contains subdirectories that hold the actual template files. Each of these subdirectories corresponds to the user interface implemented by the templates in that directory. For example, if Templates.path has the value \java\servlets\com\novell\webaccess\templates, there could be a directory \java\servlets\com\novell\webaccess\templates\frames which contains the frames user interface.

Templates.UserAgent.[n].id

Specifies the string used to identify a browser request. (For example, Windows CE or Blazer.) Used if the interface is not specified on the URL.

Templates.UserAgent.[n]. interface

Specifies which set of templates to use for the identified browser. (For example, simple or wml.)

User.Access.calendar

Specifies if users have access to the calendar views (true = allowed).

User.Access.document

Specifies if users have access to document management (true = allowed.

User.Access.HTMLDoc

Specifies whether to allow viewing the documents using the HTML viewers: true or false.

User.Access.HTMLDocNative

Specifies whether to allow opening documents using a native browser plug-in: true or false.

User.Access.internet

Is not currently used.

User.Access.LDAP

Specifies if users have access to LDAP directories (true = allowed).

User.Access.mail

Is not currently used.

User.Access.security

Specifies if users can change their password (true = allowed).

User.Access.speller

Is not currently used.

User.Access.View

Specifies whether to allow viewing attachments using the HTML viewers: true or false.

User.Access.ViewNative

Specifies whether to allow opening attachments using a native browser plug-in: true or false.