Global options - detailed description

This section gives full descriptions of the global options managed by optman:

approachingLateOffset | al

Approaching late offset. Used in workload service assurance. The critical start time of a job in the critical network is the latest time that the job can start without causing the critical job to finish after the deadline. In most cases, a job will start well before the critical start time so that if the job runs longer than its estimated duration, the situation does not immediately become critical. Therefore, if a job has not started and the critical start time is only a few minutes away, the timely completion of the critical job is considered to be potentially at risk.

The approachingLateOffset option allows you to determine the length of time before the critical start time of a job in the critical network at which you are to alerted to this potential risk. If a job has still not started the specified number of seconds before the critical start time, the job is added to a hot list that can be viewed on the Dynamic Workload Console.

Note: To qualify for addition to the hot list, all time and follow dependencies must have been resolved.

This option is only active if enWorkloadServiceAssurance is set to yes.

The default is 120 seconds.

Note: Whatever value you set for this option, if HCL Workload Automation loses the connection with its database, the default value is applied to critical job processing, and the warning message AWSJCO135W is issued to tell you what has happened.

Run JnextPlan or restart WebSphere Application Server Liberty (stopappserver and startappserver) to make this change effective.

auditHistory | ah

Audit history period. Used in audit management. This setting applies only when the auditStore option is set to db. Enter the number of days for which you want to save audit record data. Audit records are discarded on a FIFO (first-in first-out) basis.

The default value is 400 days. This option takes effect immediately.

For more information about auditing, see Auditing facilities.

auditStore | as

Type of store to be used to log database and plan audit records. Enter one of the following:

file: To specify that a flat file in the <install_dir>/TWS/audit/database directory on the master domain manager and backup master domain manager is used to store the audit records.
db: To specify that the HCL Workload Automation database itself is used to store the audit records.
both: To have audit records logged in both the file and the database.

The default value is both. Any change of this value is effective immediately.

Note: When you upgrade the master domain manager from a previous release, the default value for this global option is changed. The default value is now both. The reason for this change is to support the auditing feature which introduces reporting, versioning and rollback functions for database objects. If you customized the default value in the previous release, the value is overwritten with the new value with the exception of the auditStore option with the DB value assigned. If the auditStore option was set to DB, this value is maintained and is not overwritten.

For more information about auditing, see Auditing facilities.

baseRecPrompt | bp

Maximum prompts after abend. Specify the maximum number of prompts that can be displayed to the operator after a job abends.

The default value is 1000. Run JnextPlan to make this change effective.

bindUser | bu

User for binding to remote jobs from shadow job. Specify the user ID that is used to bind a shadow job to a remote job during the security check for "cross dependencies". This user must be given at least the following authorizations in the security file:

Display access to the job and schedule objects that need to be bound
List access to job objects that need to be bound

However, the ID does not need to be in the user registry of the engine, nor have a password, as it is only required for authorization purposes.

The default value is the TWS_user. Any change of this value is effective immediately.

carryStates | cs

Carry job states. A preproduction option that affects the operation of the stageman command. Specify the jobs, by state, to be included in job streams that are carried forward. Enclose the job states in parentheses, double quotation marks, or single quotation marks. Commas can be replaced by spaces. The valid internal job states are as follows:

Table 1. Valid internal job states
abend	abenp	add	bound	done	error	exec
fail	hold	intro	pend	ready	rjob	sched
skel	succ	succp	suppr	susp	wait	waitd

Some examples of the option are as follows:

carryStates="abend,exec,hold,intro"
carryStates='abend,exec,hold,intro'
carryStates="abend, exec, hold, intro"
carryStates='abend, exec, hold, intro'

An empty list is entered as follows:

carryStates=null

The default value is null, which corresponds to selecting all states. Run JnextPlan to make this change effective.

companyName | cn

