OPCOPTS

Purpose

The OPCOPTS statement defines run-time options to HCL Workload Automation for Z. This statement is used by a tracker, controller, standby controller, or backup controller.

OPCOPTS is defined in the member of the EQQPARM library as specified by the PARM parameter in the JCL EXEC card of the controller and tracker started-task procedures. If no PARM parameter is specified on the JCL EXEC card, the default member name STDPARMS is used.

Format

Parameters

APPCTASK(YES|NO)

Specify YES if an AS400 tracker is used or there are programs using the API interface. The appctask is not required for the HCL Workload Automation for Z Server communication. You can specify APPCTASK for a tracker and a controller.

ARPARM(member name|STDAR)

Defines the name of the member in the EQQPARM data set that contains an AROPTS statement for the automatic job-recovery task.

ARM(YES|NO)

The z/OS Automatic Restart Manager (ARM) can reduce the impact of an unexpected error to HCL Workload Automation for Z because z/OS can restart it automatically, without operator intervention.

Specify YES if automatic restart of the failed HCL Workload Automation for Z component should be activated, and define the component in the ARM policy. The element name comprises the string "OPC" , the SYSTEMID, and the SUBSYSTEM name. ARM recovery of the failed HCL Workload Automation for Z component is possible in the same image (restart-in-place). This feature allows the recovery of the tracker and a fast restart of the controller and the server. In addition, restart-in-place does not reduce the number of standby controllers when there is a controller failure. You can customize the number of restarts and the period of a restart by setting the parameters for each HCL Workload Automation for Z component in the z/OS ARM policy.

AUTOMATIONMSG(MLOG|SYSLOG|BOTH|NONE)

Defines where the messages issued by System Automation are to be logged. You can specify one of the following:

MLOG: HCL Workload Automation for Z message log, this is the default.
SYSLOG: System log.
BOTH: HCL Workload Automation for Z message log and system log.
NONE: None of the messages issued by the System Automation are logged.

Note that message EQQE123I is logged into MLOG, regardless of the value you set for this keyword. This option is valid only if you run System Automation version 3.1 (with the appropriate maintenance level installed), or later.

BUILDSSX(MERGE|REBUILD)

Defines if the subsystem communication vector table (CVT) extension for HCL Workload Automation for Z, the SSX, should be rebuilt at a new level when the address space is started. The SSX is created at subsystem initialization by the EQQINIT0 module. If the EQQINIT0 module has since been updated, by maintenance or because you are installing a new release or modification level of HCL Workload Automation for Z, use the BUILDSSX keyword to avoid a z/OS IPL.

Specify MERGE when operational data, such as the event-writer queue, should be copied to the new SSX. This ensures that the new event-writer queue is primed with events queued to the old SSX block. Use this option when starting an HCL Workload Automation for Z address space after installing maintenance updates.

Note:

The PTF coverletter ++HOLD section identifies the service updates that require the SSX be rebuilt.
MERGE cannot be used when the old and new SSX blocks are built for different FMIDs.
The BUILDSSX parameter should be deleted after the next IPL of the z/OS system, as it is no longer required.

CDP(YES|NO)

Specify YES to enable the logging of data in the EQQCDP1 and EQQCDP2 log files, which are read by IBM Common Data Provider for z Systems (CDP), if you configure it to integrate with HCL Workload Automation for Z.

Integration with CDP is not supported in a configuration with a standby controller.

If you set CDP(YES), you must also set CDPPATH to indicate the path to the CDP log files. By default, the error messages reported in EQQMLOG and the messages for which you set CDP=YES in the SEQQMSG0 library are logged in the CDP log files. You can further set which data is to be logged with the CDPDB, CDPMCP, and CDPJOBSTATUS parameters.

CDPDB(YES|NO)

Specify YES to log the events related to actions performed in the controller database. This is the default.

CDPJOBSTATUS(CS|changed operation statuses|NO)

Indicates the changed statuses of an operation that are to be logged. Specify the statuses as a string, for example AIR*. Valid values are:

