ADOP

Purpose

Use the ADOP control statement to add operations to an application description. Provide an ADOP statement for each operation that is to be defined in the current application.

On this statement, you can specify one internal predecessor for the operation being defined. If you need to specify external predecessors, or more internal predecessors, use one or more ADDEP statements immediately after the ADOP statement.

Note: You cannot add operations to a group definition.

Format


1  ADOP?  ACTION (
2.1! ADD
2.1 SETDEFAULT
1 )?  ADOPCATM (
2.1! N
2.1 A
2.1 I
2.1 M
1 )?  ADOPEXPJCL (
2.1 Y
2.1 N
1 )?  ADOPJOBCRT (
2.1 N
2.1 P
2.1 W
1 )?  ADOPJOBPOL (
2.1 L
2.1 D
2.1 S
2.1 C
1 )?  ADOPMH (
2.1 Y
2.1! N
1 )?  ADOPNOP (
2.1 Y
2.1! N
1 )?  ADOPPWTO (
2.1! N
2.1 Y
1 )?  ADOPUSRSYS (
2.1 Y
2.1 N
1 )?  ADOPWLMCLASS (
2.1 WLM service class
1 )?  AEC (
2.1! Y
2.1 N
1 )?  AJR (
2.1! Y
2.1 N
1 )?  AJSUB (
2.1! Y
2.1 N
1 )?  CLATE (
2.1! N
2.1 Y
1 )?  CONDRJOB (
2.1! N
2.1 Y
1 )?  DESCR ('
2.1 operation description
1 ')?  DLACT (
2.1 deadline action
1 )?  DLDAY (
2.1! 0
2.1 deadline day
1 )?  DLTIME (
2.1 hhmm
1 )?  DURATION (
2.1! 1
2.1 operation duration
1 )?  FORM (
2.1 form number
1 )?  HIGHRC (
2.1 return code
1 )

1?  JOBCLASS (
2.1 jobclass
1 )?  LIMFDBK (
2.1 feedback limit
1 )?  MONITOR (
2.1 Y
2.1 N
1 )?  PREJOBN (
2.1 predecessor job name
1 )?  PREOPNO (
2.1 predecessor operation number
1 )?  PREWSID (
2.1 predecessor workstation
1 )?  PRTCLASS (
2.1 print class
1 )?  PSNUM (
2.1! 0
2.1 number of servers
1 )?  R1NUM (
2.1! 0
2.1 amount of R1
1 )?  R2NUM (
2.1! 0
2.1 amount of R2
1 )?  REROUTABLE (
2.1 Y
2.1 N
1 )?  RESTARTABLE (
2.1 Y
2.1 N
1 )?  SMOOTHING (
2.1 smoothing factor
1 )?  STARTDAY (
2.1 start day
2.1! 0
1 )?  STARTTIME (
2.1 hhmm
1 )?  TIME (
2.1! N
2.1 Y
1 )?  USESAI (
2.1 N
2.1 Y
1 )?  USEXTNAME (
2.1 N
2.1 Y
1 )?  USEXTSE (
2.1 N
2.1 Y
1 )
1+ .
1  WSID (
2.1 workstation name
1 )
1  OPNO (
2.1 operation number
1 )
1  JOBN (
2.1 job name
1 )

Restrictions

You cannot use ACTION(SETDEFAULT) to set default values for the following keywords:
  • WSID
  • OPNO
  • JOBN
  • PREWSID
  • PREOPNO
  • PREJOBN

Parameters

ACTION (SETDEFAULT | ADD)
If you specify SETDEFAULT, the remaining keyword values that you specify on the ADOP statement become default values for all ADOP statements that follow. No application description is updated. Keywords that you do not specify are assigned their standard defaults.

If you specify ADD or use it by default, the statement can result in an update of the database.

ADOPCATM (A | I | M | N)
The cleanup type for this operation:
A
Automatic. When the operation is ready to be submitted and the controller selects it for submissions, the controller automatically finds the cleanup actions to be taken and also inserts them as the first step in the JCL of the restarted job. Whenever the operation is started from the panels, the cleanup actions are shown to the user for confirmation, only if the CLEANUP CHECK option was set to YES through the DEFINING PARAMETERS AND OPTIONS panel.
I
Immediate. data set cleanup is immediately performed if the operation ends in error. The operation is treated as if it had the automatic option when it is rerun.
M
Manual. data set cleanup actions are deferred for the operation. They are performed when initiated manually from the panel.
N
None. No data set cleanup actions are performed.
ADOPEXPJCL (Y | N)
Specifies if the scheduler uses the JCL extracted from the JES JCL sysout.
Y
Uses the fully expanded JCL.
N
Uses the JCL contained in the libraries of the scheduler.
ADOPJOBCRT (W | P |N)
Specifies if the operation is to be considered critical.
W
The operation is considered eligible for Workload Manager (WLM) assistance, if late.
P
The operation is considered the target job of a critical path and eligible, with all the operations belonging to that critical path, for WLM assistance.
N
The operation is not to be considered critical. This is the default.