Company name. Specify the name of your company. The maximum length is 40 bytes. If the name contains spaces, enclose the name in double quotation marks ("). If you use the Japanese-Katakana language set, enclose the name within single or double quotation marks.

Run JnextPlan to make this change effective.

deadlineOffset | do

Deadline offset. Used in workload service assurance. Used to calculate the critical start of a critical job in the case where a deadline has not been specified neither for the job nor its job stream. In this case the deadline is defaulted to the plan end date and time, plus this offset, expressed in minutes.

This option is only active if enWorkloadServiceAssurance is set to yes.

The default is 2 minutes.

Note:

Important: When the plan is extended, the start time of critical jobs with a deadline calculated with this mechanism is automatically changed as a consequence of the fact that it must now match the new plan finishing time.
Whatever value you set for this option, if HCL Workload Automation loses the connection with its database, the default value is applied to critical job processing, and the warning message AWSJCO135W is issued to tell you what has happened.

Run JnextPlan or restart WebSphere Application Server Liberty (stopappserver and startappserver) to make this change effective.

defaultWksLicenseType / wn

Specify the default licensing model for HCL Workload Automation workstations. This option is supported only if the licenseType option is set to byWorkstation and a specific value was not specified at creation time for each workstation. For more information, see licenseType | ln. Supported values are as follows:

perServer: to specify the HCL Workload Automation Processor Value Unit (PVU) pricing.
perJob: to specify the HCL Workload Automation Per Job (PJ) pricing.

The default value varies, depending on the environment type:

In a Docker environment: By default, the defaultWksLicenseType option is set to perJob in a fresh installation and to perServer during product upgrade. By default, the licenseType option is set to byWorkstation in a fresh installation. This setting is not modified during product upgrade. As a result, the value of the defaultWksLicenseType option is applied to the creation of all workstation types.
In an on-premises environment: By default, the licenseType option is set to perServer, and also defaultWksLicenseType option is set to perServer. Before changing this value, contact your sales representative.

deploymentFrequency | df

Rules deployment frequency. Used in event rule management. Specify the frequency, in minutes, with which rules are to be checked to detect if there are changes to deploy. All active rules (active rules have the isDraft property set to no in their definition) that have been changed or added since the last deployment are deployed.

Valid values are in the 0-60 minutes range. If you specify 0, the changes are not deployed automatically and you must use the planman deploy command.

The default value is 5 minutes. The change is effective immediately.

enAddUser | au

Enable the automatic user addition into the Symphony file. This option enables the automatic addition of a user into the Symphony file after you create or modify the user in the database. If you specify "yes", the user is automatically added to the Plan. If you specify "no", the user is not automatically added to the Plan.

The default value is "yes". Changes to this parameter are effective immediately.

For more information about how to use this feature, see "HCL Workload Automation: User's Guide and Reference".

enAddWorkstation | aw

Enable the automatic dynamic agent, pool, and dynamic pool workstation addition into the Symphony file. This option enables the automatic addition of a dynamic agent, pool, or dynamic pool workstation into the Symphony file after you created the workstation in the database. If you specify "yes", the workstation is automatically added to the Plan. If you specify "no", the workstation is not automatically added to the Plan.

The default is "no". Changes to this parameter are effective immediately.

For more information about how to use this feature, see HCL Workload Automation: User's Guide and Reference.

enAutomaticFailover | af

Enable or disable the automatic failover feature. This option enables or disables the automatic failover feature which invokes an automatic switch from the master domain manager, event manager, or both, to a backup workstation. Eligible backups for both the master domain manager and the event manager can be specified using the optman options, workstationMasterListInAutomaticFailover and workstationEventMgrListInAutomaticFailover, respectively. For more information about this feature, see Automatic failover.

A fresh installation of HCL Workload Automation V9.5FP2 or later enables this feature by default (yes). This feature is disabled (no) when you upgrade to HCL Workload Automation V9.5FP2 or later. Changes to this parameter require restarting WebSphere Application Server Liberty.

enAutomaticFailoverActions | aa

Enable or disable the automatic failover actions. This option enables or disables automatic failover actions, such as, the automatic switch of the master or the automatic restart of the fault-tolerant agent. This option takes effect only if the enAutomaticFailover option is set to yes. You can set this option to no in the case of a planned maintenance window.

By default, this option is set to yes. Changes to this parameter require restarting WebSphere Application Server Liberty.

workstationMasterListInAutomaticFailover | wm

A list of workstations eligible to serve as a backup for the master. A comma-separated list of workstations that serve as backups for the master domain manager, including the current master domain manager itself, when the automatic failover feature (enAutomaticFailover) is enabled. The maximum length is 256 bytes. If an eligible workstation is defined in a folder, use the composer li ws @;showid command to retrieve the ID of the workstation you plan to define as backup.

If no workstations are specified in this list, then all backup master domain managers in the domain are considered eligible backups. Changes to this parameter require restarting WebSphere Application Server Liberty.

workstationEventMgrListInAutomaticFailover | we

A list of workstations eligible to serve as a backup for the event manager. A comma-separated list of workstations that serve as backups for the event manager, including the current event manager itself, when the automatic failover feature is enabled. The maximum length is 256 bytes. If an eligible workstation is defined in a folder, use the composer li ws @;showid command to retrieve the ID of the workstation you plan to define as backup.

If no workstations are specified in this list, then all backup master domain managers in the domain are eligible backups. Changes to this parameter require restarting WebSphere Application Server Liberty.

enCarryForward | cf

Enable carry forward. A preproduction option that affects the operation of the stageman command. Specify if job streams that did not complete are carried forward from the old to the new production plan (Symphony). Enter yes to have incompleted job streams carried forward only if the Carry Forward option is enabled in the Job Scheduler definition. Enter all to have all incompleted job streams carried forward, regardless of the Carry Forward option. Enter no to completely disable the Carry Forward function. If you run the JnextPlan -for 0000 command and the Carry Forward option is set to either yes or no, a message is displayed informing you that incompleted job streams might not be carried forward. When the stageman -carryforward command is used, it overrides enCarryForward. See HCL Workload Automation: User's Guide and Reference for more information. If this option is set to no, running jobs are moved to the USERJOBS job stream.

The default value is all. Run JnextPlan to make this change effective.

enCentSec | ts

Enable centralized security. In the classic security model, determine, how the security file is used within the network. Centralized security is not relevant to an end-to-end scheduling environment.

If set to yes, the security files of all the workstations of the network can be created and modified only on the master domain manager. In this case, the HCL Workload Automation administrator is responsible for their production, maintenance, and distribution.

If set to no, the security file of each workstation can be managed by the root user or administrator of the system. The local user can run the makesec command to create or update the file.

See Centralized security management for more information about centralized security.

The default value is no. Run JnextPlan to make this change effective.

Note: This option does not apply to role-based security model.

enCFinterNetworkDeps | ci

Enable carry forward for internetwork dependencies. A preproduction option that affects the way stageman handles internetwork dependencies. It specifies if external job streams are carried forward from the old to the new production plan (Symphony file). Enter yes to have all external job streams carried forward. Enter no to have no external job streams carried forward.

The default value is yes. Run JnextPlan to make this change effective.

enCFResourceQuantity | rq

Enable carry forward resource quantity. A preproduction option that affects the way stageman handles resources. Enter yes to carry forward the resource quantity from the old production file to the new. Enter no to not carry forward the resource quantity. Stageman carries forward resource quantities only if the resource is needed by a job or job stream that is also being carried forward. Otherwise the resource quantities are set to the original value. See HCL Workload Automation: User's Guide and Reference for details on using this feature.

The default value is yes. Run JnextPlan to make this change effective.

enDbAudit | da

Enable auditing on information available in the database. Enable or disable auditing on information available in the database. To enable auditing on information available in the database, specify 1. To disable auditing on information available in the database, specify 0. Auditing information is logged to a flat file in the TWA_home/TWS/audit/database directory, to the HCL Workload Automation database itself, or to both. To choose which, set the optman property auditStore. Each HCL Workload Automation workstation maintains its own log. Only actions are logged, not the success or failure of the action. Installation of dynamic domain managers and agents is not recorded in audit logs.

The default value is 1. Changes to this parameter are effective immediately.

Note: When you upgrade the master domain manager from a previous release, the default value for this global option is changed. The default value is now 1. The reason for this change is to support the auditing feature which introduces reporting, versioning and rollback functions for database objects. If you customized the default value in the previous release, the value is overwritten with the new value.

For more information about auditing, see Auditing facilities.

enDbGetOpsAudit

Enable auditing of GET database operations. Enable or disable auditing on database GET operations. Disabling this auditing feature might improve performance. All other database operations are not affected. To disable auditing on database GET operations, specify 0. To enable auditing on database GET operations, specify 1. This parameter is effective only if general database audit is enabled. enDbAudit=1).

