HCL Workload Automation, Version 9.4

Customizing plan management using global options

About this task

You can customize some criteria for HCL Workload Automation to use when managing plans by setting specific options on the master domain manager using the optman command-line program. You need to generate the plan again to activate the new settings. The options you can customize are:
Properties impacting the generation of the preproduction plan:
minLen
It is the minimum length, calculated in days, of the preproduction plan which is left, as a buffer, after the end of the newly generated production plan. The value assigned to this option is used when the script UpdateStats is run from within JnextPlan. The value can be from 7 to 365 days. The default is 8 days.
maxLen
It is the maximum length, calculated in days, of the preproduction plan which is left, as a buffer, after the end of the newly generated production plan. The value can be from 8 to 365 days. The default is 14 days.

If the values of minLen and maxLen are equal, the preproduction plan is updated during the MakePlan phase. In general, the value of maxLen should exceed the value of minLen by at least 1 day, so that the preproduction plan can be updated during the UpdateStats phase.

Properties impacting the generation or extension of the production plan:
startOfDay
It represents the start time of the HCL Workload Automation processing day in 24-hour format: hhmm (0000-2359). The default setting is 0000.
enCarryForward
This is an option that affects how the stageman command carries forward job streams. Its setting determines whether or not job streams that did not complete are carried forward from the old to the new production plan. The available settings for enCarryForward are yes, no, and all. The default setting is all.
carryStates
This is an option that affects how the stageman command manages jobs in carried forward job streams. Its setting determines, based on their state, the jobs to be included in job streams that are carried forward. For example if : 
carryStates='abend exec hold'
then all jobs that are in states abend, exec, or hold are included in carried forward job streams. The default setting is: 
carryStates=null
that means that all jobs are included regardless of their states.
untilDays
If an until time (latest start time) has not been specified for a job stream, then the default until time is calculated adding the value of this option, expressed in number of days, to the scheduled time for the job stream. If the enCarryForward option is set to all, and the number of days specified for untilDays is reached, then any job stream instances in the plan that ended in error are 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 no default time is set for the until time (latest start time).
enCFInterNetworkDeps
This is an option that affects how the stageman command manages internetwork dependencies. Enter yes to have all EXTERNAL job streams carried forward. Enter no to completely disable the carry forward function for internetwork dependencies. The default setting is yes.
enCFResourceQuantity
This is an option that affects how the stageman command manages resources. When the production plan is extended, one of the following situations occurs:
  • A resource not used by any of the job streams carried forward from the previous production plan is referenced by new job or job stream instances added to the new production plan. In this case the quantity of the resource is obtained from the resource definition stored in the database.
  • A resource used by one or more job streams carried forward from the previous production plan is not referenced by job or job stream instances added to the new production plan. In this case the quantity of the resource is obtained from the old Symphony file.
  • A resource used by one or more job streams carried forward from the previous production plan is referenced by job or job stream instances added to the new production plan. In this case the quantity of the resource that is taken into account is based on the value assigned to the enCFResourceQuantity option:
    If enCFResourceQuantity is set to YES
    The quantity of the resource is obtained from the old Symphony file.
    If enCFResourceQuantity is set to NO
    The quantity of the resource is obtained from the resource definition stored in the database.
The default setting is yes.
enEmptySchedsAreSucc
This option rules the behavior of job streams that do not contain jobs. The available settings are:
yes
The jobs streams that do not contain jobs are marked as SUCC as their dependencies are resolved.
no
The jobs streams that do not contain jobs remain in READY state.
enPreventStart
This is an option to manage, for multiple day production plan, any job streams without an at time constraint set. It is used to prevent job stream instances not time dependent from starting all at once as the production plan is created or extended. The available settings are:
yes
A job stream cannot start before the startOfDay of the day specified in its scheduled time even if free from dependencies.
no
A job stream can start immediately as the production plan starts if all its dependencies are resolved.
enLegacyId
This is an option that affects how job streams are named in the plan. Its function is to keep consistency when identifying job streams in the plan in mixed environments with versions of IBMIBM® Workload Scheduler earlier than 8.3 managed by version 8.4 master domain managers. This option is not supported by the Self Service catalog, which ignores it even if its value is set to YES. The value assigned to this option is read either when the production plan is created or extended or when submitting job streams in production using conman. The available settings are:
yes
The jobstream_id of job stream named jobstream_name is set to jobstream_nameN where N is an incremental number assigned by an internal counter; it is set to null if only one instance of that job stream exists in the plan.

If the job stream named jobstream_name is then carried forward, its identifier is set to CFjobstream_nameN.

This setting is useful to keep consistency when managing job streams, even those carried forward, using conman when logged on an IBM Workload Scheduler 8.2.x agent in an IBM Workload Scheduler network with an 8.4 master domain manager.

In particular, if the production period is one day and no multiple instances of the same job stream are submitted, the compatibility with earlier versions, when managing job streams in production from an IBM Workload Scheduler version 8.2.x agent, is complete.

no
The job stream identifier jobstream_id is generated as described in showjobs. Carried forward job streams keep their original names and identifiers, and they report between braces {} the date when they were carried forward.
logmanSmoothPolicy
This is an option that affects how the logman command handles statistics and history. It sets 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. The default setting is 10.
logmanMinMaxPolicy
This option defines how the minimum and maximum job run times are logged and reported by logman. The available settings for the logmanMinMaxPolicy option are:
elapsedtime
The maximum and minimum run times and dates that are logged are based only on a job's elapsed time. Elapsed time, expressed in minutes, is greatly affected by system activity. It includes both the amount of time a job used the CPU and the time the job had to wait for other processes to release the CPU. In periods of high system activity, for example, a job might have a long elapsed time, and yet use no more CPU time than in periods of low system activity. The values are updated only if the latest job run has an elapsed time greater than the existing maximum, or less than the existing minimum.
cputime
The maximum and minimum run times and dates that are logged are based only on a job's CPU time. The CPU time is a measure, expressed in seconds, of the actual time a job used the CPU, and it does not include the intervals when the job was waiting. The values are updated only if the latest job run has a CPU time greater than the existing maximum, or less than the existing minimum.
both
The elapsed time and CPU time values are updated independently to indicate their maximum and minimum extremes, but the run dates correspond only to the elapsed time values. No record is kept, in this case, of the run dates for maximum and minimum CPU times.
The default setting is both.
enTimeZone
By setting the option you enable or disable the management of time zones across the HCL Workload Automation network. The available settings for the enTimeZone option are:
no
Disable time zone management. This means that the values assigned to all timezone keywords in the definitions are ignored.
yes
Enable time zone management. This means that the values assigned to the timezone settings are used to calculate the time when the jobs and jobs streams will run on the target workstations.

Refer toEnabling time zone management for more information about the enTimeZone variable.

enLegacyStartOfDayEvaluation
This option affects the way the startOfDay variable is managed across the HCL Workload Automation network. This option requires the enTimeZone variable set to yes to become operational. The available settings for the enLegacyStartOfDayEvaluation option are:
no
The value assigned to the startOfDay option on the master domain manager is not converted to the local time zone set on each workstation across the network.
yes
The value assigned to the startOfDay option on the master domain manager is converted to the local time zone set on each workstation across the network.

Refer to How HCL Workload Automation manages time zones for more information about the enLegacyStartOfDayEvaluation variable.

For information on how to set options using the optman command-line program, refer to the HCL Workload Automation Administration Guide.