Servlet Parameters |
Active Web |
This table lists the parameters used by the Active Web servlet and the values they accept along with the default behaviour should they be omitted. All parameters, names and values are case sensitive.
Parameter Name |
Description |
aborted_process_error_page |
The page that will be executed when Active Web aborts execution of a page that has not completed within the max_page_runtime period (see below). Default Value: /xadmin/resources/pageaborted.xsp |
access_log |
The name of the log file that Active Web should use to log all page requests. Default Value: None |
access_log_flush_time |
Active Web does not write to its access log every time a page is executed as this is not efficient use of resources. Instead the log file is flushed every few minutes. This parameter is a number between 1 and 3600 indicating how often the access log should be flushed to the actual log file. Default Value: 120 (seconds) |
script_debugger_enabled |
Either 'true' or 'false', if true allows debugging of server-side script. Default Value: false |
script_debugger_hosts_allowed |
A comma separated list of debug client machine names that are allowed to connect to the debug server. If a debug client attempts to connect to the debug server and the network name of the client machine is not in this list then connection will be refused. Default Value: all connections allowed |
script_debugger_log_filename |
The name of the log file that Active Web should write all debug messages to. Default Value: $ctxtmp/debug_log.txt |
script_debugger_log_flush_interval |
Active Web does not write to its debug log every time a debug action occurs as this is not efficient use of resources. Instead the log file is flushed every few minutes. This parameter is a number between 1 and 3600 indicating how often the access log should be flushed to the actual log file. Default Value: 120 (seconds) |
script_debugger_log_level |
The level of messages put in the debug log. The levels are: 0 – no logging, 1 – connect, disconnect and errors, 2 – warning messages, 3 – all messages between debug client and server, 4 – data bytes sent between debug client and server. Default Value: 1 |
script_debugger_port |
The network port used by the debugger client to communicate with Active Web for debug. This port must not clash with any other server on the host machine otherwise the debug server can not be used. Default Value: 7868 |
default_documents |
This is a comma-separated list of files to look for if a request is resolved to a directory. Default Value: index.html,index.htm,Default.html,Default.htm |
default_http_encoding |
The default character encoding to be used for output. Default Value: systems default encoding |
document_root |
The directory that is the root of the web application, maintained for backwards compatibility with Concerto 3. Default Value: None |
enable_service_auditor |
Either 'true' or 'false', if true allows tracking of live servlet service requests and the resources they are using. Default Value: false |
error_log |
The name of the log file that Active Web should write all errors to. If this parameter is not specified and the servlet encounters an error then the error will be logged in the main servlet log as provided by the servlet container. Default Value: None |
expired_error_page |
The page that will be executed if the Active Web licence were to expire. Default Value: the built in license expired page |
script_file_types |
Defines the extensions of files that will be treated has having script content. Default Value: html, xml, htm |
file_upload_clearfileonpageexit |
Either 'true' or 'false'. A file that is uploaded is written to the fileupload_tempdir (see below), if true, on page exit the uploaded file is removed. This requires the developer to deal with any uploaded files during the execution of the page, by storing uploaded files in a document management system or similar. When false the file remains in the temporary directory until explicitly removed or dependent on fileupload_ cleartmpdironstartup (see below) when the osted is restarted. To overcome multiple files with the same name being stored in the temporary directory, file names maybe made unique by a postfix of ‘_n’ where n is the count of like named files. Default Value: true |
file_upload_cleartmpdironstartup |
Either 'true' or 'false'. Whether the fileupload_tempdir (see below) should be cleared when the osted is started. The entire contents of the directory specified is cleared, which may result in the loss of files that were not uploaded. Default Value: false |
file_upload_maxsize |
The maximum size specified in kilobytes of files that can be uploaded. To specify no restriction use –1. Default Value: -1 |
file_upload_tempdir |
The directory in which to temporarily place uploaded files. The virtual directories $ctxtmp and $tmp can be used when specifying the directory. Default Value: $ctxtmp/uploadedfiles |
http_encodings |
A comma separated list of language to java encoding pairs. The pair consists of a request language to java encoding separated by a semicolon. The following example matches an English US request to a UTF-8 encoding and Japanese to JIS encoding en-US;UTF-8, ja ; JIS |
include_charset |
Either 'true' or 'false'. If true the encoding used will be appended to the end of the "content-type" field. Default Value: false |
installation_key |
Contains the licence key for this Active Web servlet. If the key is not present then the servlet will execute for 2 hours and then not serve any more pages until it is restarted. Default Value: None |
jdbc_drivers |
A comma separated list of jdbc driver classes. Only use this if the servlet container does not provide a mechanism to set this elsewhere. For example sun.jdbc.odbc.JdbcOdbcDriver Default Value: None |
max_page_runtime |
The time in seconds that the Active Web servlet will allow a page to execute for. This is akin to the thread timeout found in Concerto 3. It is configured in seconds and defaults to 600 (10 minutes – the same as Concerto 3). The minimum value is 15 and the maximum is 7200000 (2 hours). Default Value: 600 |
load_error_page
|
The page that will be executed when a requested page fails to load; see the section on configuring load error pages for further details. Default Value: /xadmin/resources/loaderror.xsp |
not_found_error_page |
The page that will be executed when the requested page is not found, see the section on configuring load error pages for further details Default Value: /xadmin/resources/notfounderror.xsp |
production_mode
|
Either 'true' or 'false'. When true source code is cached for improved load times. The result of caching the source code rather than the page means that the dynamic content is still served i.e. unaffected. With production mode enabled if a page is replaced in the web application hierarchy, the effect would not be seen until a restart occurred. Default Value: false |
project_projectName (e.g. project_xadmin) |
An optional parameter that holds initial project values. Example: host=localhost; |
redirect_error_page
|
The page that will be executed when an error occurs performing a redirect from within a script page. Default Value: /xadmin/resources/redirecterror.xsp |
run_error_page
|
The page that will be executed when a requested page generates a runtime error during page execution. Default Value: /xadmin/resources/runerror.xsp |
script_encoding |
The encoding that Active Web will use when loading the script files that it processes. Default Value: UTF-8 |
script_cache_size |
Number of pages whose compiled source will be cached. Minimum Value 50; maximum value 65535 Default Value: 250 |
use_browser_language |
Boolean 'true' or 'false. If set true the servlet will first check that a script with the language on country from the Accept-Language field of the request inserted into the root name exists, if that does not exist then look for one with the language, if that does not exist look for the base name. For example if a browser was set to request a language of Chinese and a country of Hong Kong then the language code would be "zh" and the country code would be "HK". If a request is made for the file main.html and this parameter is set to "true" the following search would be applied. First try to server main_zh_KH.html. If this was not found try to serve the file main_zh.html If this was not found try to serve the file main. If this were not found the normal processing would take place for potential secondary paths. |
Topic ID: 150126