The default value is 1. Changes to this parameter are effective immediately.

enEmptySchedsAreSucc | es

Job streams without jobs policy. Specify the behavior of job streams without any jobs. If set to yes, the job streams that contain no jobs are set to SUCC after their dependencies are resolved. If set to no, the job streams are left in READY status.

The default value is no. Run JnextPlan to make this change effective.

enEventDrivenWorkloadAutomation | ed

Enable event-driven workload automation. Enable or disable the event-driven workload automation feature. To enable, specify yes. To disable, specify no.

The default value is yes.

After disabling, you must run JnextPlan and stop the event processing server (with the conman stopevtp command).

After enabling, you must run JnextPlan and start the event processing server (with the conman startevtp command).

enEventDrivenWorkloadAutomationProxy | pr

Enable event-driven workload automation proxy. Enable or disable the event-driven workload automation proxy feature. To enable, specify yes. To disable, specify no.

The default value is no. Run JnextPlan to make this change effective.

enEventProcessorHttpsProtocol | eh

Enable event processor HTTPS protocol. Used in event rule management. Enables or disables the use of the HTTPS protocol to connect to the event processor server. To enable, enter yes. To disable, enter no.

The default value is yes. Run JnextPlan to make this change effective.

enExpandedResources

Enables up to 60 concurrent holders for an HCL Workload Automation resource. Enter yes to enable up to 60 concurrent holders for a resource. Enter no to disable the feature and use only 32 holders for a resource.

The default value is yes. Run JnextPlan to make this change effective.

enForecastStartTime | st

Enable forecast start time. Only applicable when workload service assurance is enabled (see enWorkloadServiceAssurance). Enter yes to enable the calculation of the predicted start time of each job when running a forecast plan: this option is recommended if you want to take advantage of the enhanced forecast capability that calculates the start time of each job considering the estimated duration of its predecessor jobs. Enabling this feature could negatively impact the time taken to generate the forecast plan. Enter no to disable the calculation of the predicted start time of each job when running a forecast plan.

The default value is no. Any change of this value is effective immediately.

When this option is set to yes, the enPreventStart global option is ignored during the creation of forecast plans.

enLegacyStartOfDayEvaluation | le

