Parameter Name

Description

Value/Default Value/Possible Value

java.security.auth.login.config

Determines where the 'AuthenticationManager_jaas.config' file is stored.

$VMWEB_HOME/WEB-INF/classes/
AuthenticationManager_jaas.config

user.dir

Determines where the cache will store its files (= a path to resources).

$VMWEB_HOME/WEB-INF/classes

vm.log.dir

Specifies the logging directory (the valuemation.log).

When not defined, the logging directory is set to "<workDir>/log".

- subdirectory "log" of the <workDir>, which is the working directory of the servlet (tag workDir of the servlet <context> node which can be found in the server configuration file).

$VMWEB_HOME/log

vm.logger.level

Log level is used before application is started and bootup user is logged in.

Known log levels: Exception=0, Error=1, Warning=2, Info=3, Debug=5, Finest=7

5

vm.logger.maxsize

The maximal size of one log file or one backup log file in KB. The default value is 2048.

2048

vm.logger.count

Maximal count of backup log files. The default value is 10.

10

vmweb.lib.dir

*.jar and *.zip files from this directory will be added to the java.class.path.

- It is necessary for correct JYTHON initialization.

- Should point to the '$VMWEB_HOME/WEB-INF/lib' directory.

$VMWEB_HOME/WEB-INF/lib

vmweb.classes.dir

The webserver classes directory. It should point to '$VMWEB_HOME/WEB-INF/classes'.

$VMWEB_HOME/WEB-INF/classes

allow_applets

If set to true, the applets can be used in the application. If set to false, the pages will be generated without the applets (the applets functionality will be missing).

true

allow_exec_applet

If true, the exec applet, which implements Start an External Activity, can be used in the application. If false, a page will be generated without the applet, the activity 'Start an External Program' will end with error.

false

enable_cti

If true, it enables CTI on the application level provided CTI is additionally enabled on user level. The CTI applet, which listens to CTI events and causes corresponding CTI workflow to run, becomes part of the top page.

If false, page will be generated without the applet, CTI events will not be processed.

Default: false

false

ctiAppletMainJar

Defines which jar file is used for the CTI applet. Two CTI applet jars are included in the build:

CtiApplet.jar - signed with the new official USU certificate (can be automatically verified by java).

CtiApplet_selfsignedCert.jar - signed with the old selfsigned certificate (included for backward compatibility).

The other libraries used for the CTI applet must be signed with the same certificate as the main CTI applet main jar file.

Default: CtiApplet.jar

CtiApplet.jar

debug_cti

Enables the debugging of CTI.

Default: False

false

trace_ctiApplet

If true, trace messages are sent by CtiApplet into Java Console window on a client. Use it only for debugging purposes.

If false, no trace messages are sent into Java Console window.

Default: False

false

ctiAppletLibs

A comma-separated list of *.jar files located at webconf/applets/lib, which are used by the CtiApplet. For example, the PBX manufacturer specific JTAPI files.

siemens/cap-jtapi.jar,siemens/CSTABean.jar,siemens/jaxp-api.jar, siemens/jtapi1_3_1.jar, siemens/log4j-1.2.7.jar, siemens/sax.jar,siemens/w3c_full.jar, siemens/xercesImpl.jar,cisco/jtapi.jar

teamcall/CSTABean.jar,teamcall/jtapi1_3_1.jar,
teamcall/log4j-1.2.7.jar,
teamcall/teamcall-jtapi.jar

sikom/agentone-5.0.jar,sikom/log4j-1.2.15.jar

siemens/cap-jtapi.jar,siemens/CSTABean.jar,
siemens/jaxp-api.jar,siemens/jtapi1_3_1.jar,siemens/log4j-1.2.7.jar,
siemens/sax.jar,siemens/w3c_full.jar, siemens/xercesImpl.jar,cisco/jtapi.jar

vmweb.skins

A comma-separated list of available skins. The names of the skins must correspond to the skin folder names inside the deployed "client/sc/skins" directory. It can be also used to eliminate the available skins.

Only the skins specified in this parameter are available. The standard skins are used, when this parameter is not defined.

