JVM arguments are flags that are passed to the Java Virtual Machine at the time the application is launched. On Linux machines, they can be provided through the JAVA_OPTS setting in the whd.conf file. Configure Windows machines located at:
whd_home>/bin/wrapper/conf/wrapper_template.conf
For example, on a Linux installation, you could disable concurrent request handling and set the Casper requestor thread count to 6 by setting JAVA_OPTS
in the whd.conf
file as follows:
JAVA_OPTS=-DWHDconcurrentRequests=false
-DCasper9RequestorThreadCount=6"
The syntax for Windows machines (in wrapper_template.con) is slightly different:
wrapper.java.additional.12=-DWHDconcurrentRequests=false
wrapper.java.additional.13=-DCasper9RequestorThreadCount=6
The number to use for each line depends on your particular configuration. Additionally, if you are adding arguments, you must use -D<argument>
.
Argument | Value | Default | Description |
---|---|---|---|
activemq.broker.port |
<port> |
61616 |
Defines port used by ActiveMQ. Needs |
Casper9RequestorThread |
integer |
4 |
Provides number of threads sending |
WHDlog4jConfigOverride |
true | false |
false |
If true, defines Web Help Desk does |
whd.smtp.host |
<host> |
|
Defines the default SMTP server host |
whd.smtp.port |
<port> |
|
Defines the default SMTP server port |
true | false |
false |
Indicates that Web Help Desk is running |
|
org.apache.tomcat.util. |
true | false |
false |
Is an essential argument for the Spring |
WHDconnections |
<count> |
10 |
Provides the number of allowed |
WHDconcurrentRequests |
true | false |
true |
Indicates whether Web Help Desk |
WHDhosted |
true | false |
false |
(Hosted) Determines whether Web Help Only customers who are authorized |
WHDhostedStandalone |
true | false |
false |
(Hosted) Determines whether Web Help |
WHDhostedAlertsFeed |
<url> |
|
(Hosted) Optional URL to an RSS feed |
WHDhostedSubscriber |
x..y | x.. |
|
(Hosted) Provides range of subscriber |
WHDhostName |
<host> |
webhelpdesk |
(Hosted) Identifies host to use in URLs back |
WHDsecureHostName |
<host> |
secure. |
(Hosted) Identifies host to use in HTTPS URLs |
WHDdemo |
true | false |
false |
Determines whether Web Help Desk should |
WHDliveDemo |
true | false |
false |
Determines whether Web Help Desk should |
WHDsupport |
true | false |
false |
Defines whether Web Help Desk should run |
TEST |
true | false |
false |
Determines whether Web Help Desk should |
WHDsql |
true | false |
false |
Enables logging of each SQL statement. |
WHDtimeouts |
true | false |
false |
Designates whether LDAP and asset |
WHDFingerPort |
<port> | -1=disabled |
79 |
Prescribes the port on which Web Help Desk |
WHDIgnoreClient |
true | false |
false |
Allows users to log in without providing a valid password. We probably don't want to |
WHDPrivileged |
<list> |
localhost |
Provides Classless Inter-Domain Routing
|
WHDPort |
<port> |
80 if hosted |
Prescribes the port to use in URLs that refer |
WHDSecurePort |
<port> |
443 |
Defines the port to use for HTTPS URLs that |
WHDLabelsFolder |
<path> |
<whd_home> |
(Hosted/Dev) Path to labels folder. Regardless |
<path> |
/Helpdesk.woa/.. |
Determines path to the report plugins directory |
|
WHDDiscovery |
<path> |
/Helpdesk.woa/.. |
Defines path to the discovery plugins directory. |
WHDDashboard |
<path> |
/Helpdesk.woa/.. |
Provides path to the dashboard widget plugins directory. The default path is the |
WHDEnableSQLTool |
true | false |
false |
Prescribes whether the endpoint for querying |
WHDInitSchemaOnly |
true | false |
false |
If true, then when initializing the database, the application stops after creating the schema, |
WHDDisableImap |
true | false |
false |
Sets the mail.imap.partialfetch property for |
WHDLdapPassword |
<hours> |
168 (1 week) |
Provides default number of hours for LDAP |
WHDSkipForeignKey |
true | false |
false |
Defines whether the schema update process |
WHDSkipPrimaryKey |
true | false |
false |
Prescribes whether the schema update |
WHDDisableSession |
true | false |
false |
Determines whether the application should When the amount of time specified by WHDHeartbeatTimeoutSeconds has passed When the heartbeat count reaches WHDHeartbeatWarningCount, a warning |
WHDSecondsBetween |
<seconds> |
55 |
Defines the interval at which the ticket editor |
WHDHeartbeatTimeout |
<seconds> |
120 |
Identifies the amount of time without receiving |
WHDHeartbeatWarning |
<integer> |
30 |
Prescribes the number of ticket editor |
WHDMaxHeartbeatCount |
<integer> |
10000 |
Defines the maximum number of heartbeats |
WHDDatabaseUpdate |
<password> |
<none> |
If a password is provided, the database |
WHDMaxDashboard |
<integer> |
-1 |
Maximum number of widgets that a given tech may configure on her dashboard. -1 = unlimited, 0 = disabled. |
WHDReportingAppName |
|
<application name> |
(Hosted) If provided, the given application name is used instead of the current application name when generating bookmark-able links to specific reports. This was provided so that Macquarie University could have an instance with a large amount of memory dedicated for running reports, and have the bookmark-able URLs from the non-reporting instances point to the reporting instance. |
WHDBcryptRounds |
<integer> |
10 |
Provides how many rounds of encryption to use when creating Bcrypt digests. (Eventually, password digests may be generated using the more secure Bcrypt algorithm instead of MD5, but for now, Bcrypt is used only to generate the version number hash in AppProperties_Generated.java. We can switch to Bcrypt for passwords as soon as we upgrade the Mobile app to no longer send passwords as MD5 digests. All that is required to make the switch in the application is to change the order in which digest providers are configured in MDSDigestString.java.) |
WHDEstimatedActive |
<integer> |
2000 |
Identifies estimated number of custom fields of any entity type that are likely to be active. ("Active" custom fields are those that are not empty are not marked as deleted.) Used as a heuristic for optimizing the removal of inactive custom fields from the database, which is performed each time the application starts up in order to optimize the performance of custom field handling. |
WHDUpdateSqlLog |
<path> |
|
If provided, SQL generated for updating the database schema is written to the specified file instead of being committed to the database. Useful for generating an update script that can be applied to the database manually. |
WHDAllowAbsolute |
true | false |
false |
If true, the Discovery Connection panel for Absolute Manage allows the user to select the Absolute Manage SQLite database instead of the MySQL database. Disabled by default because Absolute Manage says the SQLite database is subject to change and isn't a supported means of accessing discovered data. |
WHDWebObjectsMonitor |
true | false |
false |
If true, the application acts as if deployed from WebObjects Monitor regardless of whether this is the detected deployment environment. (When running in WebObjects Monitor, the application does not redirect to the whd-web application, which runs only as a servlet, and therefore certain functionality is disabled.) |
WHDDisableSnapshotRef |
true | false |
false |
If true, EOF snapshot-reference counting is disabled. This can prevent errors about EOF snapshots, but it means that all records fetched from the database are retained in memory. This is provided for troubleshooting. It is unlikely to be a viable option for production deployments because it is likely to require too much memory. |
WHDEnableOutgoing |
true | false |
true |
Determines whether history should be maintained for email that is sent. Outgoing e-mail history can be viewed at Setup > E-Mail > Outgoing Mail Accounts > E-Mail History. History entries include binary copies of the actual e-mail message, which can result in large amounts of database usage over time. The E-Mail History tab provides an option to clear the history. |
WHDEnableScripts |
true | false |
false |
If true, the application looks in the scripts folder for the existence of JavaScript files with predefined names that corresponding to certain callback actions. |
WHDDisableScriptCache |
true | false |
false |
Whether scripts should be cached or reloaded whenever referenced. Should be true only when testing/troubleshooting. |
WHDScriptLogLevel |
"TRACE" | "DEBUG" | "INFO" | |
"ERROR" |
Defines the level of detail at which script execution should be logged. |
WHDScriptFolder |
<path> |
<whd_home> |
Folder in which to look for scripts. |
WHDScriptLogFolder |
<path> |
<whd_home>/log |
Folder in which script log will be written. Script log is named "scripts.log," rolled over up to 5 times in 15MB files. |
WHDDisableExternalAuth |
true | false |
false |
If true, SSO is disabled regardless of selection at Setup > General > Authentication > Authentication Method. |
WHDUseAppName |
true | false |
true |
(Hosted) If true, the URL used when generating URLs that refer back to WHD will use the application name (e.g., "HostedHelpdesk") rather than simply using the value stored in PREFERENCE.SAVED_LOGIN_URL. Setting this to false allows instances that are specially configured for things like reporting (e.g., "OneHelpReporting") to use the application name specified for general instances (e.g., "OneHelp") when constructing links back to WHD in reports, etc. |
WHDWebUrl |
<url> |
/whd-web |
Base URL to the whd-web application. Specifying a full URL could be useful during development in order to redirect to a different port than the one on which the WebObjects application is being served while debugging. |
WHDPrivateBaseUrl |
<url> |
|
Provides the URL to use for backend communication between helpdesk and whd-web applications. This is constructed automatically by the WHD start scripts. Typically configured as "http://localhost:<port>" or "https://localhost:<secure_port>," where <port> and <secure_port> are the WHD HTTP ports configured in whd.conf. |
WHDDisableGSW |
true | false |
false |
If true, then when database connection issues are detected, the old database connection configuration panel will be presented instead of redirecting to the new Getting Started Wizard. (Can be useful during development.) |
WHDhostedDbHost |
|
|
Deprecated. No longer used. Use whd.db.host instead. |
WHDhostedDbName |
|
|
Deprecated. No longer used. Use whd.db.name instead. |
WHDhostedDbUserName |
|
|
Deprecated. No longer used. Use whd.db.username instead. |
WHDhostedDbPassword |
|
|
Deprecated. No longer used. Use whd.db.password instead. |
(All properties in |
|
|
Any of the database-connection properties recorded in <whd_home>/conf/.whd.properties can be specified as JVM arguments. This can be useful to ensure that the application uses the correct parameters in the event that there is a failure reading the .whd.properties file. |
WHDEnterpriseObject |
true | false |
false |
If enabled, MDSGenericRecord records stack traces of where objects are created, which can be used when an IllegalStateException occurs in MDSGenericRecord.willRead() -- which happens when an attempt is made to access an EO after its editing context has been disposed. |
WHDEditingContext |
true | false |
false |
If enabled, MDSEditingContext.newEditingContext() returns instances of MDSEditingContext instead of ERXEC, which record the name of the editing context as well as the editing context itself, so that the object's EC can be more easily identified in logging output. MDSEditingContext also records a stack trace when the editing context is disposed so that it can be logged in MDSGenericRecord.willRead() when an attempt is made to read properties of an object belonging to an editing context that has been disposed. |
WHDHideTickets |
true | false |
false |
If true, the Tickets menu option is hidden from client and tech views. (For customers who want to use the application for Assets and FAQs only.) |
WHDRequireHttpApiKey |
true | false |
false |
If true, the Helpdesk.woa/wa/createTicket direct action requires an apiKey to be provided in the request. |
WHDShowLinkLabels |
true | false |
false |
If true, the Setup menu displays label keys instead of labels, to aid in determining labels to use for generating deep links to specific setup menu options. |
WHDUseOriginalCookie |
true | false |
false |
If true, then the original WebObjects class for parsing cookies will be used instead of the custom class provided by WHD that corrects for cookies that fail to follow the standard cookie syntax by including unencoded commas. |
WHDEmailCheckInterval |
<seconds> |
60 |
Deprecated. Use "WHDDaemonInterval.EmailDaemon" instead. |
WHDCleanupInterval |
<seconds> |
3600 |
Deprecated. Use "WHDDaemonInterval.CleanupDaemon" instead. |
WHDMessage |
<seconds> |
300 |
Deprecated. Use "WHDDaemonInterval. |
WHDDaemonMode |
background | dedicated | none |
none |
Specifies the way in which daemon processes will be run in this instance. A given daemon should never be started in more than one instance. See WHDDaemons for running only certain daemon processes on a given instance. background: Daemons will run as background processes. |
WHDDaemons |
[-]<list> |
All daemons |
Provides comma-separated list of daemons to start, if WHDDaemonMode is background or dedicated. If list is preceded by a minus sign, all daemons EXCEPT those in the list will be started. |
WHDDaemonInterval |
<seconds> |
300 / 600 |
Defines the default daemon interval in seconds. Default is 300 seconds (5 mins) for standard deployments, 600 seconds (10 mins) for hosted deployments. Most daemons have a minimum interval of 60 seconds. (DelayedActionDaemon has a 20s default and 15s minimum; MessageCloserDaemon has a default and minimum interval of 5 mins; CleanupDaemon has a default and minimum interval of 1 hr; and EmailDaemon has a default interval of 60s and a minimum of 15s.) |
WHDDaemonInterval. |
<seconds> |
60 |
Designates the interval (in seconds) between checks for incoming ticket e-mail. Default is 60 seconds. Minimum is 15 seconds. |
WHDDaemonInterval. |
<seconds> |
300 / 600 |
Defines the interval (in seconds) between checks for whether an LDAP sync is needed. Default is 300 seconds (5 mins) for standard deployments, 600 seconds (10 mins) for hosted deployments. Minimum is 60 seconds. |
WHDDaemonInterval. |
<seconds> |
300 / 600 |
Prescribes the interval (in seconds) between checks for whether ticket alerts need to be sent. (Alerts are configured in Setup > Tickets > Priority Types.) |
WHDDaemonInterval. |
<seconds> |
300 / 600 |
Identifies the interval (in seconds) between checks for tickets that need to be auto-closed. (Auto closure is configured for status types in Setup > Tickets > Status Types.) |
WHDDaemonInterval. |
<seconds> |
300 / 600 |
Designates the interval (in seconds) between checks for tickets that are due for a reminder to be e-mailed to the client that the ticket is waiting for their reply. Reminders are configured in Setup > Tickets > Priority Types. |
WHDDaemonInterval. |
<seconds> |
300 / 600 |
Defines the interval (in seconds) between checks for service time blocks that have expired. Service blocks are configured in Setup > Parts & Billing. |
WHDDaemonInterval. |
<seconds> |
300 / 600 |
Identifies the interval (in seconds) between checks for reports that are due to be e-mailed. Report schedules are configured at Reports > Report Schedules. |
WHDDaemonInterval. |
<seconds> |
300 / 600 |
Prescribes the interval (in seconds) between checks for asset reservations that should be checked out automatically, and for checked-out assets that are overdue. Reservations are configured at Assets > Reservations. |
WHDDaemonInterval. |
<seconds> |
20 |
Designates the interval (in seconds) between checks for e-mail that has been queued for sending in the background. |
WHDDaemonInterval. |
<seconds> |
900 |
Determines the interval (in seconds) between triggering of new dummy session. Used only in Tomcat deployments. (Attempt to work around strange hangups that appear to happen only when running under Tomcat, and seem to be prevented by invoking a request that generates a new session.) |
WHDDaemonInterval. |
<seconds> |
14400 |
Provides the interval (in seconds) between checks for Apple devices that should no longer receive push notifications. |
WHDDaemonInterval. |
<seconds> |
300 / 600 |
Identifies the interval (in seconds) between checks for whether an Asset Discovery Connection is due to be run. |
WHDDaemonInterval. |
<seconds> |
300 / 600 |
Designates the interval (in seconds) between checks for whether a database backup is due. |
WHDDaemonInterval. |
<seconds> |
300 / 600 |
Specifies the interval (in seconds) between Java garbage collection triggers. |
WHDDaemonInterval. |
<seconds> |
3600 |
Designates the interval (in seconds) between runs of the cleanup daemon. The cleanup daemon performs various cleanup tasks such as deleting tickets with no request type; setting the DELETED field to 0 for any tickets for which the value is null; deleting single-use bulk actions that have completed; adding 2000 years to any ticket open or close dates prior to the year 100; and removing expired e-mail history entries. |
WHDDaemonInterval. |
<seconds> |
300 |
Interval in seconds between checks for whether any Messages are due for closing. |
WHDDaemonInterval. |
<seconds> |
3600 |
Defines the interval (in seconds) between checks for assets that have alerts due for contract expiration, warranty expiration, and lease expiration. |
WHDDaemonInterval. |
<seconds> |
300 |
Identifies the interval (in seconds) between checks for approval requests that need reminder e-mails. |
WHDDaemonInterval. |
<seconds> |
300 (min 60) |
Provides the interval (in seconds) between checks for unanswered surveys that need reminder e-mails. |
WHDDaemonInterval. |
<seconds> |
300 |
Designates the interval (in seconds) between checks for inventories that are below the threshold for requiring alert e-mails. |
WHDDaemonInterval. |
<seconds> |
86400 |
Specifies the interval (in seconds) between support expiration checks. All admin-level techs receive expiration warning emails. |
WHDPageCacheSize |
<# pages cached> |
10 (min 2) |
Sets the number of pages cached by the WO for backtracking, can be used for tweaking memory consumption. Use carefully; numbers 0 and 1 can cause issues. |
WHDLogMaxSize |
Size in MB |
15 |
Presents size of helpdesk.*log files. |
WHDLogFileCount |
<# of files> |
5 |
Provides count of helpdesk.*log files generated by log4j. |