Evaluate start-of-day. Specify how the startOfDay option is to be managed across the HCL Workload Automation network. This is a legacy setting and should always be set to no starting from release 9.4.0 and later. If you set this option to yes, the startOfDay value on the master domain manager is converted to the local time zone set on each workstation across the network. If you set this option to no, the startOfDay value on the master domain manager is applied as is on each workstation across the network. This option requires that the enTimeZone option is set to yes to become operational.

The default value is no. Run JnextPlan to make this change effective.

enListSecChk | sc

Enable list security check. Control the objects in the database and the plan that a user is permitted to list when running a query on the Dynamic Workload Console or HCL Workload Automation database, for example running a composer list, or a conman show command. If set to yes, objects in the plan returned from a query or show command are shown to the user only if the user has been granted the list permission in the security file. If set to no, all objects are shown, regardless of the settings in the security file.

Note: Setting this option to yes affects how the graphical user interfaces function for the users defined in the security file.

The default value is no. Run JnextPlan to make this change effective for the plan. For the database, this option takes immediate effect.

enLogonBatch | lb

Automatically grant logon as batch. This is for Windows® jobs only. If set to yes, the logon users for Windows® jobs are automatically granted the right to Logon as batch job. If set to no, or omitted, the right must be granted manually to each user or group. The right cannot be granted automatically for users running jobs on a backup domain manager, so you must grant those rights manually.

The default value is no. Run JnextPlan to make this change effective.

enPlanAudit | pa

Enable plan auditing. Enable or disable auditing on information available in the plan. To enable auditing on information available in the plan, specify 1. To disable auditing on information available in the plan, specify 0. Auditing information is logged to a flat file, to the HCL Workload Automation database itself, or to both. To define the logging location, set the auditStore global option. For more information, see auditStore | as. The audit file is located in the following path on the master domain manager and backup master domain manager:

: TWA_home\TWS\audit\database
: TWA_DATA_DIR/audit/database

For the plan, only actions are logged in the auditing file, not the success or failure of any action.

For more information about auditing, see Auditing facilities.

The default value is 1. Changes to this parameter are effective immediately.

enPreventStart | ps

Prevent job stream without "at" dependency from starting. Specify if job streams without an at dependency are to be prevented from starting immediately, without waiting for the beginning of the day the run cycle specified in the Job Scheduler identifies. Valid values are yes and no.

The default value is yes. Run JnextPlan to make this change effective.

When the enForecastStartTime option is set to yes, this option is ignored during the creation of forecast plans.

enRetainNameOnRerunFrom | rr

Retain rerun job name. A production option that affects the operation of Batchman, the production control process of HCL Workload Automation. Its setting determines if jobs that are rerun with the Conman rerun command retain their original job names. To have rerun jobs retain their original job names, enter yes. Enter no to assign the rerun from name to rerun jobs.

The default value is no. Run JnextPlan to make this change effective.

Note: Starting from version 10.1, this option is deprecated and must not be modified. By default, its value is set to no.

enRoleBasedSecurityFileCreation | rs

Enable the role-based security model. This option enables the automatic creation of the security file using the role-based security model. You define the role-based security model in the master domain manager database by using the Manage Workload Security interface from Dynamic Workload Console or the composer command-line program.

The default value is yes, which means that the role-based security model is enabled for your installation.

At any time, specify no if you want to disable the role-based security model and replace your current security file. You can then continue to use the classic security model, that allows you to update your security file by using dumpsec and makesec commands from the command line.

For more information about user authorization and classic and role-based security models, Configuring user authorization (Security file).

Changes to this parameter are effective immediately.

enSecFileExtendedFields

Enable extended fields support in the security file. Enable long attribute values for all scheduling objects in the security file. When this option is enabled, it permits the use of the extended version of the security file with the attribute field value length set to 64K rather then 255 bytes.

The default value is no. This change becomes effective the first time you edit a security object.

enSSLFullConnection | sf

Enable the SSL full connection. Specify that HCL Workload Automation uses a higher level of SSL connection than the standard level. For full details see Configuring full SSL security. Valid values are yes to enable the SSL full connection or no to disable the SSL full connection.

The default value is no. Run JnextPlan to make this change effective.

enStartCondSuccOnDeadline | od

Prevent job streams from completing in error when the start condition is not met Specify the behavior of the job stream when the start condition is not met and the Start once option is not selected. If you set the Start once option, this option is ignored. If you set the option to yes, when the deadline for the start condition is met, the monitoring job is confirmed in Successful status and the job stream is canceled. If you set the option to no, the monitoring job is killed, so both the monitoring job and the job stream change to Error status.

The default value is yes in a fresh installation and no in upgrade to maintain compatibility with previous versions. Run JnextPlan to make this change effective.

enStrEncrypt | se

Enable strong password encryption. Enable or disable strong encryption. Enable strong encryption by setting this option to yes. See Configuring the SSL connection protocol for the network.

The default value is no. Run JnextPlan to make this change effective.

enSwfaultTol | sw

