Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.


Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

iWD Manager configuration options

iWD Manager establishes a connection to Configuration Server at the moment of user login. The configuration needed to start the iWD Manager web application is read from property files. There are two levels of connection:

  • System level connection—Connects to Configuration Server on behalf of the SYSTEM user at the moment of iWD Manager application startup before Tomcat starts, and reads the initial configuration required for web application.
  • User level connection—Connects to Configuration Server on behalf of an actual user at the moment of login, and reads user-specific configuration.

[tomcat] section

host

  • Mandatory—no
  • Default value0.0.0.0
  • Type—string
  • Valid values—Any valid string
  • Description—The host can either be a machine name or a textual representation of its IP address. Setting the host to 0.0.0.0 indicates that the server will be listening on all interfaces.

serverName

  • Mandatory—no
  • Default valueApache
  • Type—string
  • Valid values—Any valid string
  • Description—Server name in response header.

contextPath

  • Mandatory—no
  • Default value/iwd_manager
  • Type—string
  • Valid values—Any valid string
  • Description—Application context path.

sessionTimeout

  • Mandatory—no
  • Default value60
  • Type—integer
  • Valid values0-1440
  • Description—Sets the default session timeout (in minutes) for this web application.

connectionTimeout

  • Mandatory—no
  • Default value60000
  • Type—integer
  • Valid values0-86400000, or -1
  • Description—The number of milliseconds this Connector will wait, after accepting a connection, for the request URI line to be presented. Value -1 indicates no (that is, infinite) timeout.

accessLogEnabled

  • Mandatory—no
  • Default valuefalse
  • Type—boolean
  • Valid valuestrue, false
  • Description—Enables access logging.

accessLogDirectory

  • Mandatory—no
  • Default value/GCTI/iWD
  • Type—string
  • Valid values—Any valid string
  • Description—Absolute or relative pathname of a directory in which access log files will be placed. If a relative path is specified, it is interpreted as relative to $CATALINA_BASE.

accessLogPrefix

  • Mandatory—no
  • Default valueiwd_manager_access
  • Type—string
  • Valid values—Any valid string
  • Description—The prefix added to the start of each access log file's name.

accessLogSuffix

  • Mandatory—no
  • Default value.log
  • Type—string
  • Valid values—Any valid string
  • Description—The suffix added to the end of each access log file's name.

accessLogPattern

  • Mandatory—no
  • Default valuecommon
  • Type—string
  • Valid values—Any valid string
  • Description—Either a formatting layout identifying the various information fields from the request and response to be logged, or the word common or combined to select a standard format. Supported pattern codes are described on https://tomcat.apache.org/tomcat-8.5-doc/config/valve.html#Access_Log_Valve

proxySupportEnabled

  • Mandatory—no
  • Default valuefalse
  • Type—boolean
  • Valid valuestrue, false
  • Description—Enables proxy support.

proxyName

  • Mandatory—no
  • Default valuelocalhost
  • Type—string
  • Valid values—Any valid string
  • Description—Proxy server name.

proxyPort

  • Mandatory—no
  • Default value80
  • Type—integer
  • Valid values1-65535
  • Description—Proxy server port.

proxySslEnabled

  • Mandatory—no
  • Default valuefalse
  • Type—boolean
  • Valid valuestrue, false
  • Description—Indicates if proxy has SSL enabled.

allowEncodedSlash

  • Mandatory—no
  • Default valuetrue
  • Type—boolean
  • Valid valuestrue, false
  • Description—Allow encoded slash in url.

allowBackSlash

  • Mandatory—no
  • Default valuetrue
  • Type—boolean
  • Valid valuestrue, false
  • Description—Allow encoded backslash in url.

jsDebugEnabled

  • Mandatory—no
  • Default valuetrue
  • Type—boolean
  • Valid valuestrue, false
  • Description—Enables JavaScript debugging.

relaxedPathChars

  • Mandatory—no
  • Default value
  • Type—string
  • Valid values—any valid string
  • Description—Allows provided symbols to be used in the URL path. For more information read this Tomcat documentation.

WARNING—Using this option may expose the server to CVE-2016-6816.

relaxedQueryChars

  • Mandatory—no
  • Default value
  • Type—string
  • Valid values—any valid string
  • Description—Allows provided symbols to be used in the URL query. For more information read this Tomcat documentation.

WARNING—Using this option may expose the server to CVE-2016-6816.

[iwd] section

taskHistorySizeLimit

  • Mandatory—no
  • Default value5000
  • Type—integer
  • Valid values1-500000
  • Description—Maximum number of events to display in Task History.

pullRetryTimeoutMillis

  • Mandatory—no
  • Default value500
  • Type—integer
  • Valid values0-86400000
  • Description—When a request to "pull" an interaction from Interaction Server fails, it will be automatically repeated after some time of waiting. Maximum time of trying to pull an interaction (in milliseconds).

pullRetryDelayMillis

  • Mandatory—no
  • Default value30
  • Type—integer
  • Valid values0-86400000
  • Description—When a request to "pull" an interaction from Interaction Server fails, it will be automatically repeated after some time of waiting. Time of waiting before each attempt.

