tivoli workload scheduler for z/os programming...
TRANSCRIPT
IBM
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
Version
8.1
(Maintenance
Release
October
2003)
SH19-4545-01
IBM
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
Version
8.1
(Maintenance
Release
October
2003)
SH19-4545-01
Note
Before
using
this
information
and
the
product
it
supports,
read
the
information
in
Notices
on
page
235.
Refreshed
Edition
(October
2003)
This
refreshed
edition
applies
to
version
8,
release
1,
modification
0
of
IBM
Tivoli
Workload
Scheduler
for
z/OS
(program
number
5697-WSZ)
and
to
all
subsequent
releases
and
modifications
until
otherwise
indicated
in
new
editions.
|
|||||
|
|||
Contents
Tables
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. vii
Figures
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. ix
Preface
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. xi
Maintenance
Release
.
.
.
.
.
.
.
.
.
.
. xi
Who
Should
Read
This
Guide
.
.
.
.
.
.
.
. xi
What
This
Guide
Contains
.
.
.
.
.
.
.
.
. xii
Publications
.
.
.
.
.
.
.
.
.
.
.
.
.
. xii
Publications
for
Tivoli
Workload
Scheduler
for
z/OS
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. xii
Using
LookAt
to
Look
Up
Message
Explanations
xiii
Accessing
Publications
Online
.
.
.
.
.
.
. xiii
Softcopy
Collection
Kit
.
.
.
.
.
.
.
.
. xiv
Ordering
Publications
.
.
.
.
.
.
.
.
.
. xiv
Providing
Feedback
about
Publications
.
.
.
. xiv
Contacting
IBM
Software
Support
.
.
.
.
.
.
. xv
Conventions
Used
in
This
Guide
.
.
.
.
.
.
. xv
Part
1.
Programming
Interfaces
.
.
. 1
Chapter
1.
The
Program
Interface
(PIF)
. 3
Program
Interface
Samples
.
.
.
.
.
.
.
.
. 3
Related
Tools
.
.
.
.
.
.
.
.
.
.
.
.
.
. 3
Batch
Command
Interface
Tool
.
.
.
.
.
.
. 3
Tivoli
Workload
Scheduler
for
z/OS
Control
Language
.
.
.
.
.
.
.
.
.
.
.
.
.
. 3
Communicating
with
EQQYCOM
.
.
.
.
.
.
. 4
Required
Data
Sets
.
.
.
.
.
.
.
.
.
.
.
. 5
Optional
Data
Set
.
.
.
.
.
.
.
.
.
.
.
.
. 5
Error
Messages
.
.
.
.
.
.
.
.
.
.
.
.
. 5
Parameter
Overview
.
.
.
.
.
.
.
.
.
.
.
. 6
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 7
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 7
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 8
Argument
Names
and
Values
.
.
.
.
.
.
.
. 8
Communication
Block
.
.
.
.
.
.
.
.
.
. 9
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 10
Sequence
of
Requests
.
.
.
.
.
.
.
.
.
.
. 10
Data
Area
Description
and
Format
.
.
.
.
.
.
. 10
Header
Format
.
.
.
.
.
.
.
.
.
.
.
. 10
Data
Record
Format
.
.
.
.
.
.
.
.
.
. 11
Date
Considerations
.
.
.
.
.
.
.
.
.
.
. 12
Default
Dates
in
Existing
Databases
.
.
.
.
. 12
Internal
Date
Representation
.
.
.
.
.
.
.
. 12
Date
Arguments
in
PIF
Applications
.
.
.
.
. 12
Updating
Application
Description
Run
Cycles
with
PIF
.
.
.
.
.
.
.
.
.
.
.
.
.
. 13
Security
Considerations
.
.
.
.
.
.
.
.
.
. 13
Overview
of
Request
Types
.
.
.
.
.
.
.
.
. 14
DELETE
Request
.
.
.
.
.
.
.
.
.
.
.
. 15
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 15
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 15
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 15
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 16
Communication
Block
Address
.
.
.
.
.
.
. 20
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 20
EXECUTE
Request
.
.
.
.
.
.
.
.
.
.
.
. 21
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 21
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 21
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 21
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 21
Communication
Block
Address
.
.
.
.
.
.
. 21
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 21
INIT
Request
.
.
.
.
.
.
.
.
.
.
.
.
.
. 21
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 22
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 22
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 22
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 22
Communication
Block
Address
.
.
.
.
.
.
. 23
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 23
INSERT
Request
.
.
.
.
.
.
.
.
.
.
.
.
. 23
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 24
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 24
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 25
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 25
Communication
Block
Address
.
.
.
.
.
.
. 29
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 29
LIST
Request
.
.
.
.
.
.
.
.
.
.
.
.
.
. 30
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 30
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 30
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 31
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 31
Communication
Block
Address
.
.
.
.
.
.
. 38
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 38
MODIFY
Request
.
.
.
.
.
.
.
.
.
.
.
. 38
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 38
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 38
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 38
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 38
Communication
Block
Address
.
.
.
.
.
.
. 42
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 43
OPTIONS
Request
.
.
.
.
.
.
.
.
.
.
.
. 43
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 43
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 43
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 43
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 44
Communication
Block
Address
.
.
.
.
.
.
. 47
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 47
REPLACE
Request
.
.
.
.
.
.
.
.
.
.
.
. 47
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 47
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 47
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 48
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 48
Communication
Block
Address
.
.
.
.
.
.
. 48
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 49
RESET
Request
.
.
.
.
.
.
.
.
.
.
.
.
. 49
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 49
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 49
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 49
iii
||
||||||||||||
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 49
Communication
Block
Address
.
.
.
.
.
.
. 49
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 49
SELECT
Request
.
.
.
.
.
.
.
.
.
.
.
.
. 49
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 50
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 50
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 51
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 51
Communication
Block
Address
.
.
.
.
.
.
. 58
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 58
TERM
Request
.
.
.
.
.
.
.
.
.
.
.
.
. 58
Action
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 59
Resource
Code
.
.
.
.
.
.
.
.
.
.
.
. 59
Data
Area
.
.
.
.
.
.
.
.
.
.
.
.
.
. 59
Arguments
.
.
.
.
.
.
.
.
.
.
.
.
. 59
Communication
Block
Address
.
.
.
.
.
.
. 59
Return
Code
.
.
.
.
.
.
.
.
.
.
.
.
. 59
JCL
Preparation
Using
PIF
.
.
.
.
.
.
.
.
. 59
Substituting
Variables
.
.
.
.
.
.
.
.
.
. 59
Simulating
Variable
Substitution
.
.
.
.
.
. 60
Chapter
2.
The
Application
Programming
Interface
(API)
.
.
.
.
. 63
Communicating
with
Tivoli
Workload
Scheduler
for
z/OS
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 63
CPI-C
Support
Provided
by
Tivoli
Workload
Scheduler
for
z/OS
.
.
.
.
.
.
.
.
.
.
. 64
API
Buffer
Layouts
.
.
.
.
.
.
.
.
.
.
.
. 65
APPFixed
Section
.
.
.
.
.
.
.
.
.
. 66
APPOBJObject
Section
.
.
.
.
.
.
.
.
. 68
APPSELSelection
Section
.
.
.
.
.
.
.
. 70
APPVALSelection
Value
Section
.
.
.
.
.
. 71
APPFLDField
Section
.
.
.
.
.
.
.
.
. 72
APPDATData
Section
.
.
.
.
.
.
.
.
. 73
Specifying
Object
Names
.
.
.
.
.
.
.
.
.
. 73
Selecting
Object
Instances
.
.
.
.
.
.
.
.
.
. 74
Specifying
Key
Types
.
.
.
.
.
.
.
.
.
. 74
Specifying
Selection
Criteria
.
.
.
.
.
.
.
. 75
Broadcasting
events
.
.
.
.
.
.
.
.
.
. 75
Selecting
Object
Fields
to
Update
or
Retrieve
.
.
. 76
Return
Codes
and
Reason
Codes
Generated
by
Tivoli
Workload
Scheduler
for
z/OS
.
.
.
.
.
. 76
Return
Codes
and
Reason
Codes
Generated
in
the
Fixed
Section
(APP)
.
.
.
.
.
.
.
.
. 76
Return
Codes
and
Reason
Codes
Generated
in
the
Object
Section
(APPOBJ)
.
.
.
.
.
.
.
. 77
Security
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 77
APPC
and
RACF
.
.
.
.
.
.
.
.
.
.
. 77
Tivoli
Workload
Scheduler
for
z/OS
and
RACF
78
Part
2.
Programming
Tools
.
.
.
.
. 81
Chapter
3.
Batch
Command
Interface
Tool
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 83
Online
Tools
.
.
.
.
.
.
.
.
.
.
.
.
.
. 83
The
Batch
Command
Interface
.
.
.
.
.
.
.
. 83
Input
to
Batch
Command
Interface
.
.
.
.
. 83
BCIT
Output
.
.
.
.
.
.
.
.
.
.
.
.
. 85
Instructions
.
.
.
.
.
.
.
.
.
.
.
.
. 86
Chapter
4.
Control
Language
(OCL)
113
What
You
Can
Do
Using
OCL
.
.
.
.
.
.
.
. 113
Advantages
of
OCL
.
.
.
.
.
.
.
.
.
.
. 113
Summary
of
OCL
Instructions
.
.
.
.
.
.
.
. 114
Customizing
OCL
.
.
.
.
.
.
.
.
.
.
.
. 116
Specifying
the
Initialization
Parameters
.
.
.
. 117
Example
1
.
.
.
.
.
.
.
.
.
.
.
.
. 118
Example
2
.
.
.
.
.
.
.
.
.
.
.
.
. 118
Example
3
.
.
.
.
.
.
.
.
.
.
.
.
. 119
Example
4
.
.
.
.
.
.
.
.
.
.
.
.
. 119
Obtaining
Access
Authorization
.
.
.
.
.
. 119
Logging
Executed
Instructions
.
.
.
.
.
.
. 120
Specifying
OCL
Instructions
.
.
.
.
.
.
. 120
Specifying
Input
Arrival
Dates
and
Times
.
.
. 121
Description
of
OCL
Instructions
.
.
.
.
.
. 124
Requirements
.
.
.
.
.
.
.
.
.
.
.
. 176
Sample
Job
and
Procedure
.
.
.
.
.
.
.
. 176
Messages
.
.
.
.
.
.
.
.
.
.
.
.
.
. 178
Part
3.
Appendixes
.
.
.
.
.
.
.
. 181
Appendix
A.
Program
Interface
Record
Format
.
.
.
.
.
.
.
.
.
.
. 183
TOD
Fields
.
.
.
.
.
.
.
.
.
.
.
.
.
. 183
Application
Description
(Resource
Codes
AD,
ADCOM)
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 183
ADCOMCommon
Segment
.
.
.
.
.
.
. 184
ADKEYKey
Segment
.
.
.
.
.
.
.
.
. 184
ADRUNRun
Cycle
Segment
.
.
.
.
.
.
. 185
ADOPOperation
Segment
.
.
.
.
.
.
. 187
ADDEPDependency
Segment
.
.
.
.
.
. 188
ADSRSpecial
Resource
Segment
.
.
.
.
. 188
All
Workstations
Closed
(Resource
Code
AWSCL)
189
AWSCLAll
Workstations
Closed
Interval
Segment
.
.
.
.
.
.
.
.
.
.
.
.
.
. 189
Calendar
(Resource
Codes
CL,
CLCOM)
.
.
.
. 189
CLCOMCommon
Segment
.
.
.
.
.
.
. 189
CLSDSpecific
Date
Segment
.
.
.
.
.
.
. 190
CLWDWeekday
Segment
.
.
.
.
.
.
.
. 190
Current
Plan
Occurrence
(Resource
Code
CPOC)
191
CPOCCurrent
Plan
Occurrence
Segment
.
. 191
Current
Plan
Operation
(Resource
Codes
CPOP,
CPOPCOM)
.
.
.
.
.
.
.
.
.
.
.
.
.
. 192
CPOPCommon
Segment
.
.
.
.
.
.
.
. 192
CPPREPredecessor
Segment
.
.
.
.
.
.
. 195
CPSUCSuccessor
Segment
.
.
.
.
.
.
. 195
CPSRSpecial
Resource
Segment
.
.
.
.
. 196
CPOPSRUSpecial
Resource
Usage
Segment
196
Current
Plan
Status
(Resource
Code
CPST)
.
.
. 197
CPSTCommon
Segment
.
.
.
.
.
.
.
. 197
Current
Plan
Workstation
(Resource
Codes
CPWS,
CPWSCOM)
.
.
.
.
.
.
.
.
.
.
.
.
.
. 198
CPWSCommon
Segment
.
.
.
.
.
.
.
. 198
CPIVLCurrent
Plan
Workstation
Open
Interval
Segment
.
.
.
.
.
.
.
.
.
.
. 199
Current
Plan
Special
Resource
(Resource
Codes
CSR,
CSRCOM)
.
.
.
.
.
.
.
.
.
.
.
. 200
CSRCOMCurrent
Plan
Resource
Common
Segment
.
.
.
.
.
.
.
.
.
.
.
.
.
. 200
iv
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
CSRIVLCurrent
Plan
Special
Resource
Interval
Segment
.
.
.
.
.
.
.
.
.
.
.
.
.
. 201
CSRIWSCurrent
Plan
Resource
Interval
Connected
Workstation
.
.
.
.
.
.
.
. 201
CSRDWSCurrent
Plan
Resource
Default
Connected
Workstation
.
.
.
.
.
.
.
. 202
ETTEvent
Triggered
Tracking
Criteria
Segment
.
.
.
.
.
.
.
.
.
.
.
.
.
. 202
JCL
Setup
Variables
(Resource
Codes
JCLPREP,
JCLPREPA)
.
.
.
.
.
.
.
.
.
.
.
.
.
. 202
JSVCCommon
Segment
.
.
.
.
.
.
.
. 202
JSVVVariable
Definition
Segment
.
.
.
.
. 203
JCL
Variable
Table
(Resource
Codes
JCLV,
JCLVCOM)
.
.
.
.
.
.
.
.
.
.
.
.
.
. 203
JCLVCCommon
Segment
.
.
.
.
.
.
.
. 203
JCLVVVariable
Definition
Segment
.
.
.
. 204
JCLVDDependency
Segment
.
.
.
.
.
. 204
Job
Control
Language
(Resource
Codes
JS,
JSCOM)
204
JSJob
Control
Language
Segment
.
.
.
.
. 205
Job
Log
(Resource
Code
JLCOM)
.
.
.
.
.
.
. 205
JLCOMCommon
Segment
.
.
.
.
.
.
. 205
Long-Term
Plan
Occurrence
(Resource
Codes
LTOC,
LTOCCOM)
.
.
.
.
.
.
.
.
.
.
. 206
LTOCCommon
Segment
.
.
.
.
.
.
.
. 206
LTOPOperation
Segment
.
.
.
.
.
.
.
. 207
LTPREPredecessor
Segment
.
.
.
.
.
.
. 207
LTSUCSuccessor
Segment
.
.
.
.
.
.
. 208
Operator
Instruction
(Resource
Codes
OI,
OICOM)
208
OIOperator
instruction
Segment
.
.
.
.
. 208
Period
(Resource
Codes
PR,
PRCOM)
.
.
.
.
. 209
PRPeriod
Segment
.
.
.
.
.
.
.
.
.
. 209
Special
Resource
(Resource
Codes
SR,
SRCOM)
210
Workstation
Description
(Resource
Codes
WS,
WSCOM)
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 211
WSCOMCommon
Segment
.
.
.
.
.
.
. 211
WSIVLOpen
Interval
Segment
.
.
.
.
.
. 212
WSSDSpecific
Date
Segment
.
.
.
.
.
. 213
WSWDWeekday
Segment
.
.
.
.
.
.
. 213
WSAMWorkstation
Access
Method
Segment
213
Appendix
B.
API
Object
Fields
.
.
.
. 215
Current
Plan
Status
Object
.
.
.
.
.
.
.
.
. 215
Current
Plan
Operation
Object
.
.
.
.
.
.
. 216
Current
Plan
Special
Resource
Object
.
.
.
.
. 221
Current
Plan
Workstation
Object
.
.
.
.
.
.
. 222
Current
Plan
Open
Interval
Object
.
.
.
.
.
. 223
Current
Plan
Operation
Event
Object
.
.
.
.
. 224
Current
Plan
OPINFO
Event
object
.
.
.
.
.
. 226
Current
Plan
Special
Resource
Event
Object
.
.
. 227
Current
Plan
Backup
Event
Object
.
.
.
.
.
. 228
Current
Plan
Workstation
Event
Object
.
.
.
.
. 228
Appendix
C.
Sample
Library
(SEQQSAMP)
.
.
.
.
.
.
.
.
.
.
. 231
Tivoli
Workload
Scheduler
for
z/OS
Application
Programming
Interface
.
.
.
.
.
.
.
.
.
. 231
API
Buffer
Examples
.
.
.
.
.
.
.
.
.
. 231
Tivoli
Workload
Scheduler
for
z/OS
Program
Interface
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 232
JS
Data
Set
Maintenance
.
.
.
.
.
.
.
.
. 232
JCL
Variable
Substitution
.
.
.
.
.
.
.
. 232
Current
Plan
and
LTP
Actions
.
.
.
.
.
.
. 233
Other
PIF
Samples
.
.
.
.
.
.
.
.
.
. 233
Notices
.
.
.
.
.
.
.
.
.
.
.
.
.
. 235
Trademarks
.
.
.
.
.
.
.
.
.
.
.
.
.
. 236
Glossary
.
.
.
.
.
.
.
.
.
.
.
.
. 237
Index
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 249
Contents
v
|
|
|
|
vi
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
Tables
1.
List
of
Publications
.
.
.
.
.
.
.
.
.
. xiii
2.
Comparison
of
Date
Representations
.
.
.
. 13
3.
Access
Authority
for
Program
Interface
Requests
.
.
.
.
.
.
.
.
.
.
.
.
. 13
4.
Program
Interface
Resources
and
the
Corresponding
Tivoli
Workload
Scheduler
for
z/OS
Fixed
Resources
Used
for
Checking
Authorization
.
.
.
.
.
.
.
.
.
.
.
. 14
5.
Deleting
a
Record
Using
a
Common
Segment
16
6.
Delete
AD
Arguments
.
.
.
.
.
.
.
.
. 16
7.
Delete
AWSCL
Arguments
.
.
.
.
.
.
. 17
8.
Delete
CL
Arguments
.
.
.
.
.
.
.
.
. 17
9.
Delete
CPOC
Arguments
.
.
.
.
.
.
.
. 17
10.
Delete
CPOP
Arguments
.
.
.
.
.
.
.
. 17
11.
Delete
CPPRE
Arguments
.
.
.
.
.
.
.
. 17
12.
Delete
CPSUC
Arguments
.
.
.
.
.
.
.
. 18
13.
Delete
CPSR
Arguments
.
.
.
.
.
.
.
. 18
14.
Delete
ETT
Arguments
.
.
.
.
.
.
.
.
. 18
15.
Delete
IVL
Arguments
.
.
.
.
.
.
.
.
. 18
16.
Delete
JCLV
Arguments
.
.
.
.
.
.
.
. 18
17.
Delete
JL
Arguments
.
.
.
.
.
.
.
.
. 19
18.
Delete
JS,
JSCOM
Arguments
.
.
.
.
.
. 19
19.
Delete
LTOC
Arguments
.
.
.
.
.
.
.
. 19
20.
Delete
LTPRE
Arguments
.
.
.
.
.
.
.
. 19
21.
Delete
OI
Arguments
.
.
.
.
.
.
.
.
. 20
22.
Delete
PR
Arguments
.
.
.
.
.
.
.
.
. 20
23.
Delete
SR
Arguments
.
.
.
.
.
.
.
.
. 20
24.
Delete
WS
Arguments
.
.
.
.
.
.
.
.
. 20
25.
Insert
CPOC
Arguments
.
.
.
.
.
.
.
. 26
26.
Insert
CPOP
Arguments
.
.
.
.
.
.
.
. 26
27.
Insert
CPPRE
Arguments
.
.
.
.
.
.
.
. 27
28.
Insert
CPSR
Arguments
.
.
.
.
.
.
.
. 28
29.
Insert
CPSUC
Arguments
.
.
.
.
.
.
.
. 28
30.
Insert
IVL
Arguments
.
.
.
.
.
.
.
.
. 28
31.
Insert
JCLPREP
Arguments
.
.
.
.
.
.
. 28
32.
Insert
JCLV
Arguments
.
.
.
.
.
.
.
.
. 29
33.
Insert
LTOC
Arguments
.
.
.
.
.
.
.
. 29
34.
Insert
LTPRE
Arguments
.
.
.
.
.
.
.
. 29
35.
List
ADCOM
and
ADKEY
Arguments
.
.
.
. 33
36.
List
AWSCL
Arguments
.
.
.
.
.
.
.
. 34
37.
List
CLCOM
Arguments
.
.
.
.
.
.
.
. 34
38.
List
CPOC
Arguments
.
.
.
.
.
.
.
.
. 34
39.
List
CPOPCOM
Arguments
.
.
.
.
.
.
. 34
40.
List
CPOPSRU
Arguments
.
.
.
.
.
.
. 35
41.
List
CPWSCOM
Arguments
.
.
.
.
.
.
. 35
42.
List
CSRCOM
Arguments
.
.
.
.
.
.
.
. 36
43.
List
ETT
Arguments
.
.
.
.
.
.
.
.
.
. 36
44.
List
JCLVCOM
Arguments
.
.
.
.
.
.
. 36
45.
List
JLCOM
Arguments
.
.
.
.
.
.
.
. 36
46.
List
JSCOM
Arguments
.
.
.
.
.
.
.
. 36
47.
List
LTOCCOM
Arguments
.
.
.
.
.
.
. 37
48.
List
OICOM
Arguments
.
.
.
.
.
.
.
. 37
49.
List
PRCOM
Arguments
.
.
.
.
.
.
.
. 37
50.
List
SRCOM
Arguments
.
.
.
.
.
.
.
. 37
51.
List
WSCOM
Arguments
.
.
.
.
.
.
.
. 37
52.
Modify
CPOC
Arguments
.
.
.
.
.
.
.
. 39
53.
Modify
CPOP
Arguments
.
.
.
.
.
.
.
. 39
54.
Modify
CPWS
Arguments
.
.
.
.
.
.
.
. 41
55.
Modify
CSR
Arguments
.
.
.
.
.
.
.
. 41
56.
Modify
IVL
Arguments
.
.
.
.
.
.
.
. 42
57.
Modify
LTOC
Arguments
.
.
.
.
.
.
.
. 42
58.
Replace
AD
Arguments
.
.
.
.
.
.
.
. 48
59.
Select
AD,
ADCOM
Arguments
.
.
.
.
.
. 53
60.
Select
AWSCL
Arguments
.
.
.
.
.
.
.
. 53
61.
Select
CL,
CLCOM
Arguments
.
.
.
.
.
. 53
62.
Select
CPOC
Arguments
.
.
.
.
.
.
.
. 53
63.
Select
CPOP,
CPOPCOM
Arguments
.
.
.
. 54
64.
Select
CPWS,
CPWSCOM
Arguments
.
.
.
. 54
65.
Select
CSR,
CSRCOM
Arguments
.
.
.
.
. 55
66.
Select
ETT
Arguments
.
.
.
.
.
.
.
.
. 55
67.
Select
JCLPREP
Arguments
.
.
.
.
.
.
. 55
68.
Select
JCLPREPA
Arguments
.
.
.
.
.
.
. 55
69.
Select
JCLV,
JCLVCOM
Arguments
.
.
.
.
. 56
70.
Select
JLCOM
Arguments
.
.
.
.
.
.
.
. 56
71.
Select
JS,
JSCOM
Arguments
.
.
.
.
.
.
. 56
72.
Select
LTOC,
LTOCCOM
Arguments
.
.
.
. 56
73.
Select
OI,
OICOM
Arguments
.
.
.
.
.
. 57
74.
Select
PR,
PRCOM
Arguments
.
.
.
.
.
. 57
75.
Select
SR,
SRCOM
Arguments
.
.
.
.
.
. 57
76.
Select
WS,
WSCOM
Arguments
.
.
.
.
.
. 57
77.
Selecting
a
Record
Using
a
Common
Segment
57
78.
Contents
of
a
Send
Buffer
.
.
.
.
.
.
.
. 65
79.
App-Fixed
Section
.
.
.
.
.
.
.
.
.
. 66
80.
APPOBJ-Object
Section
.
.
.
.
.
.
.
.
. 68
81.
APPSEL-Selection
Section
.
.
.
.
.
.
.
. 71
82.
APPVAL-Selection
Value
Section
.
.
.
.
. 72
83.
APPFLD-Field
Section
.
.
.
.
.
.
.
.
. 72
84.
APPDAT-Data
Section
.
.
.
.
.
.
.
.
. 73
85.
API
Object
Names
.
.
.
.
.
.
.
.
.
. 73
86.
Operators
That
You
Can
Specify
in
the
APPSEL
Section
.
.
.
.
.
.
.
.
.
.
. 75
87.
Subresource
Protection
for
Requests
through
the
API
.
.
.
.
.
.
.
.
.
.
.
.
.
. 78
88.
Positional
parameters
that
can
be
passed
with
the
Batch
Command
Interface
.
.
.
.
.
. 83
89.
Access
Authorizations
.
.
.
.
.
.
.
.
. 119
90.
Input
Arrival
Date
and
Time
Keywords
121
91.
How
OCL
Uses
the
IADATE,
IATIME,
and
IA
Keywords
.
.
.
.
.
.
.
.
.
.
.
.
. 122
92.
Tivoli
Workload
Scheduler
for
z/OS-supplied
Variables
.
.
.
.
.
.
.
.
.
.
.
.
. 124
93.
Keywords
used
in
the
Init
Instruction
131
94.
Keywords
used
in
the
Chkappl
Instruction
132
95.
Keywords
Used
in
the
Add
Instruction
134
96.
Keywords
used
in
the
Addop
Instruction
136
97.
Keywords
used
in
the
Addpred
Instruction
138
98.
Keywords
used
in
the
Delpred
Instruction
140
99.
Keywords
used
in
the
Addres
Instruction
141
100.
Keywords
used
in
the
Del
Instruction
143
101.
Keywords
used
in
the
Del
Instruction
144
102.
Keywords
used
in
the
Relsucc
Instruction
146
103.
Keywords
used
in
the
Relop
Instruction
148
vii
|
|
|
|
104.
Keywords
used
in
the
Force
Instruction
150
105.
Keywords
used
in
the
Compl
Instruction
152
106.
Keywords
used
in
the
Chgjob
Instructions
154
107.
Keywords
used
in
the
Modop
Instructions
156
108.
Operations
Details
that
can
be
modified
157
109.
Keyword
used
in
the
Release
Instruction
159
110.
Keywords
used
in
the
Hold
Instruction
160
111.
Keywords
used
in
the
Nop
Instruction
162
112.
Keywords
used
in
the
Unnop
Instruction
164
113.
Keywords
used
in
the
Opstat
Instruction
165
114.
Keywords
used
in
the
Srstat
Instruction
167
115.
Keywords
used
in
the
Wsstat
Instruction
168
116.
Chkdate
Instruction
Variables
.
.
.
.
.
. 169
117.
Clock
value
setting
at
the
start
of
different
years
.
.
.
.
.
.
.
.
.
.
.
.
.
. 183
118.
Clock
value
setting
at
different
time
interval
183
119.
ADCOM
Control
Block
.
.
.
.
.
.
.
. 184
120.
ADRUN
Control
Block
.
.
.
.
.
.
.
. 185
121.
Run
Cycle
Offsets
.
.
.
.
.
.
.
.
.
. 186
122.
Rule
Definition
.
.
.
.
.
.
.
.
.
.
. 186
123.
ADOP
Control
Block
.
.
.
.
.
.
.
.
. 187
124.
ADDEP
Control
Block
.
.
.
.
.
.
.
. 188
125.
ADSR
Control
Block
.
.
.
.
.
.
.
.
. 188
126.
AWSCL
Control
Block
.
.
.
.
.
.
.
. 189
127.
CLCOM
Control
Block
.
.
.
.
.
.
.
. 189
128.
CLSD
Control
Block
.
.
.
.
.
.
.
.
. 190
129.
CLWD
Control
Block
.
.
.
.
.
.
.
.
. 190
130.
CPOC
Control
Block
.
.
.
.
.
.
.
.
. 191
131.
CPOP
Control
Block
.
.
.
.
.
.
.
.
. 193
132.
CPPRE
Control
Block
.
.
.
.
.
.
.
.
. 195
133.
CPSUC
Control
Block
.
.
.
.
.
.
.
.
. 195
134.
CPSR
Control
Block
.
.
.
.
.
.
.
.
. 196
135.
CPOPSRU
Control
Block
.
.
.
.
.
.
.
. 196
136.
CPST
Control
Block
.
.
.
.
.
.
.
.
. 197
137.
CPWS
Control
Block
.
.
.
.
.
.
.
.
. 198
138.
CPIVL
Control
Block
.
.
.
.
.
.
.
.
. 199
139.
CSRCOM
Control
Block
.
.
.
.
.
.
.
. 200
140.
CSRIVL
Control
Block
.
.
.
.
.
.
.
. 201
141.
CSRIWS
Control
Block
.
.
.
.
.
.
.
. 201
142.
CSRDWS
Control
Block
.
.
.
.
.
.
.
. 202
143.
ETT
Control
Block
.
.
.
.
.
.
.
.
.
. 202
144.
JSVC
Control
Block
.
.
.
.
.
.
.
.
. 202
145.
JSVV
Control
Block
.
.
.
.
.
.
.
.
. 203
146.
JCLVC
Control
Block
.
.
.
.
.
.
.
.
. 203
147.
JCLVV
Control
Block
.
.
.
.
.
.
.
.
. 204
148.
JCLVD
Control
Block
.
.
.
.
.
.
.
.
. 204
149.
JS
Control
Block
.
.
.
.
.
.
.
.
.
. 205
150.
JLCOM
Control
Block
.
.
.
.
.
.
.
.
. 206
151.
LTOC
Control
Block
.
.
.
.
.
.
.
.
. 206
152.
LTOP
Control
Block
.
.
.
.
.
.
.
.
. 207
153.
LTPRE
Control
Block
.
.
.
.
.
.
.
.
. 207
154.
LTSUC
Control
Block
.
.
.
.
.
.
.
.
. 208
155.
OI
Control
Block
.
.
.
.
.
.
.
.
.
. 208
156.
PR
Control
Block
.
.
.
.
.
.
.
.
.
. 209
157.
Period
Origin
Dates
.
.
.
.
.
.
.
.
. 210
158.
Period
Interval
End
Dates
.
.
.
.
.
.
. 210
159.
SRCOM
Control
Block
.
.
.
.
.
.
.
. 210
160.
SRIVL
Segment
.
.
.
.
.
.
.
.
.
.
. 211
161.
SRIWS
Segment
.
.
.
.
.
.
.
.
.
.
. 211
162.
SRDWS
Segment
.
.
.
.
.
.
.
.
.
. 211
163.
WSCOM
Control
Block
.
.
.
.
.
.
.
. 212
164.
WSIVL
Control
Block
.
.
.
.
.
.
.
.
. 213
165.
WSSD
Control
Block
.
.
.
.
.
.
.
.
. 213
166.
WSWD
Control
Block
.
.
.
.
.
.
.
.
. 213
167.
WSAM
Control
Block
.
.
.
.
.
.
.
.
. 214
168.
CP_STATUS
Object
Fields
.
.
.
.
.
.
. 215
169.
CP_OPERATION
Object
Fields
.
.
.
.
.
. 216
170.
CP_RESOURCE
Object
Fields
.
.
.
.
.
. 221
171.
CP_WORK_STATION
Object
Fields
.
.
.
. 222
172.
CP_OPEN_INTERVAL
Object
Fields
.
.
.
. 224
173.
CP_OPER_EVENT
Object
Fields
.
.
.
.
. 224
174.
CP_OPINFO_EVENT
Object
Fields
.
.
.
. 226
175.
CP_SR_EVENT
Object
Fields
.
.
.
.
.
. 227
176.
BACKUP_EVENT
Object
Fields
.
.
.
.
. 228
177.
CP_WS_EVENT
Object
Fields
.
.
.
.
.
. 228
178.
SEQQSAMP
Library
Members
for
Programming
Interfaces
and
the
API
.
.
.
. 231
viii
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
Figures
1.
Program
Interface
Parameters
.
.
.
.
.
.
. 7
2.
Program
Interface
Arguments
in
TSO
Command
Notation
.
.
.
.
.
.
.
.
.
.
.
.
.
. 9
3.
Program
Interface
Data
Area
Example
.
.
.
. 11
4.
Example
of
Arguments
for
Processing
a
List
52
5.
Example
of
a
Send
Buffer
Layout
for
a
GET
Request
.
.
.
.
.
.
.
.
.
.
.
.
.
. 66
6.
Application
Flow
Example
.
.
.
.
.
.
. 118
ix
x
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
Preface
This
guide
shows
you
how
to
use
the
programming
interfaces
to
Tivoli
Workload
Scheduler
for
z/OS
to
help
you
plan,
schedule,
and
monitor
work
in
the
production
department
of
your
computer
installation.
Your
workload
can
run
on
various
platforms,
but
you
control
it
from
a
central
z/OS
system
that
runs
the
Tivoli
Workload
Scheduler
for
z/OS
controller.
The
term
the
scheduler,
when
used
in
this
book,
refers
to
Tivoli
Workload
Scheduler
for
z/OS.
The
term
DB2,
when
used
in
this
book,
also
applies
to
DATABASE2
and
DB2
Universal
Database.
The
term
z/OS
is
used
in
this
guide
to
mean
z/OS
and
OS/390
operating
systems.
Where
the
term
OS/390
appears,
the
related
information
applies
only
to
OS/390
operating
systems.
Maintenance
Release
This
is
a
maintenance
refresh
of
the
corresponding
IBM
Tivoli
Workload
Scheduler
for
z/OS
Version
8.1
manual,
form
number
SH19454500.
It
contains
updates
for
the
following
APARS:
v
57618
v
62895
v
66046
v
68835
v
70492
Throughout
the
book,
the
changed
or
new
sections
are
marked
by
revision
bars.
The
name
of
the
APAR
causing
the
information
change
is
also
featured
within
the
changed
chapter,
section,
or
paragraph.
If
your
version
of
the
product
has
not
been
fixed
for
a
particular
APAR,
refer
to
the
original
version
of
the
manual
for
the
corresponding
information.
Who
Should
Read
This
Guide
This
guide
is
for
personnel
who
write
application
programs
that
request
services
from
Tivoli
Operations
Planning
and
Control
(Tivoli
Workload
Scheduler
for
z/OS).
This
book
documents
the
programming
interface
(PIF)
and
the
application
programming
interface
(API).
To
use
PIF
you
must
know
job
control
language
(JCL)
and
have
a
good
working
knowledge
of
a
programming
language,
for
example,
assembler
or
PL/I.
You
can
use
programming
languages
that
support
z/OS
and
OS/390
linkage
conventions
and
that
can
load
and
delete
an
assembler
program.
To
use
the
API,
you
require
a
knowledge
of
Advanced
Program-to-Program
Communication
(APPC).
You
must
be
able
to
write
application
transaction
programs
(ATPs)
that
use
the
services
of
APPC.
Because
the
API
is
implemented
xi
|
|||
|
|
|
|
|
|||||
using
a
subset
of
CPI-C
(Common
Programming
Interface
for
Communications)
verbs,
you
must
be
able
to
write
ATPs
that
use
CPI-C.
What
This
Guide
Contains
This
guide
contains
the
following
sections:
Part
I.
Programming
Interfaces
Part
I
contains
the
following
chapters:
v
Chapter
1,
The
Program
Interface
(PIF),
on
page
3
Describes
how
you
can
write
programs
to
issue
requests
to
the
Tivoli
Workload
Scheduler
for
z/OS
subsystem.
v
Chapter
2,
The
Application
Programming
Interface
(API),
on
page
63
Describes
the
Tivoli
Workload
Scheduler
for
z/OS
interface,
which
uses
the
services
of
Advanced
Program-to-Program
Communications
(APPC)
for
communications
between
your
application
transaction
programs
(ATPs)
and
Tivoli
Workload
Scheduler
for
z/OS.
Part
II.
Programming
Tools
Part
II
contains
the
following
chapters:
v
Chapter
3,
Batch
Command
Interface
Tool,
on
page
83
Describes
the
batch
command
interface
tool.
v
Chapter
4,
Control
Language
(OCL),
on
page
113
Describes
the
Tivoli
Workload
Scheduler
for
z/OS
Control
Language.
Part
III.
Appendixes
Part
III
contains
the
following
chapters:
v
Appendix
A,
Program
Interface
Record
Format,
on
page
179
Describes
the
fields
of
the
data
records
as
handled
by
the
program
interface
communication
routine.
v
Appendix
B,
API
Object
Fields,
on
page
215
Describes
the
fields
of
the
application
programming
interface
(API)
objects.
v
Appendix
C,
Sample
Library
(SEQQSAMP),
on
page
231
Describes
the
members
of
the
sample
library,
EQQSAMP,
that
help
you
use
programming
interfaces.
Publications
This
section
lists
publications
in
the
Tivoli
Workload
Scheduler
for
z/OS
library
and
any
other
related
documents.
It
also
describes
how
to
access
Tivoli
publications
online,
how
to
order
Tivoli
publications,
and
how
to
make
comments
on
Tivoli
publications.
Publications
for
Tivoli
Workload
Scheduler
for
z/OS
The
following
table
lists
the
publications
in
the
Tivoli
Workload
Scheduler
for
z/OS
library.
xii
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
Table
1.
List
of
Publications
Task
Publication
Order
number
Planning
Tivoli
Workload
Scheduler
for
z/OS
Licensed
Program
Specifications
GH19-4540
Understanding
the
Tivoli
Workload
Scheduling
Suite
General
Information
GH19-4539
Learning
concepts
and
terminology
Getting
Started
SH19-4542
Using
the
Java
GUI
Job
Scheduling
Console
Users
Guide
SH19-4552
Using
the
Java
GUI
Job
Scheduling
Console
Release
Notes
GI10-5781
Installing
Tivoli
Workload
Scheduler
for
z/OS
Installation
Guide
SH19-4543
Customizing
and
tuning
Tivoli
Workload
Scheduler
for
z/OS
Customization
and
Tuning
SH19-4544
Controlling
and
monitoring
the
current
plan
Controlling
and
Monitoring
the
Workload
SH19-4547
Interpreting
messages
and
codes
Messages
and
Codes
SH19-4548
Writing
application
programs
Programming
Interfaces
SH19-4545
Quick
reference
Quick
Reference
GH19-4541
Diagnosing
failures
Diagnosis
Guide
and
Reference
LY19-6410
Using
LookAt
to
Look
Up
Message
Explanations
LookAt
is
an
online
facility
that
lets
you
look
up
explanations
for
most
messages
you
encounter,
as
well
as
for
some
system
abends
and
codes.
Using
LookAt
to
find
information
is
faster
than
a
conventional
search
because
in
most
cases
LookAt
goes
directly
to
the
message
explanation.
You
can
access
LookAt
from
the
Internet
at:
http://www.ibm.com/eserver/zseries/zos/bkserv/lookat/
or
from
anywhere
in
z/OS
or
z/OS.e
where
you
can
access
a
TSO/E
command
line
(for
example,
TSO/E
prompt,
ISPF,
z/OS
UNIX
System
Services
running
OMVS).
The
LookAt
Web
site
also
features
a
mobile
edition
of
LookAt
for
devices
such
as
PCs,
Palm
OS,
or
Linux-based
handhelds.
So,
if
you
have
a
handheld
device
with
wireless
access
and
an
Internet
browser,
you
can
now
access
LookAt
message
information
from
almost
anywhere.
To
use
LookAt
as
a
TSO/E
command,
you
must
have
LookAt
installed
on
your
host
system.
You
can
obtain
the
LookAt
code
for
TSO/E
from
a
disk
on
your
(SK3T-4270)
or
from
the
LookAt
Web
sites
Download
link.
Accessing
Publications
Online
IBM
posts
publications
for
this
and
all
other
Tivoli
products,
as
they
become
available
and
whenever
they
are
updated,
to
the
Tivoli
Software
Information
Center
Web
site.
The
Tivoli
Software
Information
Center
is
located
at
the
following
Web
address:
Preface
xiii
|
||||
||||
||||
|||
|
||||
http://www.ibm.com/eserver/zseries/zos/bkserv/lookat/
http://publib.boulder.ibm.com/tividd/td/tdprodlist.html
Click
the
Tivoli
Workload
Scheduler
for
z/OS
link
to
access
the
product
library.
Note:
If
you
documents
on
other
than
letter-sized
paper,
select
the
Fit
to
page
check
box
in
the
Adobe
Acrobat
dialog.
This
option
is
available
when
you
click
File
Print.
Fit
to
page
ensures
that
the
full
dimensions
of
a
letter-sized
page
on
the
paper
that
you
are
using.
Softcopy
Collection
Kit
All
the
books
in
the
Tivoli
Workload
Scheduler
for
z/OS
library,
except
the
licensed
publications,
are
available
in
displayable
softcopy
form
on
CD-ROM
in
the
following
Softcopy
Collection
Kit:
v
OS/390,
SK2T-6951
You
can
read
the
softcopy
books
on
CD-ROMs
using
these
IBM
licensed
programs:
v
Softcopy
Reader
v
BookManager
READ/2
v
BookManager
READ/DOS
v
BookManager
READ/6000
All
the
BookManager
programs
need
a
personal
computer
equipped
with
a
CD-ROM
disk
drive
(capable
of
reading
disks
formatted
in
the
ISO
9660
standard)
and
a
matching
adapter
and
cable.
For
additional
hardware
and
software
information,
refer
to
the
documentation
for
the
specific
BookManager
product
you
are
using.
Updates
to
books
between
releases
are
provided
in
softcopy
only.
Ordering
Publications
You
can
order
many
Tivoli
publications
online
at
the
following
Web
site:
http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi
You
can
also
order
by
telephone
by
calling
one
of
these
numbers:
v
In
the
United
States:
800-879-2755
v
In
Canada:
800-426-4968
In
other
countries,
see
the
following
Web
site
for
a
list
of
telephone
numbers:
http://www.ibm.com/software/tivoli/order-lit/
Providing
Feedback
about
Publications
If
you
have
comments
or
suggestions
about
Tivoli
products
and
documentation,
complete
the
customer
feedback
survey
at
the
following
Web
site:
http://www.ibm.com/software/sysmgmt/products/support
xiv
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
|
|
||||
|
||||
||||||
|||||
|
|
|
|||
|
|
|
|
|
|
||
|
http://publib.boulder.ibm.com/tividd/td/tdprodlist.htmlhttp://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgihttp://www.ibm.com/software/tivoli/order-lit/http://www.ibm.com/software/sysmgmt/products/support
Contacting
IBM
Software
Support
If
you
have
a
problem
with
any
Tivoli
product,
you
can
contact
IBM
Software
Support.
See
the
IBM
Software
Support
Guide
at
the
following
Web
site:
http://techsupport.services.ibm.com/guides/handbook.html
The
guide
provides
information
about
how
to
contact
IBM
Software
Support,
depending
on
the
severity
of
your
problem,
and
the
following
information:
v
Registration
and
eligibility
v
Telephone
numbers
and
addresses,
depending
on
the
country
in
which
you
are
located
v
Information
you
must
have
before
contacting
IBM
Software
Support
Conventions
Used
in
This
Guide
The
guide
uses
several
typeface
conventions
for
special
terms
and
actions.
These
conventions
have
the
following
meanings:
Information
type
Style
convention
Example
Commands
All
capital
letters
CREATE
References
in
the
text
to
fields
on
panels
All
capital
letters
QUANTITY
Input
you
should
type
in
panel
fields
Monospace
MYAPPLICATION
First
time
new
term
introduced
Italics
Application
Preface
xv
|
||
|
||
|
||
|
http://techsupport.services.ibm.com/guides/handbook.html
xvi
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
Part
1.
Programming
Interfaces
1
2
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
Chapter
1.
The
Program
Interface
(PIF)
This
chapter
describes
the
Tivoli
Workload
Scheduler
for
z/OS
program
interface
(PIF),
which
lets
a
user-written
program
issue
various
requests
to
the
Tivoli
Workload
Scheduler
for
z/OS
subsystem.
For
example,
you
can
automate
actions
that
you
perform
through
the
Tivoli
Workload
Scheduler
for
z/OS
dialogs.
The
program
interface
supports
these
basic
requests:
Database
requests
v
Read
and
update
information
from
the
application
description
and
operator
instruction
databases.
v
Read
information
from
the
workstation
description
and
calendar
databases.
LTP
requests
Read
and
update
occurrences
in
the
LTP
data
set.
Current
plan
requests
Read
and
update
this
information
in
the
current
plan
data
set:
v
Occurrences
v
Operations
v
Workstations
The
program
interface
is
supported
using
a
Tivoli
Workload
Scheduler
for
z/OS-supplied
communication
subroutine,
EQQYCOM.
Program
Interface
Samples
The
Tivoli
Workload
Scheduler
for
z/OS
sample
library
shipped
with
the
Tivoli
Workload
Scheduler
for
z/OS
programs
contains
many
sample
programs
that
use
the
program
interface
function.
These
programs
will
execute
successfully
with
a
few
minor
changes
to
suit
your
installation.
You
can
continue
to
run
them
as
they
are,
or
use
them
as
a
model
to
create
your
own
programs.
See
Appendix
C,
Sample
Library
(SEQQSAMP),
on
page
231
for
a
description
of
the
PIF
sample
members
provided
in
the
SEQQSAMP
library.
Related
Tools
Tivoli
Workload
Scheduler
for
z/OS
is
delivered
with
some
tools
that
take
advantage
of
the
PIF.
These
tools
are
provided
as
additional
aids
in
the
process
of
automating
workload
management
with
Tivoli
Workload
Scheduler
for
z/OS.
Batch
Command
Interface
Tool
A
Batch
Command
Interface
tool
is
supplied
to
perform
some
of
the
actions
supplied
by
the
PIF
interface
by
means
of
a
batch
command
interface.
See
Chapter
3,
Batch
Command
Interface
Tool,
on
page
83
for
more
information
about
how
to
use
this
tool.
Refer
to
EQQYCBAT
sample
for
link-editing
and
running
this
tool.
Tivoli
Workload
Scheduler
for
z/OS
Control
Language
The
Tivoli
Workload
Scheduler
for
z/OS
Control
Language
(OCL)
is
a
REXX
program,
EQQOCL,
delivered
in
the
Tivoli
Workload
Scheduler
for
z/OS
3
EQQMISC
library,
that
allows
some
of
the
Tivoli
Workload
Scheduler
for
z/OS
data
to
be
handled
from
a
simple
REXX-like
interface.
This
tool
can
be
used
by
running
EQQOCL
as
a
compiled
REXX
program
in
a
batch
TSO
environment.
You
may
want
to
run
it
in
a
separate
job,
or
as
a
step
of
your
production
JCL.
The
tool
is
described
in
Chapter
4,
Control
Language
(OCL),
on
page
113.
The
following
members
of
Tivoli
Workload
Scheduler
for
z/OS
Sample
libraries
are
also
supplied
to
help
you
use
the
tool:
EQQYRJCL
A
sample
JCL
to
run
the
tool
EQQYRPRC
A
sample
procedure
to
invoke
EQQOCL
EQQYRMSG
Contains
the
messages
issued
by
the
EQQOCL
tool
EQQYRPRM
A
sample
input
parameter
member
The
OCL
tool
requires
the
IBM
Compiler
Libraries
for
REXX/370
Version
1.3.0,
Program
Number
5695-014.
The
Compiler
Libraries
must
be
installed
on
the
system,
and
the
TSO
Compiler
Programming
Table,
IRXCMPTM,
must
be
customized
and
the
Compiler
Libraries
modules
must
be
made
available
to
TSO.
Refer
to
the
Compiler
Libraries
for
REXX/370
manuals
for
more
information.
The
OCL
tool
calls
the
STORAGE
program,
available
in
the
Tivoli
Workload
Scheduler
for
z/OS
Sample
library
member
EQQRXSTG.
If
the
WTO
function
is
used,
OCL
calls
the
IPOWTO
program,
available
in
the
scheduler
sample
library
member
EQQOCWTO.
If
the
UPD
function
is
used,
OCL
calls
the
PIFTEST
program
available
in
Tivoli
Workload
Scheduler
for
z/OS
sample
library
member
EQQPIFJV.
This
sample
program
requires
the
PL/I
compiler
and
runtime
libraries.
The
STORAGE
program,
and
optionally
IPOWTO
and
PIFTEST
programs,
must
be
link-edited
and
made
available
to
OCL
at
runtime.
Communicating
with
EQQYCOM
Requests
to
Tivoli
Workload
Scheduler
for
z/OS
to
perform
particular
actions
are
calls
to
EQQYCOM,
using
normal
z/OS
linkage
conventions.
You
must
create
a
program
that
calls
EQQYCOM
and
provide
it
with
the
necessary
instructions,
such
as
a
parameter
list,
to
enable
Tivoli
Workload
Scheduler
for
z/OS
to
perform
the
required
action.
With
each
call
to
EQQYCOM,
you
can
make
one
Tivoli
Workload
Scheduler
for
z/OS
request.
EQQYCOM
can
be
linked
with
the
modules
from
which
it
is
called,
or
it
can
be
created
as
a
separate
load
module
and
control
passed
to
it
using
the
link
macro.
If
you
create
EQQYCOM
as
a
separate
load
module
and
frequent
calls
are
required,
you
should,
for
performance
reasons,
consider
placing
EQQYCOM
in
the
link-pack
area.
All
modules
in
the
same
job-step
must
be
in
an
APF-authorized
library.
The
first
module
loaded
at
the
start
of
the
job-step
must
also
be
link-edited
with
the
APF-authorized
attribute.
In
the
TSO
or
TSO-batch
environment,
you
need
not
have
the
PIF
program
authorized.
Details
of
your
request
to
Tivoli
Workload
Scheduler
for
z/OS
are
a
parameter
list
that
you
pass
to
EQQYCOM.
Before
passing
control
to
EQQYCOM,
you
must
load
the
address
of
your
parameter
list
into
general
purpose
register
1.
4
Tivoli
Workload
Scheduler
for
z/OS
Programming
Interfaces
Attention:
If
you
want
to
run
a
PIF
program
from
a
Tivoli
Workload
Scheduler
for
z/OS
dialog,
ensure
that
your
PIF
program
is
invoked
as
a
separate
task.
Otherwise,
your
dialog
session
will
end
when
the
PIF
program
has
completed.
For
example,
you
can
run
a
REXX
exec
that
executes
your
PIF
program
using
the
ATTACH
command.
Calling
EQQYCOM
from
exits
that
are
taken
by
the
controller
address
space
is
not
supported
and
will
cause
unpredictable
results
if
attempted.
Required
Data
Sets
When
you
use
the
program
interface,
allocate
the
data
sets
identified
by
these
ddnames
to
each
address
space
where
your
program
runs:
EQQMLIB
Tivoli
Workload
Scheduler
for
z/OS
message
library.
EQQMLOG
Data
set
for
messages
from
the
program
interface.
Note:
An
extra
message
log
is
required
for
each
additional
INIT
request
made
before
a
TERM
request,
or
when
PIF
is
invoked
by
a
program
or
started
task
that
already
uses
the
EQQMLOG
data
set
allocated
to
the
caller
address
space.
See
INIT
Request
on
page
21
for
more
information.
Optional
Data
Set
EQQYPARM
Parameter
file
for
specifying
the
INIT
initialization
statement.
EQQYPARM
must
reference
a
sequential
data
set
or
a
member
of
a
partitioned
data
set
whose
logical
record
length
is
80
bytes.
Attention:
The
//EQQYPARM
DD
*
notation
followed
by
inline
INIT
statements
is
not
allowed
and
might
cause
a
system
X'0C4'
abend.
It
is
recommended
that
you
also
allocate
the
Tivoli
Workload
Scheduler
for
z/OS
diagnostic
data
set,
EQQDUMP.
Debugging
information
is
written
to
this
data
set,
for
example,
Tivoli
Workload
Scheduler
for
z/OS
control
blocks
and
traces.
Error
Messages
When
an
error
occurs
in
a
request,
messages
are
always
written
to
the
message
log
data
set
allocated
to
the
caller
address
space.
The
data
set
is
either
EQQMLOG
or
that
specified
in
the
MLOGDDN
argument
of
the
INIT
request.
In
certain
cases,
messages
are
also
written
to
the
EQQMLOG
data
set
allocated
to
the
Tivoli
Workload
Scheduler
for
z/OS
subsystem
to
which
your
requests
are
directed.
Errors
related
to
the
request
itself
(for
example,
a
spelling
error
in
a
parameter
argument)
result
in
a
message
written
only
to
the
message
log
allocated
to
the
caller
address
space.
Errors
related
to
the
Tivoli
Workload
Scheduler
for
z/OS
subsystem
(for
example,
an
error
detected
by
Tivoli
Workload
Scheduler
for
z/OS
data
validation)
result
in
a
brief
message
to
the
caller
message
log.
A
more
detailed
message
about
the
error
is
written
to
the
EQQMLOG
allocated
to
the
Tivoli
Workload
Scheduler
for
z/OS
subsystem.
Chapter
1.
The
Program
Interface
5
Parameter
Overview
The
parameter
list
contains