Enable the fault-tolerant switch manager. Enable or disable the fault-tolerant switch manager feature. Valid values are yes to enable the fault tolerant switch manager, and no to disable it. This option has not dynamic capabilities and is not designed to work with broker agents. It applies to fault-tolerant agents. See the HCL Workload Automation: User's Guide and Reference for more details.

The default value is no. Run JnextPlan to make this change effective.

Note: Starting from version 10.1, this option is deprecated and must not be modified. By default, its value is set to no.

enTimeZone | tz

Enable time zones. Enables the time zone option.

Note: Starting from version 10.1, this option is deprecated and must not be modified. By default, its value is set to yes.

enWhatIfAnalysis | wi

Enable What-if Analysis. Enables or disables What-if Analysis, which is the feature that shows plan activities displayed against time and give you a visual representation of your plan at a glance in real time. To enable What-if Analysis, specify yes. To disable What-if Analysis, specify no. See Dynamic Workload Console User's Guide for details on using this feature..

The default value is yes. Run JnextPlan to make this change effective.

enWorkloadServiceAssurance | wa

Enable workload service assurance. Enables or disables workload service assurance, which is the feature that manages the privileged processing of mission critical jobs and their predecessors. Specify yes to enable or no to disable.

Note: Before starting to use workload service assurance you must set up the TWS_user in the security file to have the appropriate access to the objects that this feature will modify - see The TWS_user - special security file considerations

The default value is yes. Run JnextPlan to make this change effective.

eventProcessorEIFSslPort | ef

Tivoli® event integration facility port.Used in event rule management. Specify the port number for SSL where the event processor server receives events from the Tivoli® Event Integration Facility (EIF). Valid values are in the 0-65535 range.

The default value is 31131. If you change the value, restart WebSphere Application Server Liberty (stopappserver and startappserver) and run JnextPlan to make this change effective.

eventProcessorEIFPort | ee

Tivoli® event integration facility port. Used in event rule management. Specify the port number where the event processor server receives events from the Tivoli® Event Integration Facility (EIF). Valid values are in the 0-65535 range.

The default value is 31131. If you change the value, restart WebSphere Application Server Liberty (stopappserver and startappserver) and run JnextPlan to make this change effective.

If you use a security firewall, make sure this port is open for incoming and outgoing connections.

extRecPrompt | xp

Additional prompts after abend. Specify an additional number of prompts for the value defined in baseRecPropmt. This applies when a job is rerun after abending and the limit specified in baseRecPropmt has been reached.

The default value is 1000. Run JnextPlan to make this change effective.

fileStartConditionJobName | fc

Name of the job in charge of running the file monitoring task . Applicable only if you select file as the start condition type. Specify the name of the job which is automatically added to the plan to run the file monitoring task. This value is used by default if you do not specify any value for the job name when defining the start condition. If you specify a value for the job name, this value is ignored.

The default value is FILE_STARTCOND. The maximum supported length is 40 bytes. Changes to this parameter are effective immediately.

folderDays | fd

Remove deleted folders, prompts, resources, and workstations from the database. When deleting a folder, a prompt, or resource, if there are still objects in the plan that reference these objects, then another folder, prompt, or resource cannot be renamed with the name of the deleted folder, prompt or resource for the number of days specified by “folderDays?. However, a brand new folder, prompt, or resource can be created with the name of the deleted object.

When deleting a workstation, if the workstation is still in the plan, then another workstation cannot be renamed with the name of the deleted workstation for the number of days specified by the global option folderDays. However, a brand new workstation can be created with the name of the deleted workstation. This behavior applies only to dynamic agents, pools, and dynamic pools.

The default value is 10 days.

ignoreCals | ic

Ignore calendars. A preproduction option that affects the operation of the planman command. Its setting determines if user calendars are copied into the new production plan (Symphony) file. To prevent user calendars from being copied into the new production plan, enter yes.

The default value is no. See HCL Workload Automation: User's Guide and Reference. Run JnextPlan to make this change effective.

Note: Starting from version 10.1, this option is deprecated and must not be modified. By default, its value is set to yes.

licenseType | ln

Type of accepted license for HCL Workload Automation.

Supported values are:

ws
perServer: This value is ignored in HCL Workload Automation.
wa
perJob: to specify the HCL Workload Automation Per Job (PJ) pricing.
byWorkstation: This value is ignored in HCL Workload Automation.

The default value is perJob. Run JnextPlan to make this change effective. For additional information about license management and metrics, see Per Job license model.

You can define this option for the following workstation types:

master domain manager
fault-tolerant agent
standard agent
dynamic agent

licenseProxyPassword | pw: License Proxy Password The password of the proxy server which HCL Workload Automation is expected to contact. This option is required if you are using a proxy server protected by a user name and password.
The default value is null because it must be specified by the user. This option takes effect immediately.

licenseProxyServer | lp: IP of the proxy server The IP of the proxy server which HCL Workload Automation is expected to contact. This option is required if you are using a proxy server.
The default value is null because it must be specified by the user. This option takes effect immediately.