filterElementValuePattern

  • Mandatory—no
  • Default value(?U)([\p{Alnum} _%.\-\\]\p{M}*)*
  • Type—string
  • Valid values—Any valid regex string
  • Description—Allowed values in GTL filter criteria. The syntax has to be compatible with Java regular expressions (https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html). Default for Unicode: a sequence of alphabetic, digit, space, underscore, percent, dot or minus characters, followed by zero or more modifiers. The characters ' (apostrophe) and " (quotation) are forbidden internally in stored filters, regardless of this pattern. They may be allowed in quick (ad hoc) filters.

cfgConnectionTimeout

  • Mandatory—no
  • Default value60000
  • Type—integer
  • Valid values0-86400000
  • Description—The number of milliseconds iWD Manager will wait for Config Server response, including connection establishment.

ixnConnectionTimeout

  • Mandatory—no
  • Default value60000
  • Type—integer
  • Valid values0-86400000
  • Description—The number of milliseconds iWD Manager will wait for Interaction Server response, including connection establishment. If inx-protocol-timeout is set in Solution options, it overrides ixnConnectionTimeout property.

ucsConnectionTimeout

  • Mandatory—no
  • Default value60000
  • Type—integer
  • Valid values0-86400000
  • Description—The number of milliseconds iWD Manager will wait for UCS response, including connection establishment.

msgConnectionTimeout

  • Mandatory—no
  • Default value60000
  • Type—integer
  • Valid values0-86400000
  • Description—The number of milliseconds iWD Manager will wait for Message Server response, including connection establishment.

[clientApplication] section

To establish the user level connection, you must provide an application name.

name

  • Mandatory—yes
  • Default value—N/A
  • Type—string
  • Valid values
  • Description—iWD Manager requires an additional application to initiate connections after user login. Provide the client application name in this parameter.

[log] section

level

  • Mandatory—no
  • Default valueINFO
  • Type—String
  • Valid valuesOFF, ERROR, WARN, INFO, DEBUG, TRACE and ALL
  • Description—Log level

time-zone

  • Mandatory—no
  • Default valueUTC
  • Type—String
  • Valid values—The ID for a time zone, either an abbreviation such as PST, a full name such as America/Los_Angeles, or a custom ID such as GMT-8:00
  • Description—The time zone to which event timestamps will be converted.

log-to-console

  • Mandatory—no
  • Default valuefalse
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to log events to the console.

console-log-level

  • Mandatory—no
  • Default value
  • Type—String
  • Valid valuesOFF, ERROR, WARN, INFO, DEBUG, TRACE and ALL
  • Description—Console appender log level. If not set, logger level is used. Appender level can narrow down logger level but not extend it. For example, if logger level is INFO, it makes sense to set WARN or ERROR appender level, whereas if you set appender level to TRACE or DEBUG it has no effect.

centralized-logging

  • Mandatory—no
  • Default valuefalse
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to log events to Message Server.

centralized-log-level

  • Mandatory—no
  • Default valueSTANDARD
  • Type—String
  • Valid valuesSTANDARD, ALARM
  • Description—Centralized appender log level. Centralized appender supports only levels higher than or equal to INFO. STANDARD level corresponds to INFO, so INFO, WARN and ERROR logs will be sent to Message Server, ALARM level corresponds to ERROR log level.

log-to-file

  • Mandatory—no
  • Default valuetrue
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to log to a file.

file-log-level

  • Mandatory—no
  • Default value
  • Type—String
  • Valid valuesOFF, ERROR, WARN, INFO, DEBUG, TRACE and ALL
  • Description—File appender log level. If not set, logger level is used. Appender level can narrow down logger level but not extend it. For example, if logger level is INFO, it makes sense to set WARN or ERROR appender level, whereas if you set appender level to TRACE or DEBUG it has no effect.

log-filename

  • Mandatory—no
  • Default value/GCTI/iWD/iwd_manager.log
  • Type—String
  • Valid values
  • Description—The path to the file where current events are logged.

archive

  • Mandatory—no
  • Default valuefalse
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to archive old events in separate files. Archived filenames are set to <log-filename without extension>-%d-%i<log-filename extension> if option file-max-size has a value, otherwise they are set to <log-filename without extension>-%d<log-filename extension>.

max-file-size

  • Mandatory—no
  • Default value
  • Type—String
  • Valid values
  • Description—The maximum size of the currently active file before a rollover is triggered. Note: Used if the value of archive is true. The value can be expressed in bytes, kilobytes, megabytes or gigabytes by suffixing a numeric value with KB, MB and respectively GB. For example, 5000000, 5000KB, 5MB and 2GB are all valid values, with the first three being equivalent.

max-history

  • Mandatory—no
  • Default value0 (zero)
  • Type—Integer
  • Valid values—Integer greater than or equal to 0 (zero means to keep infinite number of files)
  • Description—Controls the maximum number of days for archive files to keep, asynchronously deleting older files.
This page was last edited on June 28, 2019, at 13:47.

Feedback

Comment on this article:

blog comments powered by Disqus