Do not set this parameter unless you need to use some special nonstandard skin or you want to limit the available skins for the user.

Example: flatblue, chameleon

vmweb.gzip

The RegExp pattern used to match the HTTP mime-types that can be compressed by GZip encoding.

If set to "true" (the default value), the pattern "text/.*" will be used.

If set to "false", the compression will be disabled.

It should be set to "false" or "text/html" if IE6 is used on Windows older than Windows XP SP2.

The pattern must match the entire value of mime-type - the examples of valid patterns are: "text/html", "text/.*", "text/.*|application/rtf|application/rss\+xml

true

vmweb.charset

The default INPUT/OUTPUT encoding (Accept-Charset is checked).

utf-8

vmweb.seekedread.pagesize

Number of the objects displayed on one page of a catalog. When not specified, the load limit from the global Valuemation settings is used.

50

display_finish_dialog

If set to true, a dialog indicating that the catalog/business object editor has been opened will popup. This is meant just for testing purposes (e.g. for testing with a robot).

false

autoCloseRunlinkInExistingSessionWindow

When set to true, Valuemation tries to close the browser window displaying the information message when a runlink is executed in the existing session.

This is proprietary solution which works in IE only.

Generally it is not allowed for the javascript to close the browser window which was not opened from the javascript (it is a kind of security restriction).

Some tricks to bypass the "not allowed window closing from javascript" restrictions for IE are used.

We cannot promise this solution will work with next releases or fixes of IE.

Default: false (autoclose disabled)

false

clientConfig.desktopMessageBarAutoHideTime

Set timeout for the desktop message bar (e.g. warning when IE Compatibility View mode is used).

The value is in seconds. If set to 0, the bar will not be hidden automatically.

The default value is 15sec.

15

clientConfig.pushServiceType

The Push service parameter. Defines the type of communication of the push service system.

The possible values are:

OFF - the push service is deactivated.

CONTINUOUS - the client opens HTTP connection to the server to listen to push events continuously.

INTERVAL - the client asks the server for new events in defined interval (not implemented).

For details, see the 'Push Notification Service' chapter.

OFF

clientConfig.pushServiceConnectionRefreshDelay

The Push service parameter. Defines an interval between refreshes of the opened HTTP connection listening to push events (in seconds).

For details, see the 'Push Notification Service' chapter.

60

clientConfig.pushServiceOnErrorRefreshDelay

The Push service parameter. Defines an interval between tries to open a new HTTP connection if transport error is detected (in seconds).

For details, see the 'Push Notification Service' chapter.

10

pushServiceNodes

The Push service parameter. Defines set of distributed push service nodes as JSON array, e.g. [{"url": "http://10.151.10.94:8090/vmweb/services/"},{"url": "http://10.151.10.95:8090/vmweb/services/"}]

PENTAHO_REPORTING_URL

The relative path to the location where VMA reports are to be created.

/reporting/

PENTAHO_REPORTING_ABSOLUTE_PATH

The absolute path to the location where VMA reports are to be created.

$VMWEB_HOME/reporting/

PENTAHO_RESOURCE_FOLDER

Points to the resource folder in the translation cache.

crystalreports

PENTAHO_STYLING_FOLDER

Points to folder containing styling informations for VMA reports, e.g. stylesheets and company logos

$VMWEB_HOME/webconf/report_styling

BIRT_HOME

The absolute path to the BIRT report engine.

D:/Programme/birt-runtime-2_1_1/ReportEngine

BIRT_REPORTING_URL

The relative path to the location where BIRT reports are to be created.

/reporting/

BIRT_REPORTING_ABSOLUTE_PATH

The absolute path to the location where BIRT reports are to be created.

$VMWEB_HOME/reporting/

BIRT_RESOURCE_FOLDER

Points to the resource folder in the translation cache.

botranslations

BIRT_EXTERNAL_PRINT_SERVER

Determines if BIRT uses the external server.

true

vmweb.actions.unsupported

The unsupported actions are separated by a comma.