licenseProxyServerPort | lo: Port of the proxy server The port of the proxy server the master domain manager uses to connect to the Internet. This option is required if you are using a proxy server.
The default value is null because it must be specified by the user. This option takes effect immediately.

licenseProxyUser | pb: User of the proxy server The user of the proxy server the master domain manager uses to connect to the Internet. This option is required if you are using a proxy server protected by a user name and password.
The default value is null because it must be specified by the user. This option takes effect immediately.

licenseServerId | lr: License server ID The ID of the license server which processes license usage information. When you buy HCL Workload Automation, license usage is calculated based on the number of successful jobs you run and the related information is processed on the server you specify in this option. Instructions about how to install and configure the license server which processes license usage information are provided in What is the HCL License & Delivery Portal (FlexNet Portal)?.
The default value is null because it must be specified by the user. This option takes effect immediately.

licenseServerUrl | lu: License server URL The URL of the license server which processes license usage information. When you buy HCL Workload Automation, license usage is calculated based on the number of successful jobs you run and the related information is processed on the server you specify in this option. The default value is https://hclsoftware.compliance.flexnetoperations.com/.
This option takes effect immediately.

logCleanupFrequency | lc

Log cleanup frequency. Used in event rule and audit management . Specify how often the automatic cleanup of log instances is run. Valid values are in the 0-60 minutes range. If you specify 0, the automatic cleanup feature is disabled.

The default value is 5 minutes. This option takes effect immediately.

logHistory | lh

Log history period. Used in event rule management. Enter the number of days for which you want to save rule instance, action run, and message log data. Log instances are discarded on a FIFO (first-in first-out) basis.

The default value is 10 days. This option takes effect immediately.

logmanMinMaxPolicy | lm

Logman minimum and maximum run times policy. Specify how the minimum and maximum job run times are logged and reported by logman. Possible values are:

elapsedtime: The minimum and maximum elapsed runtimes are logged and reported.
cputime: The minimum and maximum CPU run times are logged and reported.
both: Both the minimum and maximum job runtimes are logged and reported.

See HCL Workload Automation: User's Guide and Reference for details on using this feature.

The default value is both. Run JnextPlan to make this change effective.

logmanSmoothPolicy | lt

Logman normal run time calculation policy. Set the weighting factor that favors the most recent job run when calculating the normal (average) run time for a job. This is expressed as a percentage. For example, specify 40 to apply a weighting factor of 40% to the most recent job run, and 60% to the existing average. See HCL Workload Automation: User's Guide and Reference for more information about how to use this option.

The default value is 10. Run JnextPlan to make this change effective.

longDurationThreshold | ld

Long duration job threshold. Specify, when comparing the actual duration of a job to the estimated duration, the threshold over which the job is considered to be of "long duration." The threshold value is expressed as a percentage with respect to the estimated duration. For example, if the threshold is set to 150, and the actual duration is more than 150% of the estimated duration (it is 50% greater), the job is considered to be a "long duration" job.

If you have the workload service assurance feature enabled, the effect of a "critical" job satisfying the long duration criteria is that the job is inserted automatically into the hot list.

Valid values are between:

100: The minimum value. All jobs that exceed the estimated duration are considered long duration jobs
1000: The maximum value. Only those jobs that last ten times as long as their estimated duration are considered as long duration jobs

The default is 150.

Note: Whatever value you set for this option, if you have the workload service assurance feature enabled, and HCL Workload Automation loses the connection with its database, the default value is applied to critical job processing, and the warning message AWSJCO135W is issued to tell you what has happened.

Run JnextPlan or restart WebSphere Application Server Liberty (stopappserver and startappserver) to make this change effective.

mailSenderName | ms

Mail sender name. Used in event rule management. If you deploy rules implementing an action that sends emails via an SMTP server, specify a string to be used as the sender of the emails.

The default value is TWS. Changes to this parameter are effective for the next mail send action performed.

maxLen | xl

Maximum preproduction plan length. Specify the maximum length of the preproduction plan in days after it is automatically extended or created. The value for maxLen must be greater than or equal to the value for minLen and must be in the range of 8 to 365.

The default is 14 days. Run JnextPlan to make this change effective.

minLen | ml

Minimum preproduction plan length. Specify the minimum length in days of the preproduction plan that can pass after the production plan is created or extended, without extending the preproduction plan. If the days left in the preproduction plan after a JnextPlan are less than the value of this option, the preproduction plan is automatically extended. The value for minLen must be less than or equal to the value for maxLen and must be in the range of 7 to 365.

The default is 8 days. Run JnextPlan to make this change effective.

notificationTimeout | nt

Notification timeout. Used in cross dependencies. Specify how many days HCL Workload Automation must retry sending notifications about job status changes to the remote engine if the notification fails. When this timeout expires, the job request subscription and the status notifications associated to this job are discarded.

Valid values are in the range of 1 to 90. The default is 5 days. Changes to this parameter are effective immediately.