A: Ready. No predecessors defined.
C: Complete.
E: Operation ended in error.
I: Interrupted operation.
R: Ready. All predecessors are complete.
S: Started.
X: Suppressed by condition.
*: Ready. At least one predecessor was non-reporting. All predecessors are complete.

By default, only the statuses changed to C and S are logged. To disable the logging of operations' changed status, set this parameter to NO.

CDPMCP(YES|NO)

Specify YES to log the events related to MCP actions. This is the default.

CDPSWITCHLOGLIM(number of records|1000)

Specifies how many records must be written in the CDP log before the CDP log switching function is started. The CDP log switching function stops the running CDP log file and starts the alternate CDP log file. The alternate CDP log file records upcoming messages until the CDPSWITCHLOGLIM value is reached again, and the process is repeated.

Allowed values are from 1 to 999 999 999. The default is 1000 records.

CDPPATH(path to CDP log files)

The complete path to the EQQCDP1 and EQQCDP2 log files (up to 40 alphanumeric characters). It must be existent in the HFS file system.

If you set this parameter to a meaningful value and CDP is set to NO, the log files are created but will not be populated.

CHGDATE(YYMMDD)

Day when time change occurs because Daylight Saving Time (DST) starts or ends. It is specified in the format YYMMDD. For example to indicate 28 October 2018, set CHGDATE(181028). To apply the CHGDATE value correctly, it is required that you also set CHGOFF to M or P.

The CHGDATE parameter is used with regards to the cross dependencies between HCL Workload Automation and HCL Workload Automation for Z workstations that are in the same time zone, when operations are planned in advance across DST time change.

CHGTIME(HHMM)

Time when the time change occurs because Daylight Saving Time (DST) starts or ends. It is specified in the format HHMM. To apply the CHGTIME value correctly, it is required that you also set CHGOFF to M or P.

Th CHGTIME parameter is used with regards to the cross dependencies between HCL Workload Automation and HCL Workload Automation for Z workstations that are in the same time zone, when operations are planned in advance across DST time change.

CHGOFF(M|O|P)

Used when a date is set in the CHGDATE parameter, to indicate if the time change is forward or backward:

M: Minus. The time change is intended 1 hour backward.
O: Off (default value). The CHGDATE and CHGTIME parameters are to be ignored. If an invalid value is set for CHGOFF, the default is used and a warning message is issued.
P: Plus. The time change is intended 1 hour forward.

CODEPAGE(host system codepage|IBM – 037)

The name of the host code page. This value is used by the monitoring task to convert the monitoring data to be sent to the monitoring agent. You can provide the IBM®–nnn value, where nnn is the EBCDIC code page. The default value, IBM®–037, defines the EBCDIC code page for US English, Portuguese, and Canadian French. The following is a list of the EBCDIC code pages:

IBM®–939: Japan Extended
IBM®–937: Taiwan
IBM®–935: China
IBM®–933: Korea
IBM®–975: Greece
IBM®–971: Iceland
IBM®–970: Latin 2
IBM®–838: Thai
IBM®–500: International
IBM®–424: Israel
IBM®–297: France
IBM®–285: UK
IBM®–284: Spain - Latin America
IBM®–280: Italy
IBM®–278: Sweden - Finland
IBM®–277: Denmark - Norway
IBM®–274: Belgium
IBM®–273: Germany
IBM®–1388: China
IBM®–1122: Estonia
IBM®–1112: Baltic
IBM®–1047: Open Systems
IBM®–1026: Latin 5 (Turkey)
IBM®–1025: Cyrillic

The following is a list of the EBCDIC code pages for EURO support:

IBM®–1140: Finland, Sweden
IBM®–1141: Austria, Germany
IBM®–1142: Denmark, Norway
IBM®–1143: USA
IBM®–1144: Italy
IBM®–1145: Spain, spanish-speaking Latin America
IBM®–1146: UK
IBM®–1147: France
IBM®–1148: Belgium, Switzerland
IBM®–1149: Iceland

CPBPLIM (CP buffer pool size |40, PS)

The CP buffer pool size is set to half the size of the current plan, but it is limited to a certain percentage of the amount of storage available; this percentage is given by the CPBPLIM parameter.