For W and P, the scheduler automatically sends a request to WLM to promote the job or started task to the specified WLM service class, whenever the conditions of the specified assistance policy are met.

ADOPJOBPOL (L | D | S | C)
Specifies which policy is to be applied for WLM assistance, if the job is defined as critical.
L
Long duration. The job is assisted if it runs beyond its estimated duration time.
D
Deadline. The job is assisted if it has not finished when its deadline time is reached.
S
Latest start time. The job is assisted if it is submitted after the latest start time.
C
Conditional. An algorithm calculates whether to apply the Deadline or the Latest start time policy.
‘ ʼ
Default. WLM uses the policy specified in OPCOPTS.

If no WLM policy is specified and the operation belongs to a critical path, the policy of the critical path target job is applied.

ADOPMH (Y | N)
If you specify Y, the operation is added to the Application Description database with the Manually Hold option set to Y.
ADOPNOP (Y | N)
If you specify Y, the operation is added to the Application Description database with the NOP option set to Y.
ADOPPWTO (Y | N)
If you specify Y, a WTO message is issued if the operation passes its deadline and is in started status.
ADOPUSRSYS (Y | N)
Specifies if user sysout support is needed. If you specify Y, the data store logs user sysout.
ADOPWLMCLASS (WLM service class)
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. If you do not set this keyword and the operation belongs to a critical path, the WLM service class of the critical path target job is used.
AEC (N | Y)
For operations on automatic reporting workstations, IBM® Z Workload Scheduler does some processing when a job completes to determine whether the operation should be given error status or completed status. If you specify AEC(N), IBM Z Workload Scheduler will not check for errors and will give the operation completed status, regardless of any error reported by job tracking.
AJR (N | Y)
Jobs can be placed in HOLD status on the job queue by the event writer (an event writer option). Such jobs can either be released when all IBM Z Workload Scheduler scheduling conditions are met, or be released immediately. AJR(Y) means that IBM Z Workload Scheduler should control the scheduling. AJR(N) means that IBM Z Workload Scheduler will release the job immediately.

The automatic job release option is applicable only when the HOLDJOB keyword of the EWTROPTS is set to USER or YES.

AJSUB (N | Y)
Automatic job submission.
CLATE (Y | N)
Specify Y to cancel this operation if it is time-dependent and late.
Note: IBM Z Workload Scheduler never cancels a job that has already started running.
CONDRJOB (Y | N)
Specifies if the operation might recover a conditional predecessor.
DESCR ('operation description')
A free-format description of the operation. It can be up to 24 characters and must be contained within single quotation marks.
DLACT (deadline action)
Action to be taken if the operation does not complete when the deadline day and time are reached. Allowed values are:
blank
Default. No action is taken.
A
Only an alert message is issued.
C
The operation is set to Complete, if its status allows it. Otherwise it is NOPed.
E
The operation is set to Error with ODEA, if its status allows it. Otherwise, this setting is postponed at the time when the status allows it.
N
The operation and all its internal successors are NOPed, if their status allows NOPing. Otherwise it is ignored.
DLDAY (deadline day | 0)
Specifies the number of days, related to the start of the application, when this operation must be completed. This must be an integer. 0 means that the deadline is on the same day as the occurrence input arrival.
DLTIME (hhmm)
Required if you have specified DLDAY. DLTIME specifies the time, on the day specified by the DLDAY keyword, by which this operation should be completed. This must be in the format hhmm.
DURATION (operation duration)
The estimated duration of this operation in minutes or seconds according to the DURUNIT value in OPTIONS. It must be an integer greater than 0, the default is 1 minute.

The maximum value is 99 hours 59 minutes 00 seconds. If you specify 99 hours 59 minutes 01 seconds, you do not receive an alert message, if the actual duration is greater than the planned duration.

FORM (form number)
If this operation is a printing operation, the printer form number that will appear on the daily plan and on ready lists. For printer workstations with automatic reporting, the printer class and form number let IBM Z Workload Scheduler identify the different print operations belonging to a specific job. This can be up to 8 characters.
HIGHRC (return code)
If this operation is a z/OS® job, the highest return code that should not be considered an error. If the job ends with this return code or less, the operation will be treated by IBM Z Workload Scheduler as completed. This must be an integer less than 4096. If you leave out the parameter, IBM Z Workload Scheduler takes the value you specified in the JTOPTS statement.
JOBCLASS (jobclass)
A single character that appears on workstation ready lists for information only. This should be the z/OS job class from the JCL.
JOBN (job name)
The job name for this operation, if applicable.
LIMFDBK (feedback limit)
The default is the value you set in the job-tracking initialization statement JTOPTS. The feedback limit must be an integer in the range 100-999.
MONITOR (Y | N)
If you specify Y, the operation is monitored by an external monitor, for example by IBM Business Systems Manager.
OPNO (operation number)
The operation number for this operation, in the range 1 to 255. Each operation within an application must have a unique number. If you do not specify an operation number, the default value will be the previous operation in this application, plus 1. If this is the first operation in an application, the default OPNO is 1. You can also specify your own default operation number increment with ACTION(SETDEFAULT).