promotionOffset | po

Promotion offset. Used in workload service assurance. Specify when a job become eligible for promotion in terms of the number of seconds before its critical start time is reached. Applies only to jobs that are flagged as critical in a job stream definition and to their predecessor jobs. A critical job and its predecessors make up a critical network.

When a predecessor jeopardizes the timely completion of the critical job, it is promoted; that is, it is assigned additional resources and its submission is prioritized with respect to other jobs that are out of the critical network. Also critical jobs might be promoted.

The scheduler calculates the critical start time of a critical job by subtracting its estimated duration from its deadline. It calculates the critical start time of a critical predecessor by subtracting its estimated duration from the critical start time of its next successor. Within a critical network the scheduler calculates the critical start time of the critical job first and then works backwards along the chain of predecessors. These calculations are reiterated as many times as necessary until the critical job has run.

This option is only active if enWorkloadServiceAssurance is set to yes.

The default is 120 seconds.

Run JnextPlan to make this change effective.

resubmitJobName | rj

Name of the job in charge of resubmitting the job stream. Specify the name of the Job Stream Submission job which is automatically added to the plan to resubmit a new instance of the job stream where the start condition is defined.

The default value is MASTERAGENTS#restart_StartCond, where MASTERAGENTS is the name of the pool workstation on which the Job Stream Submission job runs. The maximum length for the workstation name is 16 bytes, and the maximum length for the job name is 40 bytes. Changes to this parameter are effective immediately.

resubmitJobUserName | rw

Name of the user in charge of resubmitting the job stream. Specify the user name which owns the Job Stream Submission job. The Job Stream Submission job is automatically added to the plan to resubmit a new instance of the job stream where the start condition is defined.

The default value is TWS_User. Changes to this parameter are effective immediately. If the user defined in the resubmitJobUserName property does not exist, the user name and password defined on WebSphere Application Server Liberty installed on the master domain manager or backup master domain manager are used. This implies that the user defined in the resubmitJobUserName property must be the same both on the master domain manager and on the backup master domain manager, or must be changed immediately after switching the master domain manager.

riskConfidence | rc

Critical Jobs Risk Confidence Specifies when a critical job must be set as High Risk, comparing the confidence factor of completing before deadline and the percentage specified in this parameter. If the probability of completing before the deadline is below riskConfidence, then the critical job is considered at high risk. Valid values are in the range 1-99. The default value is 80% when you perform a fresh installation. If you upgrade a previous version to the current version, the default value is 50% for maintaining backward compatibility. This option is effective immediately.

servicenowUrl | nu

ServiceNow URL. Used in event rule management. If you use rules that implement an action that opens an incident in ServiceNow (or any other application that can open an incident in the ServiceNow format), specify the ServiceNow URL. You can change this value when you define the action if you want to use a different ServiceNow URL.

The default value is "http://localhost:8080/api/now/v1/table/incident". Changes to this parameter are effective immediately.

servicenowUserName | nn

ServiceNow user name. Used in event rule management. If you use rules that implement an action that opens an incident in ServiceNow, specify the identifier of the user connecting to the ServiceNow server.

The default value is the HCL Workload Automation user on the master domain manager. Changes to this parameter are effective immediately.

servicenowUserPassword| np

ServiceNow user password. Used in event rule management. If you use rules that implement an action that opens an incident in ServiceNow, specify the password associated with the user connecting to the ServiceNow server.

Changes to this parameter are effective immediately.

smtpServerName | sn

SMTP server name. Used in event rule management. If you deploy rules implementing an action that sends emails via an SMTP server, specify the name of the SMTP server to be used by the mail plug-in.

The default value is localhost. Changes to this parameter are effective immediately.

smtpServerPort | sp

SMTP Server port. Used in event rule management. If you deploy rules implementing an action that sends emails via an SMTP server, specify the port number used to connect to the SMTP server by the mail plug-in. Valid values are in the range 0–65535.

The default value is 25. Changes to this parameter are effective for the next mail send action performed.

smtpUseAuthentication | ua

Mail plug-in uses SMTP authentication. Used in event rule management. If you deploy rules implementing an action that sends emails via an SMTP server, specify if the SMTP connection needs to be authenticated. Values are yes or no.

The default is no. Changes to this parameter are effective immediately.

smtpUserName | un

SMTP server user name. Used in event rule management. If you deploy rules implementing an action that sends emails via an SMTP server, specify the SMTP server user name.

The default value is the name of the HCL Workload Automation user (the TWS_user) on the master domain manager. Changes to this parameter are effective immediately.

smtpUserPassword | up

SMTP server user password. Used in event rule management. If you deploy rules implementing an action that sends emails via an SMTP server, specify the SMTP server user password. The password is stored in an encrypted form.

Changes to this parameter are effective immediately.

smtpUseSSL | us

Mail plug-in uses SSL. Used in event rule management. If you deploy rules implementing an action that sends emails via an SMTP server, specify if the SMTP connection is to be authenticated via SSL. Values are yes or no.