When the current plan is closed (for example, when you make a backup or a new CP is generated) the buffer is deallocated and allocated again according to the percentage determined by CPBPLIM. This might result in a performance degradation. To avoid this problem, define the CPBPLIM size as a Permanent Storage by specifying the PS keyword, for example CPBPLIM(40,PS). In this way, you reserve a percentage of the available storage to be used for the buffers until the controller is recycled. The best value for the buffer pool size depends on your environment.

Values allowed are 0-99. Values 1-99 are considered as a percentage; value 0 causes the old restriction, 400 blocks. The default is a percentage of 40.

CPDTLIM (CP data set size percentage|50)

This keyword determines the percentage of size of the current plan used as maximum for buffer pool size. If CPDTLIM is omitted, the default 50 is used.

Values allowed are 0-100. Values 1-100 are considered as a percentage; value 0 causes the default of 50 to be used. Recommended values are between 50 and 100.

ERDRPARM(member name|STDERDR)

Defines the names of the members in the EQQPARM data set that contain an ERDROPTS statement for an event-reader task. The number of member names in this list must equal the number of event-reader tasks as defined by the ERDRTASK keyword. This keyword is required if more than one event reader is started.

ERDRTASK(number of event readers|1)

Defines the number of event-reader tasks to be started by HCL Workload Automation for Z. The maximum number is 16.

Note:

If no event-reader tasks should be started, you must specify ERDRTASK(0).
On controller side, separate event-reader tasks must be started when there are trackers connected via shared DASD.
On tracker side, it is recommended (for performance reasons) not to start a separate event-reader task by setting ERDRTASK(0). The event reader function should be activated in an event-writer task by specifying EWSEQNO on the EWTROPTS statement.

EWTRPARM(member name|STDEWTR)

Defines the name of the member in the EQQPARM data set that contains an EWTROPTS statement for the event-writer task.

EWTRTASK(YES|NO)

Specify YES if the HCL Workload Automation for Z subsystem should start an event-writer task to create events in an event data set.

EXIT01SZ(number of JCL lines|0)

This keyword, if specified with a nonzero value, tells HCL Workload Automation for Z that the JCL size can be changes using user exit 01, and that the new JCL size cannot be greater than the value specified.

For example, a value of 5000 sets the limit to 5000 JCL lines. Each JCL line is considered to be 80 characters in length.

EXTMON (YES|NO)

Specify YES to enable HCL Workload Automation for Z to communicate with Tivoli Business Service Manager. Tivoli Business Service Manager is notified of any alerts or changes in status related to monitored jobs. Specify NO if no monitoring is wanted.

GDGNONST(YES|NO)

If you set this keyword to No, HCL Workload Automation for Z tests the JCFGDG section to recognize if a data set is a GDG member. This means that the data set triggering function does recognize as GDG the data set referenced in the JCL in expanded format.

Note: The restart and cleanup function might not work properly wih GDG.

If you set this keyword to Yes, HCL Workload Automation for Z assumes that a data set having its last qualifier syntax compatible with a GDG member, is a GDG member.

GMTOFFSET(offset value|0)

This keyword is used to request HCL Workload Automation for Z to correct the GMT clock which is recognized as incorrect. The keyword parameter value defines how much the clock must be corrected. The value must be a number, positive or negative, less than 1440 (24 hours), that defines the number of minutes that must be added to the GMT clock value, on this system (where the keyword is used), to get the true GMT time.