.help.help,
.catalog.edit,
.catalog.export,
.catalog.newReport,
.businessobject.new_report,
.component.starthomepage,
.system.systeminfo,
.metaworkflow.remove,
.metaworkflow.copy,
.metaworkflow.create,
.metaworkflow.edit,
.metaworkflow.lockUnlock,
.metaworkflow.takeLock,
.attachment.addLink,
.BpmProcess_newVersion,
.CreateProcess

vmweb.actions.groupedcatalog

!! Obsolete since Valuemation 4.1 with full support for actions in group view mode.

This parameter specifies actions, which are allowed to be executed from any catalog/toManyView in grouping mode. The actions are separated by a comma. When the action is not listed in the parameter, it will no be possible to execute it, when the catalog or toManyView is in the grouping mode.

.catalog.bookmark,
.catalog.search,
.catalog.switch,
.catalog.refresh,
.catalog.exportToTextFile, .businessobject.print, .businessobject.printWith,
.help.help,
.catalog.close,
.catalog.cancel, .catalog.groupView, .objectGroup.computeNAValues, .catalog.cancelWFNotCancel, .drillDown

vmweb.logout.cleaning.timeout

Specifies how long (in seconds) the logout thread is waiting to other threads to complete their job.

Default value: 300 (5 minutes).

300

cache_xsl

XSL caching : Set to "false" to disable, set to "true" to enable.

true

cache_js

JavaScripts caching : to disable set to "false"; to enable set to "true".

true

js_client_cache_max_age

JavaScripts caching : Max-age time for checking new version in seconds (to disable, set 0).

86400

images_client_cache_max_age

Images by ImageTask caching : max-age time for checking new version in seconds (to disable, set 0)

604800

cache_css

CSS caching : To disable set to "false"; to enable set to "true"

true

css_client_cache_max_age

CSS caching : Max-age time for checking a new version in seconds (to disable, set 0)

86400

cache_invalidation

Defines the cache invalidation method.

The possible values are:

'serverstart' - caches are invalidated by each server start.

'vmwebversion' - caches are invalidated by deploying of a new vmweb version.

serverstart, vmwebversion

help_check_url

Defines whether the server should validate the URL of the Valuemation Help.

If switched off, Valuemation cannot handle wrong help settings and browser window "Page not found" will be opened.

true

html_contextmenu_enabled

Web browser context menu disabled: To disable, set to "false"; to enable, set to "true".

false

transformer.pool.size

A maximum number of concurrent XSLT (recommended value is about double of the number of CPUs).

10

transformer.factory.class

A class to use for XSLT transformation - comment out to use XSLTC.

org.apache.xalan.xsltc.trax.TransformerFactoryImpl

sidebar.workflows.max

Number of maximum (currently) opened workflow actions from the sidebar.

Set to "-1" to disable the limit.

-1

cti.workflows.max

Number of maximum (currently) started workflows from CTI.

Set to "-1" to disable the limit.

-1

vmweb.dumpconfig

When set to true, the Valuemation web server configuration information are printed to the standard output.

true

vmweb.appname

Set this parameter to a text, which should be displayed as a title of the client browser window.

Valuemation Web

ignoreSSOSettings

When set to "true", SSO is disabled.

Set to true to ignore the shared SSO settings in mainparameters. Then SSO is disabled for this VM instance.

false

ssoReloginBySessionTimeout

When set to "true" and SSO is on, the Valuemation client is automatically reloged when a session expires.

false

logoutURL

Use this parameter when a special page is requested to be displayed after logout from Valuemation.

Example: To process the logout from another system.

vmweb.session_watcher.enabled

Enabled/disables the vmweb session-timeout checking mechanism. This mechanism checks the inactivity of the session - it's only "supporting" mechanism to standard 'session-timeout' (which could not work correctly in some cases).

When set to 'true', the checking mechanism is used. Otherwise it is switched off.

Default: true

true

vmweb.session_watcher.checkperiod

Defines the sessions checking period in seconds - All the Valuemation sessions are periodically checked for how long they have been inactive. When it is too long (see the parameter 'vmweb.session_watcher.forcelogoutcoef') the inactive sessions are invalidated (logout is processed).

Default: 30

30

vmweb.session_watcher.warningcoef

