Mod Wcm Reference


An Apache module that supports the KCML browser client and KCML SOAP.

Usage:

Make sure the module binary mod_wcm.so is copied to the module subdirectory and add this line to httpd.conf after the other LoadModule commands.

LoadModule wcm_module modules/mod_wcm.so

Configuration commands

CommandValidArgumentsDescription
KcmlLocalDirserver or directory
arg nametype
KcmlDirstring
Local KCML directory

Only applicable if KCML is run locally without using a connection manager.
KcmlLocalKconfserver or directory
arg nametype
KcmlKconfPathstring
Alternative local kconf.xml file

Only applicable if KCML is run locally without using a connection manager.
KcmlBasePortserver or directory
arg nametype
BasePortint
The base of a range of listening ports

Only applicable if KCML is run locally without using a connection manager.
KcmlLocalDefaultUserserver or directory
arg nametype
LocalDefaultUserstring
Default user to run local KCML sessions

Only applicable if KCML is run locally without using a connection manager. If the user isn't given then use this username for local KCML sessions.
KcmlLocalServicesserver or directory
arg nametype
Servicestring
List of default services to use.

A list of services that could be started locally.
KcmlRemoteServicesserver or directory
arg nametype
Servicestring
List of default services to use.

A list of services that could be started remotely.
KcmlShimServicesserver or directory
arg nametype
Servicestring
List of remote services that should be shimmed.

A subset of KCMLRemoteServices that should be shimmed.
KcmlAppServersserver or directory
arg nametype
Serverstring
KCML application servers

Remote server(s) running a connection manager. If using a non-standard port then append it after a colon.
KcmlSOAPServersserver or directory
arg nametype
Serverstring
KCML SOAP application servers

Remote SOAP server(s). If using a non-standard port then append it after a colon.
KcmlKSADServersserver or directory
arg nametype
Serverstring
KCML KSAD servers

If using a non-standard port then append it after a colon. This has a default value of 'localhost:790'.
KcmlSessionModeserver or directory
arg nametype
Modestring
How sessions are maintained accross HTTP request.

URL - The session id is embedded in the URL. Default. Cookie - The session id is stored in a cookie. Header - The session id forms part to the HTTP Headers. The application is responsable for setting it on inbond requests.
KcmlSOAPModeserver or directory
arg nametype
Modestring
How to start SOAP application servers. Shared/PerChild.

Dynamic - Start SOAP servers dynamically. Default. Shared - Deprecated. One SOAP server is shared for all incoming requests. PerChild - Deprecated. A SOAP server is created for each Apache Process.
KcmlSOAPProgramserver or directory
arg nametype
SOAPProgramstring
SOAP program to execute

Only applicable if KCML is run as a local process.
KcmlMaxInstserver or directory
arg nametype
SOAPMaxInstint
The maximum number of stateless servers to start for handling.

Only applicable if running stateless servers (SOAP).
KcmlSOAPMaxInstserver or directory
arg nametype
SOAPMaxInstint
The maximum number of SOAP servers to start.

Deprecated. Please use MaxInst
KcmlMaxIdleserver or directory
arg nametype
SOAPMaxIdleint
The maximum number of stateless servers allowed to remain idle

Only applicable if running stateless servers (SOAP). A server is considered idle if it has no current request and hasn't serviced a request within a 30 second time period.
KcmlSOAPMaxIdleserver or directory
arg nametype
SOAPMaxIdleint
The maximum number of SOAP servers allowed to remain idle

Deprecated. Please use MaxIdle
KcmlMsvcDirserver or directory
arg nametype
MsvcDirstring
Local directory containing MSVC debugger

Windows only. You may not need this. It sets the MSVC environment variable in the service.
KcmlVsPerfToolsserver or directory
arg nametype
VsPerfToolsstring
Local directory containing MS Perfomance tools

Windows only. Needs Visual Studion installed and is only used for performance monitoring.
KcmlLoggingserver or directory
arg nametype
Filenamestring
Levelint
Filename and level for logging

Deprecated
KcmlIconDirserver or directory
arg nametype
Aliasstring
Dirstring
Alias and directory name for icons