The default value is zero (GMTOFFSET(0), that is, the GMT clock shows the true GMT time.

Note: This parameter only enables HCL Workload Automation for Z to bypass GMT synchronization processing, and does not enable the correct interpretation of the timestamp in events received from the tracker when the connection is established. So the actual start time and end time of related operations are deviated by the amount of the specified offset.

GSTASK(number of parallel requests|5)

Defines the number of dialog requests that can be handled simultaneously by the general-service subtask to a maximum of 5. So GSTASK(1) does not permit parallel processing of requests, but GSTASK(5), the default value, allows maximum parallel processing.

GTABLE(table ID|GLOBAL)

Defines the name of the global JCL-variable table for the HCL Workload Automation for Z complex. This table contains JCL variable definitions that can be used for any operation within the HCL Workload Automation for Z complex. The global variable table is searched when a table (or variable within a table) that is referenced by an operation cannot be found. You can specify only one table ID for the HCL Workload Automation for Z complex. HCL Workload Automation for Z uses the default name GLOBAL if you do not specify a table ID.

JCCPARM(member name|STDJCC)

Defines the name of the member in the EQQPARM data set that contains a JCCOPTS statement for the job-completion-checker task.

JCCTASK(YES|NO|)

Specify JCCTASK (YES) if the job-completion checker function is to be used.

Specify JCCTASK (NO) if the job-completion checker function is not to be used.

JESPLEX(list of system names)

Provides a list of the system names within the JESplex where the tracker belongs. Each system name can be up to 8 characters.

MAXSUBJOBS(number of jobs|0

This keyword specifies the maximum number of jobs that HCL Workload Automation for Z can submit consecutively without verifying the processes related to time-dependent events (for example, WAIT workstation delay, critical path, and long duration alert). The default value is 0. The maximum value is 9999. If you leave 0, HCL Workload Automation for Z does not interrupt job submission to process time-dependent events.

This value can be modified also with the following operator command:

/F procname, MAXSUB=nnnn

where procname is the name of the HCL Workload Automation for Z JCL procedure and nnnn is the maximum number of jobs.

MLOGPROCNAME(procedure name|EQQSMLOG)

The name of the procedure that the controller must run to copy the inactive MLOG file into the GDG data set (previously defined by the EQQPCS12 sample) following an MLOG switching routine.

EQQSMLOG is the default procedure name. It is available in the EQQSMLOG installation sample that you can install with the EQQJOBS installation aid, customize, and add in the user.proclib to make it accessible by the controller.

See also Using two message log (MLOG) data sets in HCL Workload Automation for Z: Planning and Installation.

NCFAPPL(VTAM LU name)

Specify the VTAM® LU name associated with the subsystem. This keyword is required if NCSK(YES) is specified.

NCFTASK(YES|NO)

Specify YES if the subsystem should start a network communication function (NCF) task. That is, communication is through VTAM®.

NOERRCONCHECK(YES|NO|MSG)

Defines which level of check the scheduler performs when adding entries to the NOERROR table. Specify one of the following:

YES: A consistency check is active. The scheduler does not add inconsistent entries to the NOERROR table and issues EQQN069W messages in the controller message log to indicate the inconsistencies. It is the default setting.
NO: To force the scheduler to update the NOERROR table even after detecting inconsistent entries. Related EQQN069W messages are not issued. EQQN098I message (informing that the table has been updated anyway, based on NOERRCONCHECK setting) is not issued either. Setting this keyword to NO prevents any consistency check from being performed.
MSG: Like the NO setting, it forces the scheduler to update the NOERROR table even after detecting inconsistent entries. Unlike the NO setting, related EQQN069W messages are issued. EQQN098I message is issued informing that the table has been updated anyway, based on NOERRCONCHECK setting.

OPCHOST(YES|NO|BACKUP|STANDBY|PLEX)

Defines the role of the subsystem. Specify one of the following values:

YES: This subsystem has to start as the controlling system. It supports dialog users and contains the databases and plans.
NO: This subsystem is not the controlling system.
BACKUP: This subsystem has to start as the backup controlling system.
STANDBY: This subsystem has to be prepared to change from running in non-host mode to host mode. OPCHOST(STANDBY) is valid only in an XCF environment. You cannot specify OPCHOST(STANDBY) and EWTRTASK(YES) on the same OPCOPTS statement.
PLEX: This subsystem has to start as the controlling system. If there is already an active controller in the XCF group, the start continues as standby controller. OPCHOST(PLEX) is valid only when XCF GROUP and MEMBER have been specified.

If HCL Workload Automation for Z is started with OPCHOST(YES), NMM initializes the CKPT data set with FMID and level corresponding to SSX.

OSLCPARM(member name|STDOSLC)

Defines the name of the member in the EQQPARM data set that contains the OSLCOPTS statement for the OSLC integration.

OUTCOL(started task name)

Specify the name of the output collector started task to be started and stopped by this controller. Use this parameter in a sysplex environment to enable a standby controller to automatically take over the communication with Output collector for the automatic retrieval of job logs in a z-centric environment.

OUCOPTS(YES|NO)

Default is NO. Specify YES to set, for each z-centric job output, its job name as the writer ID (SDSF WTR or IOF WTRID) when the job output is written to the specified JES SYSOUT class.

PIFLISTRC(YES|NO)

Default is NO. Specify YES if you want the controller to issue RC=2 (instead of RC=0) when an incomplete list is returned from a PIF request.

RCLEANUP (YES|NO)

Default is NO. Specify YES to use the restart and cleanup function. The value of RCLEANUP must match the value in the BATCHOPT for RCLEANUP. If RCLEANUP(YES) is coded, the CP16 records created by the batch job (if the BATCHOPT has RCLEANUP(YES) specified) are deleted as part of "catch up" processing. The FL task and the PSU task are started, the local data store is activated, and the scheduler changes the jobs to duplicate the output to OPC DEST ID.

When YES is specified, OUTPUTNODE(FINAL) is forced in the JTOPTS statement.

REAPPLYCOUNT(number of re-applied events|400

This keyword specifies after how many re-applied events message

EQQN059I JT APPLY IS IN PROGRESS. NN RECORDS HAVE BEEN
              PROCESSED.

is issued. Valid values are from 1 to 32000. The default is 400.

RCLPASS (YES|NO)

Default is NO. Specify YES to use the restart and cleanup function for JCLs with DISP=(,PASS) in the last step.

RECOVERY(YES|NO)

Specify YES if the controller should start an automatic-job-recovery task to manage automatically operations that end in error.

Note: If you specify RECOVERY(NO), you cannot use the Service Functions dialog to activate the automatic-job-recovery task.

REMJCLDIRECTIVES(YES|NO)

Defines if JCL directives are to be removed from the JCL at submission time.

Specify YES to remove the directives from the JCL at submission time. In this case, the scheduler removes the directives before submitting the JCL, therefore the job output does not contain the directives.

Specify NO to keep the directives in the JCL at submission time. In this case the job output contains the directives.

RODMPARM(member name|STDRODM)

Specifies the member in the EQQPARM data set that contains RODMOPTS statements for the RODM (resource object data manager) subtask. RODMPARM is not used by a tracker.

RODMTASK(YES|NO)

HCL Workload Automation for Z support for RODM (resource object data manager) lets you associate fields of special resources in the current plan with fields of RODM classes or RODM objects. Support for RODM requires that:

A tracker is started on the same z/OS image as the RODM subsystem that requests are sent to, and RODMTASK(YES) is specified for both the tracker and the controller.
An event writer is started in the HCL Workload Automation for Z address space that communicates with RODM. This address space creates resource events (type S) from RODM notifications, which HCL Workload Automation for Z uses to update the current plan.
The controller is connected to the tracker through XCF, NCF, TCP/IPor a submit/release data set.
Each address space has a unique RACF® user ID if more than 1 HCL Workload Automation for Z address space communicates with a RODM subsystem, such as when you start production and test systems that subscribe to the same RODM subsystem.

HCL Workload Automation for Z can communicate with several RODM subsystems.

SAVARFAIL(&, %)

This keyword tells HCL Workload Automation for Z not to consider unresolved variables in the System Automation command as an error, preventing the operation from completing with error code OJCV. The allowed variable types are the ampersand (&) and percent sign (%). You can use one or both of them, in any order, to bypass the substitution failure. For example if you set SAVARFAIL(&), HCL Workload Automation for Z does not consider as error the failing substitution of variables beginning with &.

Any combination of the two variables types is allowed, for example SAVARFAIL(&, %) or SAVARFAIL(%, &), but you must specify at least one type. If SAVARFAIL is not set, the failing substitution of a variable is considered as an operation error.

SECHECK(ALL|OPERONLY|NO)

This keyword applies to trackers and controllers where the Submit function is active (a blank destination is used to submit jobs locally). To activate WLM scheduling environments, you must specify a value other than NO.

When you activate this function, you must do so for all the trackers and for the controller within the same sysplex. This is needed to correctly implement the ENF listener mechanism, because each tracker activates the listener exits only in the z/OS system where it is located.

The possible values are:

ALL

All the submitted JCLs are to be checked for an associated scheduling environment name. The check is the following:

If it is defined, the scheduling environment name associated to the operation is used. In this case, the JCL is tailored by adding or replacing the SCHENV keyword of the JOB card statement. Any pre-existing value in the JCL is overwritten.
If the above condition is not true, the scheduling environment name specified in the SCHENV keyword of the JOB card statement is used, if it is present.
If the above condition is not true, no scheduling environment name is used (WLM is not queried).

When a scheduling environment is found, WLM is queried to find if the environment is available. If it is, the job is submitted, otherwise:

If the environment is not available, the operation is set to READY, WAITING FOR SE
If the environment is not defined, the operation is set to error (SEUN error code)

OPERONLY

Only the JCLs of operations with a scheduling environment defined in the HCL Workload Automation for Z database are to be checked. The check is the following:

The scheduling environment name associated to the operation is used to insert or update in the JCL the SCHENV keyword of the JOB card statement. When this happens, the existing value in the JCL is overwritten.
WLM is queried to find if the environment is available. If it is, the job is submitted, otherwise:
- If the environment is not available, the operation is set to READY, WAITING FOR SE
- If the environment is not defined, the operation is set to error (SEUN error code)

NO

No checks are performed. This is the default setting.

Note: When the JOB card is tailored to insert or replace the SCHENV=new value keyword, any comments on the right might be ignored and could show truncated in the submitted JCL.

SERESETJS(YES|NO)

Specifies if the JCL must be replaced in the JS file, when the WLM scheduling environment becomes available; in this way, any variables contained in the JCL are updated with the most up-to-date values.

The possible values are:

YES: The JCL is replaced in the JS file when the WLM scheduling environment becomes available.
NO: (Default). The JCL is not replaced in the JS file when the WLM scheduling environment becomes available.

SERVERS(Started task name, Started task name,...)

Identifies one or more servers to be started, and stopped, by this controller. Use this parameter in a sysplex environment to enable a standby controller to automatically take over the communication.

SPIN(YES|NO)

This keyword enables or disables the usage of the JESLOG SPIN functionality available with z/OS® V1.2 or later. If you specify YES, the usage of the JESLOG SPIN functionality is enabled. Because the Restart and Cleanup or Job Completion Checker functions do not support this functionality, when you use them a warning message is issued.

If you specify NO, the usage of the JESLOG SPIN functionality is disabled by adding JESLOG=NOSPIN to the JOB card of every submitted job. SPIN(NO) is effective only if RCLEANUP(YES) or JCCTASK(YES) is specified. If you use the Restart and Cleanup function, a JOB card is added automatically to each submitted JCL when missing. If you do not use the Restart and Cleanup function (RCLEANUP(NO)), a warning message is issued for each submitted JCL that does not have a job card. The default is NO.

Note: When the JOB card is tailored to insert or replace the JESLOG=NOSPIN keyword, any comments on the right might be ignored and could show truncated in the submitted JCL.

SSCMNAME(module name,PERMANENT|TEMPORARY)

The first keyword value defines the name of the subsystem communication module to be used instead of EQQSSCM0 that was loaded at IPL. The second keyword value specifies if the module should replace the one loaded at IPL. Use this keyword to load an updated version of the module before a scheduled IPL. The module you specify must reside in an APF-authorized library defined by either the STEPLIB ddname or LNKLSTnn concatenation. If SSCMNAME is not specified or specifies a module that cannot be located in an authorized library, HCL Workload Automation for Z events continue to be generated by the EQQSSCM0 loaded at IPL.

Specify PERMANENT as the second keyword value to replace the subsystem communication module loaded at IPL with the module identified in the first keyword value. In this case the module specified must reside in an APF-authorized library defined by the STEPLIB ddname.

When TEMPORARY is specified or defaulted as the second keyword value, the module you specify generates HCL Workload Automation for Z job-tracking events only while the HCL Workload Automation for Z address space is active. When the address space is stopped, events continue to be generated by the EQQSSCM0 module loaded at IPL.

Note:

The PTF cover letter ++HOLD section identifies service updates that require a new subsystem communication module to be loaded.
The SSCMNAME keyword should be removed after the next IPL, because it is no longer required.

SUPPRESSENF(YES|NO)

Specifies if activation of the ENF 57 and ENF 41 listener exits must be canceled.

YES: Exits ENF 57 and ENF 41 are not to be activated although it is marked for activation (because a value other than NO was specified for SECHECK).
NO: Activation of the exits is not to be canceled. This is the default.
You should not set this parameter to YES on trackers located in a sysplex that is not the one where the controller is. You can cancel activation of the exits on trackers that belong to the same sysplex as the controller only if there is a tracker in the same z/OS image as the controller and the ENF exits are active (SECHECK is not set to NO).

SWITCHMLOGLIM(number of records|0)

Specifies how many records must be in the active message log (MLOG) before the MLOG switching function is started. The MLOG switching function stops the running MLOG file, copies it into a GDG data set, and starts the alternate MLOG file. The alternate MLOG file records upcoming messages until the SWITCHMLOGLIM value is reached again, and the process is repeated.

The default value is 0. It means that the MLOG switching function is not to be run. If the value is greater than 0, the function is activated; however, if no DD EQQMLOG2 is defined in the started task JCL, or if the name is already locked, the function cannot be activated and the following message is issued:

EQQZ408W SWITCHMLOGLIM PARAMETER IS SPECIFIED BUT EQQMLOG2 DATA SET IS NOT AVAILABLE.
         MLOG SWITCH FUNCTION IS NOT ACTIVATED.

The maximum possible value is 999 999 999 records.

See also Using two message log (MLOG) data sets in HCL Workload Automation for Z: Planning and Installation.

SYSPLEXID (nnn)

Identifies the sysplex where the controller or tracker is located. nn is an integer ranging from 1 to 9999. The default is 1.

TASKUSR(NO|YES)

Specifies if a started task is to be run with the user ID associated with the task, instead of the user ID associated with the job name.

YES: The task is run with the user ID associated with the started task name. This is the default.
NO: The task is run with the user ID associated with the job name.

TRKPLS (minutes|10)

Used in the SNA connection when the tracker starts up and the synchronization process with the Z controller begins. It is the time interval, expressed in minutes, after which the tracker notices that the controller has sent the synchronization event. The valid range is 1-10; the default is 10 minutes.

VARFAIL(&, %, ?)

This keyword tells HCL Workload Automation for Z whether or not unresolved variables in the JCL would cause a JCL error (OJCV). You can use from one to three of the following characters, in any order, to bypass substitution failure (&, %, ?).

For example, if VARFAIL(&) is specified HCL Workload Automation for Z does not consider the failure of a substitution of variables beginning with an & to be an error. Any combination of the three types is allowed, for example VARFAIL(&, %) or VARFAIL(?), but at least one value must be specified while any repetition of characters is rejected.

If VARFAIL is not specified, all the lack of substitution of variables is treated as errors, as previously.

Note that the error bypass is not applicable to HCL Workload Automation for Z Directive and Dependent variables.

VARPROC(YES|NO)

This keyword tells HCL Workload Automation for Z whether online procedures are to consider variable substitution. If VARPROC(YES) is specified, variables in online procedures are resolved.

The default is NO.

VARSUB(YES|NO|SCAN)

This keyword tells HCL Workload Automation for Z whether JCL variable substitution should be performed. YES means that variable scanning is performed for all computer operations. NO means that variable scanning does not occur. SCAN tells HCL Workload Automation for Z to search JCL for variables only if the //*%OPC SCAN directive has been found in the JCL.

This keyword applies also to variable substitution in the System Automation command text. YES and SCAN mean that the command text is scanned for variable substitution. NO means that variable scanning is not performed.

WAITREL(waiting time|0)

Defines, in tenth of seconds, the time that HCL Workload Automation for Z waits before releasing a held job. Valid values are from 0 to 99; the default value is 0.

You can dynamically update the WAITREL value by issuing the modify command /F subsys,WAITREL=nn.

WLM(class name|WLMJOBPR, policy name, CONDITIONAL(20))

The WLM keyword defines the options that are to be applied for workload manager intervention. The WLM function can be used to assign extra resource to critical jobs that are running late. HCL Workload Automation for Z does this by promoting a late critical job to a higher performance WLM service class. WLM is defined in the member of the EQQPARM library as specified by the PARM parameter on the JCL EXEC statement.

Class Name: The name of the WLM service class to which late critical jobs are promoted. It can be an existing service class or a new service class created for this purpose.

Policy Name

The means by which HCL Workload Automation for Z decides whether a critical job is running late. Specify one of the possible choices, and that is the default policy that HCL Workload Automation for Z applies. This default can be overwritten at the individual job level. The following list shows the valid policy names:

DURATION

When a critical job exceeds the expected duration (as specified in the current plan), HCL Workload Automation for Z moves it to the higher-performance service class, according also to the ALEACTION or LIMFDBK value set in the JTOPTS statement. (For details about the ALEACTION and LIMFDBK keywords, refer to JTOPTS.)

Note: The fact that a job exceeds its expected duration does not necessarily imply that it is running late or that it will negatively impact the plan as a whole. Specifying this policy could mean that extra resource is dedicated to a job when not strictly necessary.

DEADLINE

When a critical job runs beyond its deadline time (calculated as Latest Start Time + Duration), HCL Workload Automation for Z moves it to a higher-performance service class.

Note: If this policy is used, then extra resources are dedicated to a job only when it really needs it. The extra resources help to reduce the delay.

LATESTSTARTTIME

When a critical job starts after its latest start time, HCL Workload Automation for Z promotes it to a higher-performance service class.

Note: Using this policy the gains are greater, as extra resources are dedicated to the job for its entire execution time. However, with this policy, it is possible to over-compensate, dedicating extra resources to a job for longer than necessary. For example, a long running job might start only a few minutes late, but get enough extra resources that let it finish early.

CONDITIONAL (NN)

This policy uses a simple test that decides whether the deadline or the lateststarttime policy is applied when a critical job starts after its latest start time.

The numeric value (NN) specified in this policy defines a threshold, which is used as follows:

If(Delay÷Time to Deadline)×100 > NN

then HCL Workload Automation for Z moves the job immediately to the higher-performance service class. This effectively applies the lateststarttime policy.

If (Delay÷Time to Deadline)×100 <= NN

then HCL Workload Automation for Z takes no action until the job runs beyond its deadline time. This is to avoid over-compensation.

Note: If you use the default member name for ARPARM, ERDRPARM, EWTRPARM, JCCPARM, or RODMPARM, you must define the member.

Examples

 OPCOPTS OPCHOST(YES)                   1
         NCFTASK(YES)                   2
         NCFAPPL(NCFAPPL1)              3
         ERDRTASK(2)                    4
         ERDRPARM(ERDR1,ERDR2)          5
         GMTOFFSET(60)                  6
         GTABLE(GVARTAB)                7
         SERVERS(OPCBCOM1,OPCBCOM2)...  8

In this example of an OPCOPTS statement:

1: HCL Workload Automation for Z is started as a controller. This system supports dialog users.
2: The network communication function (NCF) is started.
3: The controller has the VTAM® LU name NCFAPPL1.
4: Two event-reader tasks are started.
5: Run-time options for the event-reader tasks are specified in the ERDR1 and ERDR2 members of the parameter library.
6: HCL Workload Automation for Z adds one hour to GMT clock values retrieved from the running system.
7: A global JCL-variable table, called GVARTAB, is used by this HCL Workload Automation for Z complex.
8: A server is started for handling the communication to a certain controller. The server verifies that the inbound transactions are requests to the controller for which the server is started.