The default is no. Changes to this parameter are effective immediately.

smtpUseTLS | tl

Mail plug-in uses TLS protocol. Used in event rule management. If you deploy rules implementing an action that sends emails via an SMTP server, specify if the SMTP connection is to be authenticated via the Transport Layer Security (TLS) protocol. Values are yes or no.

The default is no. Changes to this parameter are effective immediately.

startOfDay | sd

Start time of processing day. Specify the start time of the HCL Workload Automation processing day in 24-hour format: hhmm (0000-2359).

The default value is 0000 (0:00 a.m.), but if you upgraded your environment to version 10.2.2 starting from a version earlier than version 8.6, the default value is 0600 (6:00 a.m.). If you change this option, you must also change the launch time of the final Job Scheduler, which is usually set to one minute before the start time. Run JnextPlan to make the change of startOfDay effective.

If you need to modify in a production environment the start of day and the FINAL job stream launch time, run the following command twice:

JnextPlan -to newDay newSoD TZ customerTimezone

For example, if your timezone is America/New_York and on the 30th of August you want to modify the start of day from 0000 to 0400, perform the following steps:

Modify the startOfDay global option using optman:
```
optman chg sd=0400
```
Modify the FINAL job stream launch modifying the at keyword from 2359 to 0359.

Run the following command twice:

JnextPlan -to 08/31/2022 0400 tz America/New_York

statsHistory | sh

Job statistics history period. Specify the number of days for which you want to maintain job statistics. Statistics are discarded on a FIFO (first-in first-out) basis. For example, if you leave the default value of 400, statistics are maintained for the last 400 days. This has no effect on job standard list files, which must be removed with the rmstdlist command. See the HCL Workload Automation: User's Guide and Reference for information about the rmstdlist command.

The default value is 400. Run JnextPlan to make this change effective in the plan. For the database, this option takes effect immediately.

startConditionDeadlineOffset | cd

Start condition deadline offset. The default offset set for the start condition deadline in 24 hour format: "hhmm" (0001-9959). Specify the time range during which the start condition is active.

The default value is 2400 and the range is 0001 - 9959. Changes to this parameter are effective immediately.

untilDays | ud

Remove obsolete job and job stream instances from the plan. If an until time (latest start time) has not been specified for a job or job stream, then the default until time is calculated adding the value of this option, expressed in number of days, to the scheduled time of the job or job stream. If the enCarryForward option is set to all, and the number of days specified for untilDays is reached, then any job or job stream instance in the plan that ended in error is automatically removed from the plan and not added to the new production plan.

The default value is 0. If the default value is used, then for jobs, no default time is set for the until time (latest start time) . For job streams, if the default is used, then the default until time is 2 days.

Run JnextPlan to make this change effective.

workstationLimit | wl

The workstation limit.

Used in the automatic dynamic agent registration. This parameter specifies the dynamic agent workstation limit value that the dynamic agent workstation assumes after the workstation is added to the plan. You can later modify the dynamic agent workstation limit value by using the conman command line or the Dynamic Workload Console.

Valid values are in the 0-1024 range.

The default is 100. Changes to this parameter are effective immediately.

zOSRemoteServerName | zr

HCL Workload Automation for Z connector remote server name. Used in event rule management. If you deploy rules implementing an action that submits job streams to the HCL Workload Automation for Z controller, enter the name of the controller specified as the engine to the Z connector. It must exactly match the Z connector engine name and is case sensitive.

After changing the value of this parameter, the change becomes effective when the next submit action is run.

zOSServerName | zs

HCL Workload Automation for Z connector server name. Used in event rule management. If you deploy rules implementing an action that submits job streams to the HCL Workload Automation for Z controller, specify the name or the hostname of the system where the HCL Workload Automation for Z connector runs. The default value is localhost.

After changing the value of this parameter, the change becomes effective when the next submit action is run.

zOSServerPort | zp

HCL Workload Automation for Z connector server port. Used in event rule management. If you deploy rules implementing an action that submits job streams to the HCL Workload Automation for Z controller, specify the bootstrap port number of the HCL Workload Automation for Z connector server. Valid values are in the range 0-65535. The default value is 31217.

After changing the value of this parameter, the change becomes effective when the next submit action is run.

zOSUserName | zu

HCL Workload Automation for Z connector user name. Used in event rule management. If you deploy rules implementing an action that submits job streams to the HCL Workload Automation for Z controller, specify the HCL Workload Automation for Z connector user name required to access the HCL Workload Automation for Z engine.

After changing the value of this parameter, the change becomes effective when the next submit action is run.

zOSUserPassword | zw

HCL Workload Automation for Z connector user password. Used in event rule management. If you deploy rules implementing an action that submits job streams to the HCL Workload Automation for Z controller, specify the HCL Workload Automation for Z connector user password required to access the HCL Workload Automation for Z engine. The password is stored in encrypted form.

After changing the value of this parameter, the change becomes effective when the next submit action is run.