Specifies the location of the K8 icon directories. There can be more than one of these to specify Icons and DBASE.
KcmlCustomMetaDataserver or directory
arg nametype
Patternstring
MetaFilenamestring
Meta information to be added for specific browsers

Regular expression pattern match and filename of extra meta information that can be sent if the userAgent field matches the pattern.
KcmlLocalCssserver or directory
arg nametype
LocalCssFilestring
CSS file to be included in generated pages

Filename of a CSS file to be added at the end of each generated page. Use this to specify local overrides.
KcmlJSExtraserver or directory
arg nametype
jsuristring
jsfilestring
Specify extra JS libraries to be include in page

List of js files.
KcmlExpandJsserver or directory
arg nametype
ExpandJSbool
If On then the individual script files will be sent in the bootstrap

Omit or set to Off for production systems.
KcmlLintserver or directory
arg nametype
Lintstring
JSLint executable

The filename of the JSLint executable to be run on the JavaScript files. If not in the JS directory it should be a full path name starting with a forward slash. Don't add any .EXE extension.
KcmlProcessTable
arg nametype
MapFilestring
Filename for the process table

This is the memory mapped session table and is created in /tmp by default. Use this to specify a different location.
KcmlSessionTimeout
arg nametype
SessionTimeoutunsigned int
Session timeout in minutes

A session will timeout after this period of inactivity. All current state is lost.
KcmlBrokers
arg nametype
Brokersunsigned int
Number of broker processes

Number of broker processes to start
KcmlBrokerBasePort
arg nametype
BrokerBaseunsigned int
The base of a range of broker listening ports

KcmlBrokerUser
arg nametype
BrokerUserstring
User to run the broker

KcmlMaxSessions
arg nametype
MaxSessionsunsigned int
Maximum sessions for wcm. This is per server. Each wcm handler uses the same session table.

KcmlPDBserver or directory
arg nametype
PDBbool
If On then use PDB compiler

Omit or set to Off for normal KCML7 compilation
KcmlTestDirserver or directory
arg nametype
TestDirstring
Name a directory containing test programs

If defined all the .src programs in that directory will listed in the home page
KcmlTempDir
arg nametype
TempDirstring
Name a directory containing temporary files

If defined temp files go here
KcmlAuthProviderserver or directory
arg nametype
providerstring
When mod_wcm handles authenication. Provider for that authentication. Default file

KcmlAuthCMServersserver or directory
arg nametype
Serverstring
The CM servers to use when mod_wcm acts as authenication provider. If not set will use AppServers, KSADServers

KcmlBypassCMserver or directory
arg nametype
BypassCMbool


KcmlAuthSecretserver or directory
arg nametype
Passwordstring
The secret to use when generating encryption keys.

It is important that this value be kept secret. It is recommended that this value be set via an include file with strict permissions.
KcmlAuthCookieExpireserver or directory
arg nametype
timestring
The expiry time for authentication cookies.

The expiry time for authentication cookies. The time give is rounded to nearest minute. Supports Days, Hours, minutes, seconds. e.g "1 hour 120 seconds"
KcmlAuthCatchDoublePOSTserver or directory
arg nametype
AuthCatchDoublePOSTbool
Intercept an authentication POST even if we are already authenticated.

Because this involves the intercepton of every POST it is off by default. If possible the application should handle the case where a second authentication FORM post occurs.
KcmlAuthCookieBehaviourserver or directory
arg nametype
numberstring
Only set if asked.

KcmlAuthHeaderserver or directory
arg nametype
AuthHeaderbool
Set to pass on Authorisation header to KCML.

Normally the Authorisation header is not passed on to KCML for security reasons. Set this if the KCML application will be handling authorisation.
KcmlExtendedHTMLErrorsserver or directory
arg nametype
FullErrorbool
Include more information with HTML errors

KcmlShimLogDirserver or directory
arg nametype
ShimLogDirstring
Name a directory containing JClient shim dsdump logs

KcmlShimProxyserver or directory
arg nametype
ShimProxybool
Request comes from a reverse proxy. Enable shim and only allow connections back to the originiating IP.

KcmlShimPingTimeserver or directory
arg nametype
ShimPingTimeunsigned int
Ping timeout in minutes

Browser will ping the shim to check for the existence of the KCML aplication.