OPINFO

Purpose

Use the OPINFO command to set the user data of an operation in the current plan. The user data can contain any data you require. In many installations, the field is used to record the problem record number for operations that have ended in error. OPINFO can be incorporated into your Information Management interface to enable immediate feedback of the problem report to HCL Workload Automation for Z.

Usage

You can invoke OPINFO as a TSO command or by using a batch job which executes program EQQEVPGM. If you invoke OPINFO as a TSO command, allocate the EQQMLIB data set to the address space of the TSO user, either by adding DD statements to the logon procedure, or by using the ALLOC command after TSO logon. In the TSO environment, error messages and trace records are sent directly to the terminal user. Messages are not delivered to indicate successful command execution.

You use the OPINFOSCOPE keyword of the JTOPTS to specify the scope of the command. If OPINFOSCOPE is set to (or defaults to) IP, HCL Workload Automation for Z considers only in-progress operations (where the current status is R, A, *, S, I, or E), and will not action OPINFO events for operations in any other status. If OPINFOSCOPE is set to ALL, HCL Workload Automation for Z also considers operations with W and C status.

With the OPINFO command, you specify the WSNAME, ADID, IA, OPNUM, or JOBNAME parameters to identify the operation whose user data is to be updated. If the OPINFOSCOPE keyword is IP, which is the default, WSNAME is a required parameter. If OPINFOSCOPE is ALL, the ADID or JOBNAME parameter is required. Also, for printer workstations, you can specify the CLASS and FORM parameters to identify the operation.

If you do not provide enough information to uniquely identify the operation, and HCL Workload Automation for Z finds more than one operation that matches your parameters, HCL Workload Automation for Z chooses the best operation. If OPINFOSCOPE is IP, HCL Workload Automation for Z uses this list, taking each item until it gets a single operation:
  1. Priority 9
  2. Earliest latest start time
  3. Highest priority, if lower than 9
  4. Earliest operation input arrival time, or occurrence input arrival time if the operation does not have input arrival specifically defined
  5. Longest in Ready status

That is, if HCL Workload Automation for Z determines that there is more than one in-progress operation in the current plan, the operation with priority 9 is updated. If more than one operation specifies priority 9, or there are no priority 9 operations, the operation with the earliest latest start time is updated. The latest start is blank if the operation is added using the MCP panel. If the latest start time is equal, the operation with the highest priority is updated, and so on.

If OPINFOSCOPE is ALL, HCL Workload Automation for Z uses the same list as for OPINFOSCOPE(IP) to find a single operation. If no in-progress operation that matches your parameters is found, HCL Workload Automation for Z also searches operations with status C and W in the current plan. The operation with the earliest latest start time is selected.

Use of the OPINFO command can be restricted with the fixed resource code CP. The authority of the requester is verified by the subsystem name identified in the command if an AUTHDEF statement is defined for that subsystem. When SUBSYS(MSTR) is specified, all tracker subsystems defined on the z/OS® system where the OPINFO command is issued will attempt to verify the authority of the requester before data will be passed. You might be rejected by one subsystem and accepted by another.

You need update authority to resource code CP to use this command. Resource codes are described in Customization and Tuning.

The subsystem to which you direct the command does not have to be active when the command is issued. An event will be generated and queued in CSA along with other job-tracking events. If the subsystem is not active when the command is issued, the authority of the requester is verified using the class name specified in the AUTHDEF statement when the subsystem was last started. If the subsystem has not been started since a z/OS® IPL, no authority verification can be performed.

Format


1  OPINFO?  ADID (
2.1 application description identifier
1 )?  CLASS (
2.1 printer sysout class
1 )?  FORM (
2.1 printer form name
1 )?  IA (
2.1 yymmddhhmm
1 )?  JOBNAME (
2.1 job name
1 )?  OPNUM (
2.1 operation number
1 )?  SUBSYS (
2.1! OPCA
2.1 MSTR
2.1 subsystem name
1 )?  TRACE (
2.1! 0
2.1 trace level
1 )?  USERDATA (
2.1 any data
1 )?  WSNAME (
2.1 workstation name
1 )

Parameters

ADID (application description identifier)
The application identifier of the operation whose user data is to be updated. If the OPINFOSCOPE keyword of the JTOPTS statement is ALL, ADID is a required parameter.
CLASS (printer sysout class)
For a printer workstation, specifies the printer SYSOUT class of the operation whose user data is to be updated.
FORM (printer form name)
For a printer workstation, specifies the printer FORM name of the operation whose user data is to be updated.
IA (yymmddhhmm)
The input arrival date and time of the occurrence containing the operation whose user data is to be updated. You must specify this in the format yymmddhhmm.
Note: HCL Workload Automation for Z interprets the yy part as follows:
YY
Year
72 - 99
1972 - 1999
00 - 71
2000 - 2071
JOBNAME (job name)
The job name associated with the operation whose user data is to be updated. If the OPINFOSCOPE keyword of the JTOPTS statement is ALL, JOBNAME is a required parameter.
OPNUM (operation number)
The operation number of the operation whose user data is to be updated.
SUBSYS (MSTR | subsystem name | OPCA)
Name of the tracker subsystem that the OPINFO command is directed to. The name can be up to 4 characters long. The first character must be alphabetic; the remaining characters must be alphanumeric. All lowercase characters are converted to uppercase.

If you specify MSTR, the OPINFO command is directed to all tracker subsystems on the z/OS® system where the OPINFO command is issued.

Note: If the trackers and controller run on different subsystems in your configuration, specify the name of the tracker subsystem in this parameter.
TRACE (level | 0)
Event tracing indicator. When a positive number is specified, a trace entry is created for each event generated by the OPINFO command. The trace record is written to the message log file identified by ddname EQQMLOG. The record identifies the name of each receiving subsystem. The default value 0 will not generate trace records.
USERDATA (any data)
You can use this 16-character parameter to pass information about an operation to the current plan in the operation user data. The USERDATA field cannot contain any blanks.
WSNAME (workstation name)
The name of the workstation for the operation whose user data is to be updated. If the OPINFOSCOPE keyword of the JTOPTS statement is IP, WSNAME is a required parameter.

Examples

These two examples demonstrate how you can use the OPINFO command in TSO, or in a batch job (using the batch program EQQEVPGM).

OPINFO
Example 1 - TSO command 
ALLOC F(EQQMLIB) DA('OPC.MESSAGE.LIBRARY') SHR REUSE
 
OPINFO W(BDEC) J(DNCD3000) A(ACLMSDLY) U(USER£DATA£HERE)
Example 2 - Batch job 
//OPINFOUS JOB (ACCOUNT),'Set completed',CLASS=A
//STEP1    EXEC PGM=EQQEVPGM
//STEPLIB  DD DSN=OPC.LOAD.MODULE.LIBRARY,DISP=SHR
//EQQMLIB  DD DSN=OPC.MESSAGE.LIBRARY,DISP=SHR
//EQQMLOG  DD SYSOUT=A
//SYSIN    DD *
OPINFO W(BDEC) J(DNCD3000) A(ACLMSDLY) U(PROBREC£O1234567)
/*

In both of these examples, an operation for application ACLMSDLY at workstation BDEC will have the data fed back to it.