When the session is not used for more than "session-timeout" multiplied by this coefficient, a warning message is logged into the log file.

Value: 'decimal number' - the session timeout warning coefficient

Default: 1.2

.2

vmweb.session.keepaliveping_enabled

Enables/disables whether Valuemation web client should keep its current http session alive by sending regularly a dummy http request to its vmweb server. These dummy pings have the "keeping session alive" effect only if there is another regular http request processed at the same time by vmweb server. Otherwise the dummy ping has no impact on its session timeout.

As a result, this construct guarantees that the vmweb session timeout never elapses during a http request running for an arbitrarily long time on the vmweb server side.

The session timeout caused by a vmweb client inactivity is not influenced with this behavior.

Default: true

true

vmweb.session.keepaliveping_period

Defines in seconds the time period between dummy http requests sent regularly from vmweb client to vmweb server to keep the current http session alive for the time when another http request is being processed on vmweb server.

This parameter is relevant only if the init parameter vmweb.session.keepaliveping_enabled = true.

If this parameter is missing, empty/null, negative or zero then the period is automatically calculated as 60% of the current session timeout.

Default: null

vmweb.servername

Defines the name of the server where the application is deployed. This server name is used for logging into Sessions objects.

When the value is defined it is logged into the Sessions objects as a part of Host Name attribute