If ACTION(SETDEFAULT) is specified, the value entered is an increment to be used when allocating a default operation number.

PREJOBN (predecessor job name)
The job name of an internal predecessor operation to this operation.
PREOPNO (predecessor operation number)
The operation number of an internal predecessor operation to this operation.
PREWSID (predecessor workstation)
The workstation name of an internal predecessor operation to this operation.
PRTCLASS (print class)
If this operation is a printing operation, the printer SYSOUT class that appears on the daily plan and on ready lists. For printer workstations with automatic reporting, the printer class and form number let IBM Z Workload Scheduler identify the different print operations belonging to a specific job. This is a single character, and must be specified for print operations.
PSNUM (number of servers | 0)
The number of workstation parallel servers required by this operation. This must be an integer.
R1NUM (amount of R1 | 0)
The amount of workstation type 1 resources required by this operation. This must be an integer.
R2NUM (amount of R2 | 0)
The amount of workstation type 2 resources required by this operation. This must be an integer.
REROUTABLE (Y | N )
This keyword specifies the reroute option for the operation. The default is that the operation is reroutable if the WSFAILURE initialization statement RESTART keyword is set to REROUTE.
Y
The operation is always reroutable.
N
The operation is never reroutable.
RESTARTABLE (Y | N )
This keyword specifies the restart option for the operation. The default is that the operation is restartable if the WSFAILURE initialization statement RESTART keyword is set to RESTART.
Y
The operation is always restartable.
N
The operation is never restartable.
SMOOTHING (smoothing factor)
The default is the value you set in the job-tracking initialization statement JTOPTS. The smoothing factor must be an integer in the range 0–999.
STARTDAY (start day | 0)
Specifies the input arrival day of this operation, as a number of days offset from the occurrence input arrival day (0 means the same day). This must be an integer. Specifying a separate input arrival day and time for an operation can be useful if the operation is time-dependent and you want to ensure that it will not start before the specified time.
STARTTIME (hhmm)
Required if you have specified STARTDAY. STARTTIME specifies the input arrival time of this operation, on the day specified with the STARTDAY keyword. This must be in the format hhmm. If you specify STARTTIME but not STARTDAY, STARTDAY defaults to 0 (zero), which is the occurrence input arrival day.
TIME (Y | N)
If you specify Y, the job is made time-dependent. For more details, see Creating time-dependent operations.
USESAI (N | Y )
Determines whether the system automation information for the operation is used in the current plan. This keyword must be set to Y (yes) if the workstation has the system AUTOMATION option set to Y (yes).
USEXTNAME (N | Y)
Determines whether or not the operation extended name is used in the current plan.
USEXTSE (N | Y )
Determines if the Scheduling Environment name of the operation is used in the current plan.
Y
Scheduling Environment name specified and stored in CP by the DP or dynamic addition process.
N
Scheduling Environment name not specified or specified in AD and not stored in CP by the DP or dynamic addition process.
WSID
Specifies the name of the workstation where you are scheduling the operation.

Examples

In this example, a job SMFCHK is given an operation number of 060. It has an internal predecessor—operation 030: 
ADOP WSID(CPU1) JOBN(SMFCHK) OPNO(060) PREOP(030)
The following example creates three operations: 
ADOP WSID(SETP) JOBN(BACKUP) OPNO(010)
ADOP WSID(CPU1) JOBN(BACKUP) TIME(Y) STARTDAY(0) STARTTIME(2000)
  PREOPNO(010) OPNO(015) DLTIME(2100) ADOPPWTO(Y) ADOPCATM(Y)
ADOP WSID(PRT1) JOBN(BACKUP) PRTCLASS(H) PREOPNO(015)
The first, number 010, is on the job setup workstation SETP. The second, number 015, depends on the setup operation, and cannot start before 20.00 because it is time-dependent. If it is still running at 21.00, IBM Z Workload Scheduler issues a DEADLINE WTO. IBM Z Workload Scheduler performs immediate cleanup if the job fails.

The last operation has no number specified, but IBM Z Workload Scheduler gives it operation number 016 (the default operation number increment is 1). It is a print operation, and depends on the predecessor job 015. IBM Z Workload Scheduler will track the output with class H, and report the operation completed when this output has finished printing.

The setup and print operations have the same job name as the main operation; this is required.