- the value is stored inf form "ServerName | ClientIP", where the ServerName is value of this parameter and ClientIP is IP address of the client (which is in most cases the IP addres of some prepending load balancing server.

When the value is not defined or empty, only the ClientIP is logged.

This parameter can be also set using the Java System Property (e.g. java.exe -Dvmweb.servername=Server01)

- the value from JVM System Property has higher priority.

vmweb.sso.ntlm.use_jcifs_properties

Defines how the JCIFS library is configured for NTLM password verification.

Value: true/false

When true, the JCIFS is configured by its properties (see http://jcifs.samba.org). The JCFIS properties can be defined in the vmconfig.properties file (or as the init-params).

When false, the Domain Controller is defined by the MainParameter {VMWeb:VMWebSSONTLMDomainController}

The Default Domain is defined by the MainParameter {VMWeb:VMWebSSONTLMDefaultDomain}

Default: false

false

vmweb.session_watcher.forcelogoutcoef

When the session is not used for more then "session-timeout" multiplied by this coefficient, the session is invalidated - "logouted".

Value: 'decimal number' - the session timeout logout coefficient.

Default: 1.5

1.5

vmweb.session.server_timeout

Defines the maximal time (in minutes) for processing one request on the server to prevent the standard session timeout which occurs during processing one long lasting operation on the server.

When server receives a request the session timeout would be increased to the value defined by this parameter.

This should prevent from session timeout during processing one long lasting operation.

When the operation is finished and the response is sent back, the session timout would be reset to the normal session-timout value.

So when client does not produce any request for more than "session-timeout" minutes, the session would be timeout-ed.

ie6_download_in_new_window

Defines whether downloading data from CatalogToText should be processed in a new browser window.

IE6 does not close the new window automatically; IE7 and Firefox close it.

When set to false(default): The downloading will be processed in an iframe (no new window is opened) but this can lead to problems when the extension of the downloaded file is not associated to any application. In this case, the downloaded data overwrites the main Valuemation window.

- when set to true - a new window will be used for downloading (to prevent from the valuemation window overwriting problem)

false

vmweb.calendar.nr_nonscroll_ad_events

Defines the maximum number of All-Day calendar events displayed in the calendar header area without the scroll bar.

When more events are generated, a scroll bar is displayed to offer the possibility to see all the other events.

Default value: 8

8

jython.extra.path

Extra folder path to be added to Jython Interpreter to look for jar files. Only one folder possible.

Log level INFO prints out processing of this parameter.

$VMWEB_HOME\WEB-INF\classes

show_product_info

Defines whether to show product information in the setting dialog.

true

show_system_config

Defines whether to show system configuration in the setting dialog.

false

progressbar_fixed_size

Defines the width of the progress bar task (the inner part with a label), if it is <= 0 then the width will be set automatically according to the text length

-10

use_constant_cache_id_value

Defines whether to use constant cache Id value, which is part of Web requests (usefull for robot testing).

The default value should be false.

false

CatalogProvider.CacheCatalogProperties.Limit

Defines whether the cache storing catalog properties is used or not. Using the cache speeds up displaying the sidebar but it has a memory footprint.

When the value is:

= -1, the cache will be used, all the catalog properies of a user will be stored in a cache.

!= -1, the cache will not be used.

Default: 0

0

clientCacheViewsEnabled

Allows to disable the client view cache (Invalidates the mainparameter: clientCacheViewsSize).

Default: true

true

accessibility_urlprefix

Defines the URL prefix to recognize if the VM/login page is accessed in the screenreader mode.

acc_

vmweb.servlet.workingpath

Defines the URL servlet path used for the redirection after a successful login.

Use with the special login servlet mapping together with Kerberos-SSO, only when the "login" url is 'kerberized'.

vmweb

vmweb.servlet.downloadfile.path

The URL path added to the servlet path for downloading files from attachments. It is used to simulate a filename in the URL-path (as the last segment). This is needed to name properly a file directly opened in plugins or an external application. This value must correspond to the additional vmweb servlet mapping (by default '/vmweb/download/*')

Default: download

download

requestTimeout

The browser AJAX-request timeout.

Defines the client side timeout for AJAX-request in miliseconds, i.e. how long the client waits for the AJAX response. 0 means "unlimited".

Default: 0

0

addARIATags

Parameter 'addARIATags' enables web client mode in which ARIA tags are added to DOM elements. It can be used to define proper element locators for the use by automated testing frameworks (e.g. SilkTest).

Note: ARIA tags are primarily used by the screen reader mode. Unlike the screen reader mode, the 'add ARIA tags' mode uses the tags with no other functional or design difference to 'normal mode'.

Note that the 'add ARIA tags' mode can also be enabled in mainparameters:

Path: 'VMWeb' parameter: addARIATags' value: 'true/false'.

If both addARIA settings (web.xml and mainparameters) are used, the value in mainparameters is used.

Default: false.

false

waitForAppletCallbackTimeout

Defines the maximum timeout (in seconds) to wait till the applet is loaded (now used for the PasteFromClipboard applet).

The applet will call the callback function when it has been initialized.

Then the callback function executes the applet functionality, e.g. starts pasting a picture.

When the timeout is passed, the applet loading is declared failed.

When the value is lower then '1' the callback calling mechanism is not used. The previous (older) periodical checking is used instead.

Default: 15

15

vmweb.disableXSRFProtection

When set to TRUE, the XSRF (Cross Site Request Forgery) protection will be disabled.

Default: false

false

vmweb.allowPathTraversal

When set to 'true', the Path Traversal outside the Valuemation web root folder is allowed.

By manipulating the path that references the files with "dot-dot-slash (../)" sequences and its variations, it may be possible to access arbitrary files and directories stored on the file system.

By default, the Path Traversal is disabled as it is considered to be a security risk.

false

clientConfig.applyFixIEFocusScrolling

There is a scrolling problem in Internet Explorer 9 and the newer browsers: When the "outline" property is set for focused elements (the dotted border), scrolling inside this element may cause that the outline remains visible inside the element as additional rows.

The SmartGWT (since version 4.1 and higher) applies a fix for this problem but it also affects the scrolling performance in Internet Explorer, which does not seem to be as smooth as in other browsers.

This parameter enables you to disable the fix application to make scrolling in IE smoother (set the 'false' value).

The default value is true ( = the fix applied, not smooth scrolling).

true

vmweb.SSOLoginByGETFallback

When set to true, the HTTP GET method will be used for submitting the login form when a user is not authenticated by SSO and the user credentials are entered into the login form (or when the timezone selection dialog box is shown after the SSO login).

Otherwise the POST method is used, which is a more secure option. Using the GET method is a workaround for the problems with the deprecated internal SSO by NTLMv1 (IE is sending the POST request twice and Valuemation did not properly handled that situation for the login dialog box).

false