GC21 5162 1_System3_15_System Control Programming Ref_Sep79 1 System3 15 System Ref Sep79

GC21-5162-1_System3_15_SystemControlProgrammingRef_Sep79 GC21-5162-1_System3_15_SystemControlProgrammingRef_Sep79

User Manual: GC21-5162-1_System3_15_SystemControlProgrammingRef_Sep79

Open the PDF directly: View PDF PDF.
Page Count: 528

DownloadGC21-5162-1_System3_15_System Control Programming Ref_Sep79 GC21-5162-1 System3 15 System Ref Sep79
Open PDF In BrowserView PDF
IBMSystem/3Model15
SystemControlProgramming
Manual
Conceptsand Reference
ProgramNumber5704-SC2
aaaaa
aaaa
aaaaa
aaaaaaa
aaaaaa
aaaaaaaaa
aaaaaaa aaaaaaaaaaa
aaaaaaa aaaoaaaaaaa
aaaa
aaaa
aoaa
aaao
aaaa
aaaa
aaaa
aoaa
aaaa
aaaoaaaaaaaa aaaoaa
aaaaaaaaaaoa aaooaa
aaaaa
aaaaaaoaaa
aaaa
aaaaaaao
aoaaaa

[-

aoaaa
aaaa
aaaaaaa
aoaaa
aaaaoa
aaaaaaaaa
aaoooaa aaaaaaaaaaa
aaaaaaa aaaaaaaaaaa
oaaa
oaaa
aaaa
aaaa
aaaa
aaaa
aaaa
aaaa
aaaa
aaaaaaaaaaaa aaaaao
aaaaaaaaaaaa aaaaaa
aaaaa
aaoaaaaaaa
aaaa
aooaaaaa
aoaaaa

aaaa
aaaa
aaaa
aaaa
aa aaaaaaaaaa aaaaa a
aa aaaaaaaaa aaaaaaa
aa aoaaaaaaa aaa aaaa
aoaoa aa aaa aaaaaaoo
aaaa
aaaa
aaaa
aaaa
aaaa
aaao
aaaa
aaaa
aaaa
aaaaaa aaaa aaaaaa
aaaaaa
aaoaaa
aaaaaa
aaaaaa
oaaaaa
aaaoaa

t*

--\

---------

aaoaaa
aaaa
aaaaao
aaaaa
aaaaaa
aaaaao
aaaaao
aaaaaaa
aoaa
aaaaaaa aaaa
aaaa
aaaa
ooaoo
aaaa
aaaoaa aaoa
aoaa
aaaaaaaaaao
aoaaaaooaaaaaaaaaaa
aaaoaa
oaaaoaaaaaa
aaoaa
aaaooaaaaa
aaoa
oaoooaaa
oaoooa

GC215162-1
FileNo.33-36

Preface

programmers
with the information
Thismanualprovides
needed
to run programs
on the IBM System/3Model15
andto usethe systemserviceprogramsfor doingjobs
suchaspreparing
disksfor useor updatingsystem
libraries.SeeHow To U* ThisManualfor additional
information.

. IBM SystemB3741 Reference
Manual,GC21'5113

R€latedPublications

. IBM Syshm/3 OverlayLinkageEditor ReferenceManual,
GC21-7561

o IBM System/3Model 15 User'sGuideto Spooling,
GC21'7632
o IBM System/3Model 15 SystemControlPrognmming
Manual,GC21-7608
MrcrosReference

o l8M System/3Model l5 lntroduction,GC2l-5094
o IBM System/3 DiskConcept and PlanningGuide,
GC21-7571
. tBM Systan/3Modetl5 Operator'sGuide,GC21-5075
o IBM SystemRModel 15 SystemGenerationReference
Manual,GC21-7616

o IBM SystemB Multiline/Multipoint Binary Synchronas
CommunicationsRefercnceManual,GC21-7573
/Vofe.'Informationaboutthe systemcontrolprogram
(ProgramNumber5704-SCl)is in the IBM System/S
Model 15 SystemControl ProgrammingReferenceManual,
'
GC21'5O77

e IBM SystemBModel l5 SystemMewges,GC21-5076
. IBM System/3CommunicationsControl Program
Mesages
Manual,GC21-5170
. IBM System/3CommunicationsControl Program
SystemReferenceManual,GC21-7620

Second Edition (September 1978)
This is a major revisionof , and obsoletes,GC21-5162-0
and technicalnewsletterGN21-5550.
Because
the changesand additionsare extensive,this publicationshouldbe reviewedin its
entirety.
Changes
areperiodicallymadeto the informationherein;beforeusingthis publicationin
connectionwith the operation of IBM systems,refer to the latest IBM System/3 Bibliography,
GC20-8080for the editionsthat areapplicableand current.
Usethis publicationonly for the purposesstatedin the Preface.
Publications
are not stockedat the addressbelow. Requests
for copiesof I BM publicationsand
for technicalinformationabout the systemshouldbe madeto your IBM representative
or to
the branchoffice servingyour locality.
This publicationcould containtechnicalinaccuracies
or typographicalerrors. Usethe Reader's
CommentForm at the back of this publicationto makecommentsabout this publication. lf
the form hasbeenremoved,addressyour commentsto IBM Corporation.Publications,
Department245, Rochester,Minnesota55901. IBM may useand distributeany of the information you supply in any way it believesappropriatewithout incurringany obligationwhatever. You may, of course,continueto usethe informationyou supply.
@CopyrightInternationalBusiness
MachinesCorporation1976. 1978

Pag€of GC21-5162-1
lssued28 Septembor1979
By TNL: GN21-5674

Contents

HOWTO USETHIS MANUAL

tx

PART 2. SYSTEMCONCEPTS
AND FACILITIES

MODEL 15D INTRODUCTION

xi

PROGRAM FACILITIES
S y s t e m / 3 M o d e l 1 5 P r o g r a m m i n gS u p p o r t
Program Concepts
SourcePrograms
Object Modules
Load (lodules
P r o g r a ma n d P a r t i t i o n S i z e s
Greater Than 48K Programs
External Buffers
FILE FACILITIES
File Definition
File Organization
File Processing
File Creation
File Location
Automatic File Allocation
File Services
Scheduler Work Area
File Sharing
Compatible Access Methods for File Sharing
DTF (Define the Filel
S D T F ( S h a r eD e f i n e t h e F i l e )
FSOE (File Share Clueue Elementl
Fife Share Area
Doubly-Defined Files
C o n s i d € r a t i o n sa n d R e s t r i c t i o n s
G e n e r a l R e s u l t sW h e n t h e 2 o r 3 O p t i o n i s
Selected for a Message
Work Files
M a i n S t o r a g eR e q u i r e m e n t s
RPG II

PART 1. OCL STATEMENTS

1-1

INTRODUCTIONTO OCL STATEMENTS

1-3
1-3
1-3

What is OCL?
OCL and the Job Stream
O r g a n i z a t i o no f P a r t 1
Coding Rules
Types of Information
G e n e r a lC o d i n g R u l e s
Statement Length

S T A T E M E N TD E S C R
IPTIONS
ASSIGN STATEMENT
BSCA STATEMENT
CALL STATEMENT
COMPILESTATEMENT
DATE STATEMENT

F I L E S T A T E M E N T( S I N G L EV O L U M ED I S K F I L E S }
F I L E S T A T E M E N T( M U L T I V O L U M E
D t S KF I L E S }
F I L E S T A T E M E N T( S I N G L EV O L U M ET A P EF T L E S }
7-TrackConsiderations
TapeFile StatementSummary
Combinationsof 7-TrackSpecifications
F I L E S T A T E M E N T( M U L T I V O L U M E
T A P EF I L E S )
F I L E S T A T E M E N T{ M U L T I P L ET A P EV O L U M E S }
Prepositioned
Tapes(SEONUM-Xon the FILE
Statementl
Restrictions on the Use of Multif ile Tapes
Standard Labeled Files
Nonstandard Labeled Files
U n l a b e l e dV o l u m e s
R E E L P a r a m e t e ro n F I L E S t a t e m e n t
F I L E S T A T E M E N T ( D E V I C E I N D E P E N D E N TF I L E S }
HALT STATEMENT

IMAGESTATEMENT
Characters from the System Input Device
Characters from the Source Library

I N C L U D ES T A T E M E N T
J O BS T A T E M E N T
L O A DA N D L O A D * S T A T E M E N T
LOG STATEMENT
N O H A L TS T A T E M E N T
PAUSESTATEMENT
P R I N T E RS T A T E M E N T
PUNCHSTATEMENT
R E A D E RS T A T E M E N T
R U NS T A T E M E N T
SWITCHSTATEMENT
/& STATEMENT
/. STATEMENT
r(COMMENT} STATEMENTS

/. STATEMENT

'14

14
14
14
1-6
1-8
1-21
1-23
1-24
1-25
1-27
1-29
1-40
1-45
1-52
1-53
1-U
1-55
1-57
1-58
1-58
1-59
1-61
1-61
1-62
1-63
1-65
'|-66
1-67
1-67
1-69
1-71
1-75
1-79
't-42
1-84
1-85
1-88
1-91
'l-92
1-93
1-95
1-96
1-99
1- 1 0 0

2-1
2-3
2-3
24
24
24
2-5
2A
28
2-9
2-11
2-11
2-11
2-11
2-12
2-13
2-13
2-15
2-15
2-16
2-17
2-17
2-17
2-18.1
2-18.1
2-18,1

2-18.2
2-19
2-20
2-20
2-21
2-21
2-21
2-22
2-22
2-23
2-2s
2-24
2-25
2-25
2-25
2-26
2-26.1
2-26.1

COBOL
FORTRAN
CCP/DiskSort
Basic Assembler
Overlay Linkage Editor
Large Index Files
Multivolume Disk Files
Multivolume Tape Files
Multifile Tape Volumes
Null Files on Tape
Programmi ng Considerations
LIBRARY FACILITIES
Library Definition
SourceLibrary
Object Library
Library Locations
Storing Programs
Sample Statements
Procedures
Example
Nested Procedures
Cataloging to an Active Library
User Considerations
SYSTEMFACILITIES
Initial Program Load (lPL)
P r o g r a mE x e c u t i o n
Job and Step Processing

.

2-26.1
2-2t
2-29
2-30
2-31
2-32
2-33
2.35
2-39
241
242
242
243
244

Contents

iii

P a g eo f G C 2 1 - S 1 6 2 _ 1
lssued 28 September 197g
By TNL: cN21-5674
External Indicators
System Severity Codes
Job Stream Example
Multiprogramming
Operatingin a-Muttiprogramming
Environment'
MultiprogrammingConsiderations
and
Restrictions
Sharing Access to Added Reco;ds'
. : . .
Multiprogramming Examples
_
Date Support
System Date
Partition Dare
IntervalTimer
System lnput Device
System Log Device
System Print Device
.
System Punch Device
System History Area
Spooling
Checkpoint/Restart
.
Inquiry Program
.
System Integrity
,
Automatic MessageRestart (Unit
Record nestart)
Unit Record Restart (System Generation
Option)
Restart (System Generation Option)
.. .Extended
Main Storage Usage

PART 3. DISK STORAGE

2-57
2_s9
2-60
2€3
2-63
2-63
2-63
2-64
2-65
2-66
2-66
2-66
2-67
2-68
2-69
2€9
2-70
2-70
2-70
2-71
3-1

DIRECTACCESSSTORAGE
3340 Direct Access Storage Facility
3344 Direct Access Storage
Simulation Areas
Inrerchanging Data Modules (3340)
A c c e s s i n gS i m u l a t i o n A r e a s
A s s i g n i n gS i m u l a t i o n A r e a s
Simulation Area Reassignment
Number of Simulation Area Assignments
Main Data Areas
D i s k S p a c eA l l o c a t i o n
Considerations and Restrictions
Alternate Tracks
File ProcessingConsideraflons
Cylinder 0 Format
Considerations and Restrictions
Initial Program Load (lpL)

PART 4. SYSTEMSERVICEPROGRAMS
INTRODUCTION
ProgrammingConsiOerations

'

248
248
248
2-52
2-53

_

Control Statements
Writing Control Statements for
System
Service Programs
Coding Rules
END Control Statement
Placement of Control Sratements
in the
Job Stream
't"tt"rr,
Special Meaning of Capital
wumbers,
and Special Characters
Device Codes
. .

3-3
3-3
34
3-6
3-6
3-7
3-7
3-9
3-9
3-10
3-10
3-10
3 - 11
3-11
3-12
3-13
3-13
4-1
4-3
44
44
44
4-5
4-5
4-5
4-5
4-6

A L T E R N A l - ET R A C K A S S I G N M E N T
PROGRAM_$ALT
ProgramDescription

4-7
4-7
4-7
4€
4€
4€
4€
. 4 €
4a
4-9
4-9
4.10
4-10
4-10
4.10
4-11

Control Statement Summary
Parameter Summary
Parameter Descriptions
PACK Parameter
UNIT Parameter
VERIFY Parameter
ASSIGN Farameter
Unconditional Assignment
Conditional Assignment
OCL Considerations
Examples
Conditional Assignment
Unconditional Assignmenr
Messagesfor Alternate Track Assignment
ALTERNATf: TRACK REBUTLD

PROGRAM--$BUILD
ProgramDescription

4-12
4-12
4-12
4-13
4-14
4-14
4-14
4-14
4-14
4-14
4-14
4-15
4-15

Control Statement Summary
Parameter and Substitute Data
Summary
Parameter ancl Substitute Data
Descriptions
PACK Parameter
UNIT Parameter
TRACK Perrameter
LENGTH |tarameter
DISP (Displacementl parameler
Substitute Data
OCL Considerrations
Examples

C O NF I G U R A I O N R E C O R DP R O G R A M $CNFIG

4-17
+17
4-17
4-r8
4-20
4-22

Program Description
Changing the Configuration Record
Control Statenrent Summary
Parameter Surnmary
P a r a m e t e rD e s c r i p t i o n s.

AUTHORT:ZEp"r"-"t"rtOCOpVi
: :

C A R D P a r a m e t e r( D E F C N )
Code-Area Parameter (ASNpx)

:

:

:

4-22
4-22
4-22
4-22
4.22
4-22.1

CYL Pararneter
(SpCyL)
D Parameter(TSTAMpt'
D A T E P a r a r n e t e r ( F O R M A T ) ..
: . : : : :
oEVtCE Parameter
(LOGPx,sYtNx,
SYPCx,SYpRx)
4.22.1
EJECTor NOEJECTpararn."r.
tf_OCiri . : : : 4-22.1
ERASEparameter(OCOpy)
. . : : : . +22.1
EXTENDEOparameter(READY)
. : : . 4-22.1
FORMParametor
(DEFFN)
4-22.1
FS Parameter
(SIZE)
4-22.1
HALT Paranreter
(HLTpx)
4.22.1
HALT Paranreter(SHAI
4-22.1
I Parameter{TSTAM;i
4-22.2
I D E L E T E p a r a m e t e r t i r V p e t ..
: : : : : : 4-22.2
M Parameter(SpOpT)
4.22,2
OCL Parameter
(BLANK) '
+22.2
PACK paramet"i tcnil6f
4-22.2

. : . : : 4-22.2
:llllJ.p:rameter(AUrii,aJrwrr'
PUNCHPararneter
(AUTST,
Pl Parameter
{SIZE)
P 2 P a r a m e t e r( S I Z E )

AUTWT)

4-22.2
4-23
4-23

Pagoof GC21-5162-1
lssued28 Soptemb€r1979
By TNL: GN21-5674
(SIZE)
P3 Parameter
R A T I O P a r a m e t e r( F S H A R E )
R E A D P a r a m e t e r( n U T S T )
R E T A I N P a r a m e t e r( M E S S A G )
ROPTY Parameter (OCOPY)
S E O U E N C E P a r a m e t e r( P Rl O R l T Y l
S H A R E P a r a m e t e r( C O N S O L )
S H A R E P a r a m e t e r( F S H A R E )
S Y S P a r a m e t e r( S I Z E )

(SHA)
TRACKSParameter
TRACKS Parameter(SPEXT)
U N I T P a r a m e t e r( S P D S K I
C o n s i d e r a t i o n sa n d R e s t r i c t i o n s
OCL Considerations
Examples

COPY/DUMPPROGRAM_$COPY
Program Description

COPYPACK.
COPYFILE
Control Statement Summary
Parameter Summary
P a r a m e t e rD e s c r i p t i o n s
F R O M a n d T O P a r a m e t e r s( C O P Y P A C K )
PACKIN and PACKO Parameters

(COPYPACK)
COPYPACK Considerations
O U T P U T P a r a m e t e r( C O P Y FI L E )
D E L E T E P a r a m e t e r( C O P Y Fl L E l
R E O R G ( R e o r g a n i z eP) a r a m e t e (r C O P Y F I L E )
L E N G T H P a r a m e t e r( C O P Y FI L E )
K E Y a n d P K Y P a r a m e t e r s( S E L E C T )
R E C O RD P a r a m e t e r s( S E L E C T )
F l L E P a r a m e t e r( S EL E C T )
L E N G T H a n d L O C A T I O N P a r a m e t e r s( K E Y )
D A T A M G M T P a r a m e t e r( O U T D M )
F R O M P a r a m e t e r( A C C E S S )
C Y L I N D E R P a r a m e t e r( A C C E S S I
S E C T O R P a r a m e t e r( A C C E S S )
T R A C K P a r a m e t e r( A C C E S S )
R E C L P a r a m e t e r( A C C E S S )
D I S P P a r a m e t e r( A C C E S S I
Copying Multivolume Files
M a i n t a i n i n gP r o p e r V o l u m e S e q u e n c e
Numbers
M a i n t a i n i n gC o r r e c t R e l a t i v eR e c o r d
Numbers
Direct File Attributes
Copying Multivolume Indexed Files
Tape File Considerations
Diskette File Considerations
Card Inout Considerations
Card Output Considerations
F ile Recovery Considerations
OCL Considerations
Examples

DUMP/RESTORE PROGRAM_$DCOPY
P r o g r a mD e s c r i p t i o n
Control Statement Summarv
P a r a m e t e rS u m m a r y
Parameter Descriotions
F R O M a n d T O P a r a m e t e r s( C O P Y P A C K )
COPYPACK}
P A C K P A T A M E I E( T
S Y S T E M P a r a m e t e r( C O P Y P A C K )
B A C K U P P a r a m e t e r( C O P Y P A C K )
Dump/RestoreConsiderations

4-23
4-24
4-24
4-24
4-24
4-24
4-24.1
4-24.1
4-24.1
4-24.1
4-24.1
4-24.1
4-24.1
4.24.2
4-25
4-27
4-27
4-27
4-27
4-29
4-31
4-34
4-34
4-34
4-34
4-34
4-36
4-36
4-36
4-36
4-37
4-37
4-37
4-37
4-37
4-37
4-37
4-38
4-38
4-38
4-38
4-38
4-38
4-38
4-38
4-39
4-39
440
4-41
4-41
4-41
442
4-62
4-62
4-62
4-63
4-63
4-63
4-64
4-64
4-U
4-65

OCL Considerations
Fl LE Statement Considerations
Messagesf o r D U M P / R E S T O R E
Examples
F ILE Statement: From Disk to Tape
Control Statements
FILE Statement: From Tape to Oisk
Control Statement: From Disk to Diskette
Control Statement: From Disk to Tape
P r o g r a m m i n gC o n s i d e r a t i o n s
FILE DELETE PROGRAM-$DELET
Program Descriptron
Deleting Files
F r e e i n gS p a c eo n a n A r e a
Control Statement Summary
P a r a m e t e rS u m m a r y
P a r a m e t e rD e s c r i D t i o n s
PACK Parameter
UNIT Parameter
LABEL Parameter
DATE Parameter
DATA Parameter
OCL Considerations
Examples
D e l e t i n g O n e o f S e v e r a lF i l e s H a v i n g t h e
Same Name
F r e e i n gA l l o c a t e d B u t U n u s e d S p a c e o n a n A r e a
F I L E C O M P RE S S P R O G R A M - $ F C O M P
Program Description
Move and Copy Functions
Move Function
Copy Function
Backup and RestoreFunctions
Backup Function
RestoreFunction
Control Statement Summary
P a r a m e t e rS u m m a r v
P a r a m e t e rD e s c r i p t i o n
F R O M a n d T O P a r a m e t e r (sC O P Y F I L E )
P A C K I N a n d P A C K O P a r a m e t e r (sC O P Y F I L E S )
C O M P RE S S P a r a m e t e r( C O P Y F I L E S )
F R O M P A T A M E I E( T A P E F I L E S }
T O P a r a m e t e r( T A P E F I L E S )
L A B E L P a r a m e t e r( T A P E F I L E S I
P A C K P a r a m e t e r( T A P E F I L E S )
S E O N U M P a r a m e t e r s( T A P E F I L E S I
C O M P R E S SP a r a m e t e r ( T A P E F I L E S )
C o n s i d e r a t i o n sa n d R e s t r i c t i o n s
F i l e S t a t e m e n t C o n s i d e r a t i o n sa n d R e s t r i c t i o n s
(Backup and Restore)
OCL Considerations
Examples

4-65
4-65
4€6
4-66
4-67
4-67
4-68
4-69
4-70
4-70
4-71
4-71
4-71
4-71
4-72
4-73
4-74
4-74
4-74
4-74
4-74
4-74
4-75
4-75
4-75
4-77
4-74
4-78
4.78
4.78
4-78
4.79
4-79
4-79
4-80
4-80
482
4-82
4-82
4-a2
4-82
4-82
4-82
4-82
482
4-83
4-83
4-83
484
4.84

S Y S T E MH I S T O R YA R E A D I S P L A Y
PROGRAM-$HIST
P r o g r a mD e s c r i p t i o n
Control StatementSummary
P a r a m e t e rS u m m a r y
P a r a m e t e rD e s c r p
i tions
H ISTORY Parameter
OCL Considerations
Examples
DISK IN ITIALIZATION PROGRAM_$INIT
P r o g r a mD e s c r i p t i o n
Types of Initialization
Control Statement Summary

4-93
4-93
4-94
4-94
4-94
4-9.
4-94
4-97
4-100
4-100
4-100
4-101

Contents

PaSe
of cC2t-S162-l
lssued28 September1979
By TNL: cN21-5674
ParameterSummary
Parameter
Descriptions .
TYPEParameter
(UlNl
UNIT parameter
V E R | F Y P a r a m e t e r . 4 . 1 o 4 R

4'102
4-103
4_103

$MAINT-copy FUNcrtoN
Uses
Control St"t"."nt Srrn;";u
e a d e r - t o - L i b r a r y

.

i;iij:;l$i::
,1fi:ffff,",rurur
ry
. iiii t_::,#::;,"#I"ffi:f:,JA
l,""lll?ff:::TI:'.,,,Hl;,iviu
Parameter
OLDPAcK
summary
t.r"-"i",
4-104

PACKParameter
(voLi

iu6ii

. .

Librarv-to-Library

i 19:

o C L C o n s i d e r a t i o n s . . $ - | U 5 L i b r a r y D i LibraryDirectories
r e c t o r i e s
. : . . . :
l-lff
4'106
Source and object Library Directories
Examples
. .
.
pri--,.,

.

.

f-:^:^r:-

,*:,;t;:J;:'ttlJ,*

M€ss:rses
for Diskrnitiarization

4-128
4-128
4-129
4-129
4-1n
4-129
4-130
4-131
4-131
4-132
4-135
4-135
.
4_135
4_135
4-135
:
4_135
4-135
4-135
4-136
4-136
4-136
4_136
4-137
4_137
4-137
4-138
4-138
4-139
4-146
4-146
4_146
4-147
4-148
4-149
4-149
4-149
4-150
4-151
4-152
4-153
4-153
4-153
4-153
4-154
4-155
4_156
4-167
4-167
4-168
4-171
4-176
4-176
4-176
4-176
4-176
4-176
4-176
4-176
4-176
4-176
4-177
4-177
4-177

. : . : ;-1;
"JJ'Jfl:Jlll'l1iH;l.I*ovor,-",...:i-ji!-jIfi"il,:]::i"|.,iI,",.
: .

; f f ' , * . " T l [ ' . H P R o G R A M _ $ K L E A N . ' 4 - 1 o 8 L e n g t h o f N a m e . . . .
4-log
Restricted Names
OCL Considerations . .
4_108
a.n,rl"r nrith the Same Name
FILE AND VOLUME LABEL.DISPLAY
^
Retain TYPes
PROGRAM-$LABEL
4'109
r'
I uv
Tempora
t empora ry Entries
Program Description
l'rogram
. .
S t o r a g e R e q u i r e m e n t s 4 . 1 0 9 P e r m a n e r | t E n t r i e s
.
4-i09
S i m u l a t i o n A , r e aV e r i f i c a t i o n
C o n t r o l S t a t e m e n tS u r n . " r u
_

s,"*-"n,i
;::il:,::3:lffi,:?il:,
UNfT parameter
LABEL parameter
SORT parameter

.

.

i.ll3 "'l'.:::,:;:1,[;T,,".: .

4_111
4_111
4_l l l
4-111

.

E n t i r e C o n t e n t so f V T O C
M e a n i n go f V T o c t n t o r m a t i o n
Fife lnformation Only

:11'
4'113
4-1 15

Example

File_to-Lilbrary
Library-to_File
Library_to-Library
L i b r a r y - t o _ p r i n t e ra n d / o r C a r d
.$MAINT-DELETE FUNcrtoN
Uses
Control statement Summary

printins
vroc rnro..'",.ion
ro.r*o pires : . .
;:;li::"ji.fiil:f*:,":,.:,
PRoGRAM-SMAINr i-llB
4-117 $MArNr-MODrFy
FUNcrroN. . .
il.tJ#J"Sil;:|^-:t
a'|
4 ' 1 1| 7t
Uses
vses
I f-- ^. ^:-,use of Disk space

organizarionorir,i,s""tio,,-'.......
i:li
:::;ffT;?J::::ff;::f",...:
$MAINT_ALLOCATEFUNCTION
Uses

rer surnmary

conrrorstatements,.,",y
. . . . : . . . i.lll
Considerations and Restrictions

ffi1il?:;?,frXiliT,,i,i:T[,i""

P a r a m e t e rs u m m a r y
Parameter Descripttns
TO parameter

:"tt.
Considerations;and Restrictions
Control Statenrent Summary

.

.

.

l-l]:
4'120
4-121

.
.

:
3?#J::;::"::*:*:"'""'""

4_121

$MAINT_EXI\MPLES

xrsronv;";;;;;,

4.121

spool FILEoopy pRocRAM_gocopy

4-122
4_122
4-123

Program Description
Control Staternent Summary
Parameter summary

sSYSTEM
vqrFM o
^ _ ^ _ ^ ^ ^parameter

WORK parameter
'ACKO parameter
.
using the Allocate run"tio,

i::i #n':::il:ffiI

'
creatins,
sour""
iiu."..1,1rou^q._ir,'o",)
. . iirri

t"."#Jil
f;;El:::;::"r^"rt

Changingthesizeof(Rea||ocating)aSourceParameterDescriptions_CoPYPRTo...'.
Library (SOURCE-number)
.

D e l e t i n ga S o u r c e L i b r a r y ( s o U R c E o )
R e o r g a n i z i n ga s o u r c e L i b r a r y ( s O U R C E - R )
.
creating an object Library (oBJECr-numberl
Changing the size of (Realtocating)
an object
Library(OBJECT-numberl
.
.'.
D e f e t i n ga n O b j e c t L i b r a r y ( O B J E C T - o )
. .
R e o r g a n i z i n ga n O b j e c t L i b r a r y ( O B J E C T _ R )

/

,

compressin ptace(oelecr_ {R
l\
I n u m u e 'f /
\-----'

:
.

4_12s
4_126
4-126

.
.

4-127
4_127
4_127

4-127

FORMSNO paramerer
JOBN parameter
STEpN parameter
LENGTH parameter
REMOVE parameter
ouTpuT parameter
FlLEparamr:ter
HEADER parameter
STop parameter

.

Pageof GC21-5162-1
lssued28 September1979
ByTNL: GN21'5674
P a r a m e t e rD e s c r i o t i o n s - C O P Y P C H O
UNIT Parameter
CARDNO Parameter
JOBN Parameter
STEPN Parameter
REMOVE Parameter
OUTPUT Parameter
FILE Parameter
HEADER Parameter
STOP Parameter
Parameter Descriotions-COPYR DRO
UN lT Parameter
RECL Parameter
INPUT Parameter
FILE Parameter
KEY Parameter
LOKEY Parameter
HIKEY Parameter
LOBEC Parameter
HIREC Parameter
OUTPUT Parameter
JOBN Parameter
PARTITION Parameter
REMOVE Parameter
Parameter Descriptions-COPYCTR L
F I LE Parameter
P a r a m e t e rD e s c r i p t i o n s - D I S P L A Y
UNIT Parameter
OUTPUT Parameter
FILE Parameter
O Parameter
P a r a m e t e rD e s c r i p t i o n s - R E S T O RE
F ILE Parameter
JOBN Parameter
STEPN Parameter
FORMSNO Parameter
CARDNO Parameter
STOP Parameter

OUTPUTParameter
UNlT Parameter
Parameter Descriptions-COPYO
O Parameter
FROM Parameter
TO Parameter
JOBN Parameter
STEPN Parameter
REMOVE Parameter
PARTITION Parameter
PRIORITY Parameter
FORMSNO and CARDNO Parameter
P a r a m e t e rD e s c r i p t i o n s - A U T H O R I Z E
LIST Parameter
Parameter Descriotions-CLASSI FY
PROGRAM Parameter
U N I T P a r a m e t e r.
CLASS Parameter
LIBRARY Parameter
PACK Parameter
S p o o l F i l e C o n s i d e r a t i o n sa n d R a s t r i c t i o n s
FILE Requirements
Partition Size Requirements
Copy the Entire Spool File (COPYSPI
Copy Selected Job Steps from the Print
Oueue (COPYPRTO
Copy Selected Job Steps from the Punch
Oueue (COPYPCHOI

4-177
4-177
4-177
4-177
4-177
4-177
4-174
4-178
4-178
4-174
4-178
4-',t78
4-174
4-178
4-179
4-179
4-179
4-179
4-180
4-180
4-180
4-180
4-180
4-180
4-181
4-181
4-181
4-181
4-181
4 - 18 1
4-181
4-'t82
4-182
4-142
4-182
4-142
4-182
4-142
4-182
4-182
4-1t|:t
4-183
4-183
4-183
4-183
4-183
4-183
4-183
4-183
4-183
4-183
4-183
4-1W
4-184
4-184
4-1U
4-184
4-1U
4-1U
4-184
4-18r'.
4-184
4-184.1
4-190

Copy JobsTo or From the ReaderOueue
(COpyRDRo) .
from a File
ReadControlStatements
(coPYcrRL)
Copy a Displayof the Statusof the Spool
Oueues(DISPLAY)

4-192
4-194
4-194

Restore Print or Punch Queue Records From a

4-195

F i l e( R E S T O R E )
Copy Selected Job Steps F r o m O n e S p o o l F i l e
to Another (COPYO)
CHANGE THE AUTHORIZ FILE (AUTHORIZE}
Authorization Fields
CreateAuthorization Record
Change Authorization Record
Defete Authorization Record
A S S T G NA C L A S S N U M B E R T O A

4-195
4-196
4-196
4-196'2
4-196'2
4'196'2

PROGRAM {CLASSIFY}
OCL Considerations
Examples
U s i n gt h e S p o o l F i l e C o p y P r o g r a mU n d e r C C P
Program Request
User Authorization
U s i n gt h e S p o o l F i l e C o p y P r o g r a m f r o m a T e r m i n a l
Responding to Error Messages
Placing Jobs on the Reader Oueue from
a Terminal
D i s p l a y i n gt h e S p o o l O u e u e s
CCP Assignment Set
H o w t o R e q u e s t$ O C O P Y F r o m a T e r m i n a l
Examples
C o n s i d e r a t i o n sf o r T e r m i n a t i n g t h e S p o o l F i l e
Copy Program Under CCP
RECOVER INDEX PROGRAM_$RINDX
Program Description
File ldentification
OCL Considerations
C o n s i d e r a t i o n sa n d R e s t r i c t i o n s
Examples
R E A S S I G NA L T E R N A T E T R A C K
PROGRAM_$RSALT
Program Description
Control Statement SummarY
Parameter Summary
Parameter Descriptions
UNIT Parameter
PACK Parameter
S T M U L A TI O N A R E A P R O G R A M _ $ S C O P Y
P r o g r a mD e s c r i p t i o n
Control Statement Summary
Parameter Summary
Parameter Descriotions-COPYAR EA
FROM and TO Parameters
PACK Parameter
AREA Parameter
TONAME Parameter
SYSTEM Parameter
Parameter Descriptions-CLEAR
FROM Parameter
PACK Parameter
AREA Parameter
CLRNAME Parameter
lD Parameter
TYPE Parameter
Parameter Descriptions-N EWNAM E
TO Parameter
PACK Parameter

4-196.3
4-196.5
4-196'5

4-202.1
4-202.2
4-202.2
4-202.3
4-203
4-203
4-203
4-204
4-205
4-206
4-206
4-204
4-208
4-209
4-210
4-210
4-21',1
4-212
4-212
4'212

4-213
4-213
4-213
4-213
4-216
4-2'.t6
4-217
4-219
4-222
4-222
4-222
4-222
4-222
4-222
4-222
4-222
4-222
4-222
4-222
4-222
4-223
4-223
4-223
4-223

Contents

vii

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued 2g September 1979
By TNL: GN2t-5674
AREA parameter
lD Parameter
SYSTEM parameter
CLRNAME parameter
Parameter Descriptions_COpy
lpL
FROM and TO parameters
PACK parameter

.

.

TONAME parameter
P a r a m e t e rD e s c r i p t i o n s _ N A M
ES
PRINT parameter
Parameter Descriptions-MOV;
FROM and TO parameters
PACK parameter
AREA parameter
TONAME parameter
OCL Considerations
Examples
TAPE INITIALTZATION PROGRAM_$TIN
IT
Program Description
.Control Statement Summary
Parameter Summary
OCL Considerations
Printout of Volume Label

Messages
for Tape Initialization
of Votume Label Information
I:1i,"n
. .
.To"
SUMMARYPRoGRAM_grvEs
l::

Program Description
Error Logging Format
OCL Considerations

VTOCSERVICEPROGRAM_$WVTOC
Program Description
Control Statement Srrnrn"ry
P a r a m e t e rS u m m a r y
Parameter Descriptions
PACK parameter
UN lT parameter
OCL Considerations
Examples

APPENDIXA. IBM SYSTEM/3
STANDARD
CHARACTERSET
APPENDIX B. CALCULATING
FILE SIZE
Data Area Track Requirements
index Area Track Requirements
T r a c k U s a g ef o r I n d e x F i i e s
Core Index
C a l c u l a t i n gF i l e S i z e s( M a i n
Data nr""t_
Summary
'
Determiningthe Number
of Tracks in a
S e q u e n t i a lo r D i r e c t F i l e
Determiningthe Number
of Tracks in an
Indexed File (Main Data
Area)
'
Determiningthe Number
of Tracksoi OOt
Track Index
C o n v e r t i n gC y l i n d e r / T r a c k
to Track NumOe,
Converting Track Number
of Cylinder/Track

4-223
4-223
4-223
4-223
4-223
4-223
4-223
4_223
4-224
4-224
4-224
4-224
4-224
4-224
4-224
4_225
4-225
4-233
4-233
4-234
4-235
4-236
4-236
4-236
4-237
4-239
4-239
4-240
4-240
4-241
4-24.1
4-241
4-241
4-241
4-241
4-241
4-242
4-242

A-l
B-l
B-1
B4
B4
B€
B-7
B-7
B-7
B-7
B-7
8-8

AP-PENDIXC. OPERATORCONTROL
COMMANDS

(occ)

c-1
c-1
c-1

OCCSummary
InformationAbout Syntaxlllustrations
A P P E N D I XD . S U 8 R 1 5 - L I B R A R Y
ENTRY
R E T R I E V A LS U B R O U T I N E
LinkingSUBRTSwithRpcil
.
LinkingSUBRl S with Assembler
Errorldentification
. . . :

.
.
.

D-l
D_2
D-5
D_6

.
.

APPENDIX E. TRANSACTION
LOGGING_
$TRLOG
Using Transaction Logging
Tape Considerations
Loading$TRLOG
Controiling $TRLOG
.
' Operating Considerations
Programming Considerations

E-1
E-1
E-1
E-1
E-2
E-2
E-2

APPENDIX F. PROGRAM REFERENCE
INFORMATION
.

F_l

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued 28 September 1979
By TNL: GN21-5674

How to UseThis Manual

This publicationcontainsfour parts. Part 1 describes
(OCL)statements,
OperationControl Language
Part2
describes
the systemconceptsand facilities,Part3 describes
the format of a 3340 and 3344 volume,and Part4 describesthe systemserviceprograms.

PART 3
Referto Part3 if you want to know about:
o The format and storagecapacityof a 3340 or 3344
volume

PART1

o Simulationareas

Referto Part 1 if you want to know:

o Maindataareas

o Whatan OCL statementis

o Alternatetracks

o WhateachOCL statementis usedfor (function)

o Cylinder0 format

.

.

WhereeachOCL statementis placedin relationto others
and when it is needed(placement)

PART 4

How eachOCL statmentmust be coded(format)

Referto Part4 if you want to know about:

o WhateachOCL statementmustcontain(contents)

o Whichsystemserviceprogramsare suppliedwith the
system

PART 2

o The function of eachsystemserviceprogram

Referto Part2if you want to know about:

o The operationalcontrol language
(OCL) statements
and
control statements
applicableto eachsystemservice
program

o Model 15 programming
concepts
o Filesand file services

APPENDIXES
o Libraryfacilitiesand concepts
if you want informationabout:
Referto the appendixes
a Systemoperationoverview
o StandardSystem/3characterset
o M u l t i p r o g r a m m i nagn ds p o o l i n go v e r v i e w
o Calculationof file sizes
o Systemcontrol programfacilities
o Operatorcontrol commands(OCC)
o H o w t o r e t r i e v el i b r a r ye n t r i e sw i t h S U B R1 5
o How to log transactions
|
I

.

with SCP(systemcontrol
tnoiuiOualprogramsassociated
progtamming5704-SC2)

How to Use This Manual

ix

This page is intentionally left blank.

Model15D lntroduction

System/3Model 15D featuresa processing
unit that allows
the attachmentof a 3340 DirectAccessStorageFacility
and a 3344 DirectAccessStorage.With a 3340A2 and
334482,the maximumonlinedisk storageis approximately
506 megabytes.
Whencomparedto a System/3Model 15A, Model 158, or
Model15C,the Model 15D hasa fasterinstructioncycle
time for certainnon-l/O instructions.The purposeof the
fastercycletime is to complementthe requirements
of the
enhancedprogramming
support.
System/3Model 15D is supportedby a multiprogramming
systemcontrol program(ProgramNumber5704-SC2)that
resides
on a simulationareaof a direct access
storagedevice.
It providesfunctionsthat are not availableon other
System/3models.
Threeprogrampartitionsaresupported.The scheduling
and controllingof programsin the partitionsis controlled
(OCL) statements
by operationcontrol language
and
(OCC).
operatorcontrol commands
SeeAppendixC for a
summaryof the commands.

As the systemprocesses
an input stream,jobs areprocessed
in job mode. Job stepsnot containedwithin a specified
job are processed,
by the system,in stepmode. SeePart2
for a discussion
of job and stepmode.
Programsupportprovidesa spoolingfunction for certain
input and output operations.Spoolingplacesjobs from the
input streamin a specialareaon disk calleda readerqueue.
Jobsaretransferredfrom disk by spoolingto the partitions
asrequiredfor execution.
Printedand/or punchedoutput is placedin queueson disk
duringexecutionof job steps.Printingor punchingto the
associated
devicesis performedby spooling.Spoolingprov i d e sg r e a t efrl e x i b i l i t yd u r i n gj o b s c h e d u l i nagn d r e m o v e s
many l/O deviceconflictsbetweenpartitions.SeePart 2
for more informationon spooling.
Supportfor directly attached3741 DataStation/ProgrammableWork Stationis similarto that for a card readeror
cardpunch. In this manual,unlessotherwisenoted,referencesto card l/O alsoapplyto the directlyattached3741.

Greateronlinelibrarycapacityis availablebecause
each
partitioncan directlyaccess
threeuniquesimulationareas
a n ds h a r e as c o m m o ns i m u l a t i o n
a r e a( t h e I P L a r e a ) .S i m u lationareasareassigned
by the user;reassignments
for
simulationareasother than the IPL arearequirean appropriateOCL statement.(Moreinformationabout simulation
a r e a si s i n c l u d e di n P a r t3 o f t h i s m a n u a l . )
Input job streamsare madeup of jobs and job steps.A job
i s o n e o r m o r e L O A D / R U No r C A L L / R U N s e q u e n c e s
groupedtogetherto executein sequence
and performa
specificfunction. A job stepis one LOAD/RUN or
CALL/RUN sequence.A JOB OCL statementmust be
usedto group job stepstogetherto form a job. SeePart 2
for a discussion
of jobs and job steps.

Model 15D Introduction

Part 1. OCL Statements

OCL Statements

1'1

lntroductionto OCL Staternents

WHATIS OCL?

OCL and the Job Stream

(OCL) is one meansof comOperationControl Language
municatingwith the system.Operatorcontrol commands
(OCC)are anothermeansof communicatingwith the
system.SeeAppendixC for a summaryof OCC. You must
providea setof OCL statements
for eachprogramyou want
to run. Basedon the informationsuppliedin thesestatements,the systemloadsand executesyour programsor
performssystemservicefunctions.

you supplyform the basisof the job
The OCL statements
stream. lf your programrequiresdatafrom the system
the
input device(the deviceusedto readOCL statements),
OCL. The lob stream
data must follow the corresponding
cancontainprogramsand programdataaswell asOCL
s t a t e m e n t s(.F i g u r e1 - ' ls h o w sa n i n p u t j o b s t r e a m . )

Y o u c a ns u p p l yO C L s t a t e m e n tisn f o u r w a y s : ( 1 ) b y
punchingthe statementsinto cards.which arethen readby
the system;(2) by usingthe CRT/Keyboardto key the
statements
directly into the system;(3) by keyingthe
statements
onto a diskette,which is then readby the system; (4) by usingprocedures.
After the systemreadsa setof OCL statements
for a program,it runsthe program.Whenthe programends,the
systemreadsthe next setof statements
and runsthat program.This cycleis repeateduntil all OCL statements
have
programshavebeenrun.
beenreadand the corresponding

for your proYou can alsostoresetsof OCL statements
gramsoutsidethe iob streamin a sourcelibraryon disk.
Thesesetsarecalledprocedures.You can instructthe
into the job stream,which
systemto mergeprocedures
statements.(See
eliminatesrecodingfrequently-used
Procedures
in Part2 of this manual.)

Data
OCL Statementsfor 17

Program
Second

fu

The runningof your programis controlledby systemcontrol programs.Systemcontrol programsmust be in main
storagebeforeyour jobscan be run. Theseprogramsmust
be locatedin simulationareas.

7 o"ruforFirst

OCL
A p r o c e d u r cea l l e di n i t i a lp r o g r a ml o a d ( l P L ) i n i t i a t e st h e
loadingof selectedsystemcontrol programs.IPL must be
performedby the operatorafter the systempower-on
sequence.Othersystemcontrol programsare broughtinto
mainstorage,as required,duringprogramloadingand
execution.

-

for First
OCL Statements
Program
DATE Statement(optionalif
e n t e r e da t I P L o r v i aa D A T E

occ).
Figure 1-1. !nput Job Stream

lntroduction to OCL Statements

1-3

O R G A N I Z A T I O NO F P A R T 1

Parameters

Part I is dividedinto:

needparameters;
Somestatements
othersdo not (see
StatementDescriptionsfor an explanation). Parameters
can be eithercodesor data. A codeis a word or groupof
characters
that hasa certainmeaning.Datais information
s u c ha st h e n a m e sl,o c a t i o n sa, n d l e n g t h so f f i l e so n d i s k .
(SeeStaternentDescriptionsfor data and code restrictions
o n p a r a m e t e r s .I )n t h e f o l l o w i n ge x a m p l eP
, R O G 2i s t h e
n a m eo f a n R P Gl l o b j e c tp r o g r a ma, n d F 1 i s a 5 4 4 4u n i t
codethat is assigned
to a simulationarea. PROG2is a data
parameterand F1 is a code parameter.

o CodingRules- Definesthe generalcontentsof the OCL
statements
and explainsthe rulesfor writing the statements.
.

- Explainsthe functions,format,
StatementDescriptions
and contentsof eachOCL statement,and whereeach
statementmay be usedin the iob stream.

o StatementExamples- Presents
and explainsa job
streamcontainingmostof the OCL statements.

C O D I N GR U L E S
Typesof Information
OCL statements
contain,at most,two typesof information: a statementidentifierand parameters.The statement
identifierdistinguishes
one statementfrom another;the
parameters
supplyadditionalinformation. The following
exampleshowsthe format of an OCL statement.

requirecertainwordsin parameters
Somestatements
to tell
one parameterfrom another. The wordsarecalledkeywords. Parameters
containingkeywordsarecalledkeyword
p a r a m e t e r s( .l n t h e f o l l o w i n ge x a m p l eN
. AME-MASTER,
P A C K - V O L I ,a n d U N I T - R 1a r ek e y w o r dp a r a m e t e r s .
N A M E ,P A C K ,a n d U N I T a r ek e y w o r d s .M A S T E Ra n d
VOLl aredata parameters.R1 is a codeparameter.)A
hyphenis alwaysrequiredbetweenthe keywordand the
codeor dataparameter.

ldentifier I Parameter1, Parameter2, ..., Parameter
n

Sbtement ldentifiers
EveryOCL statementneedsone of thesestatementidentifiers:
ASSIGN
BSCA
CALL
C O M PLI E
DATE
F IL E
HALT

IMAGE
JOB
LOAD
LOG
NOHALT
PAUSE
PRINTER

PUNCH
READER
RUN
SWITCH

/&
* (asterisk)

The word LOAD is an exampleof a statementidentifier.

GeneralCodingRules
In Part 1 of this manual.the numbersthat appearabove
statementformatsand examplesindicatethe cardcolumns
or line positionsoccupiedby the statements.In statement
formats,specialcharacters(suchas lll andwordswritten in
capitallettersrepresentinformationthat must be used
exactlyasshown. Wordswritten in smallletters(suchas
code,program-name,
and unit) representinformationthat
y o u m u s ts u p p l y .

SpecialMeaningof Capital Letters, Numberc,and
Special Characterc
wordsand letters.numbers.and specialcharacCapitalized
in OCL and statementdescriptershavespecialmeanings
tions.
Wordsor lettersthat arenot capitalizedindicatethat you
m u s ts u p p l ya v a l u et h a t a p p l i e st o t h e j o b y o u a r ed o i n g .
The valuesthat can be usedare listedin the oarameter
summaries.
Braces{ } and brackets[ ] sometimes
appearin parametersshownin statementsummaries
and parametersummaries.They arenot part of the parameter;
they simply
indicatea choiceof valuesto completethe parameter.You
rzustchooseone of the valuessurroundedby braces;you
may choosea parametersurroundedby bracketsor omit
of one valueenclosed
that parameterentirely. Underscoring
by bracesindicatesthe default. lf you specifythe keyword
you mustcompletethe parameterby
of a parameter,
supplyingthe codeor dataeventhougha defaultis indicated.

Statement$Beginning with //
areasfollows (the term
The rulesfor codingthe statements
p o s i t i o nr e f e r st o e i t h e rr e c o r dc o l u m no r l i n e p o s i t i o n ) :
*,
o The // must be placedin positions1 and2. The /&.
and /. statementsareexceptionsand must start in posi*.
tion 1. (SeeStatementDxcriptions for l&,and I.
statements.
)
a Theremust be one or more blanksbetweenthe // and
the word that forms the statementidentifier (DATE,
R U N , C A L L , e t c . ) . E x c e p t i o nasr et h e J O B s t a t e m e n t ,
which must havea jobnameimmediatelyfollowingthe
//, andthe LOAD statement.which may havea stepname
immediatelyfollowingthe //.
o Theremust be one or more blanksbetweenthe end of
the statementidentifierand the first parameter.
r

Forexamole:

(80tl

.
[*..,-.

1\ ;-

meansthat if you do not specifythis
I I
/J
parameter,
the systemwill select
RECL-96. lf you specifythe keyword
RECL,you must alsosupplyone of
t h e v a l u e s( 8 0 o r 9 6 ) .

placethe keyo lf you are writing keywordparameters,
the keyword
word first, and usea hyphento separa::e
from the codeor dataparameter.
r

. R E r A r N . { ; } meansthat you must specifyeither
R E T A I N - To r R E T A I N - P .

lf you needmore than one parameter,usea commato
them. No blanksareallowedwithin or between
separate
parameters.For the exceptionto this rule,seethe description for the HIKEY parameterunderFILE State'
ment (Multivolume Disk Files). Anything following the
a
first blank after the lastparameteris considered
comment (seeCommentsl.

write the
lf the parameteris not a keywordparameter,
in
parameters
in the order in which they arediscussed
thismanual.

o [,BLKL-blocklength] meansthat the block length
parametermay be omitted
entirely.

lntroduction to OCL Statements

1-5

( l n t h e f o l l o w i n ge x a m p l et,h e s t a t e m e nitd e n t i f i e ras r e
L O A D a n d F I L E . T h e p a r a m e t e rasr eP R O G l , R 1 ,
NAME-MASTER
U,N I T - R1 , a n dP A C K - V O L 1 . )

StatementLength

The continuationrulesare asfollows:

OCL statementlengthis asfollows:

o Theremust be a commaafter the lastparameterin every
recordexceptthe last parameterin the OCL statement.
The comma,followed by a blank,tellsthe systemthat
the statementis continuedin the next record.

Device

Number of Characters

MFCU

96

MFCM

80

1442

80

2501

80

CRT/Keyboard

96

3741

96

Continuation
The only OCL statements
that may exceed80 or g6 charact e r s ,i n c l u d i n gb l a n k sa n d c o m m e n t sa, r e F I L E , C O M PLI E ,
P U N C Ha
, n d P R I N T E R .O t h e r w i s ee,a c hr e c o r dy o u u s e
mustnot exceed80 or 96 characters.(Datafor the IMAGE
statementrequirescontinuationfor the cardsor linescontainingthe chainimagecharacters,
but the datafollows
different continuation rules. SeeIMAGE Statementunder
Statement Desc
rip ti ons f or more i nf ormation.)

1€

o Eachnew recordmust beginwith a /lin positions1 and
2.
a Theremust be one or more blanksbetweenthe // and
the first parameterin the record. (SeeHIKEy parameter
under FILE StatementIMultivolume Disk Files] for the
e x c e p t i o nt o t h i s r u l e . )
The followingillustrationis an exampleof the continuation
rules:

CommenB
Your statements
can includecommentsin the following
places:
.

Foflowingthe llin any statementbeginningwith //.
The commentmust beginin position3 immediately
followingthe //. You can useup to 8 characters
without
blanks. Theremust be one or more blanksbetweenthe
commentand the word formingthe statementidentifier.
( l n t h e f o l l o w i n ge x a m p l et,h e w o r d B I L L I N G i s t h e
comment.) Commentsof this type, when usedin a JOB
or LOAD statement,aretreatedasjobnameand stepname,respectively.

o After the lastparameter.Theremust be one or more
blanksbetweenthe lastparameterand your comment.
The commentcan be any combinationof characters
exceptdashes.lf the statementis continuedin subsequentrecords.you can placecommentsafter the last
parameterin any of the records.
a After statements
without parameters.Theremust be
one or more blanksbetweenthe statementidentifier and
your comment. Examplesof statements
without parame t e r sa r e : / & , / / P A U S E a, n d / / R U N .
ln additionto writing commentswithin your OCL statements,you can includeentirerecordsof comments.The
OCL commentstatementis providedfor that purpose(there
must be an * in position1 followed by the comment). For
more informationaboutthe commentstatement,referto
*(
Comments) Statements under Sfafement Descr ip t i ons.

The followingis an exampleof a commentstatement:

Spooling and Multiprogramming Considerations
All OCL statements
can be usedin a spooledinput job
stream,and all can be usedin any partition.
I V O f CT
. ' h E D A T E . I M A G E ,L O G ,P R I N T E R ,P U N C H .
R E A D E R ,a n d / . O C L s t a t e m e n trse q u i r es p e c i acl o n s i d e r a tion when usedin a spooledinput job stream.

lntroduction to OCL Statements

1-7

Statement Descriptions
The followinginformationis givenseparately
for eachoCL
s t a t e m e ni tn t h i s s e c t i o n :
o Functionof the statement
I

Placement
of the statementin regardto other statements,
and the circumstances
underwhich the statementis
needed

o Formatof the statement
o Contentsof the statement(explainingthe parameters
that can be usedin the statement)
.

1-8

Spoolingconsiderations
for eachstatement

Figure1-2givesthe f unction,placement,and restrictions
o n u s ef o r e a c hO C L s t a t e m e n t .F i g u r e1 - 3d e s c r i b et sh e
contentsof the ocL statements
and is meantfor reference
o n l y . w h e n u s i n gF i g u r el - 3 , r e m e m b etrh a t w o r d sw r i t t e n
in smallletters,suchas filenameor value,requirea choice
on your part,dependingon the functionsyou want the
statementto perform. Capitalizedparameters
must be
codedalongwith the dataor codeparameter.(Figure1-3
showswhich parameters
areavailable.)
l f y o u a r en o t f a m i l i a rw i t h a n e n t r y ,o r y o u d o n o t k n o w
when to useor omit it, referto the properstatementin the
remainderof this section.

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued 28 September 1979
By TNL: GN21-5674

Placement
StatementAppears
In Job Stream

StatementAppears
In a Procedure

Coding Notes

Anywhereamongthe
OCL statements

Must precedethe RUN
s t a t e m e n(ti f R U N i s
u s e d) .

Systempack
( R 1o r F l ) c a n n o t
be reassigned.

Changesthe BSCA Must follow LOAD or
l i n en u m b e r .
CALL statementand
precedethe RUN
statement.

Must follow the LOAD
statementand precede
the RUN statement(if
RUN isused).

None

II CALL

ldentifiesprocedureto be
mergedinto job
streamand disk
containingthe
sourcelibrary
from which to
readthe procedure

M u s tp r e c e d teh e R U N
statement.Must follow
the JOB statement
when the systemis
operatingin job
mode.

Must precedethe RUN
s t a t e m e n(ti f R U N i s
used).

1 . lf found in a procedure,indicates
nestedprocedures.
No more than nine
levelsof nested
procedures
allowed
2. Must not be between LOAD and
R U No r C A L L
a n dR U N .

// COMPILE

Suppliesinformation about the
programto be
compiledor
assembled
to the
c o m p i l e ra n dt h e
linkageeditor.

Mustfollow LOAD or
CALL statementand
precedethe RUN
statement.

Mustfollow the LOAD
statementand precede
the RUN statement
(if RUN isused).

O n l y o n eC O M P I L E
statementallowed
per job step.

II DATE

Changes
system
dateand partition dates.

Must precedethe first
JOB. CALL, or LOAD
statement.

Not applicable

None

partiChanges
tion datefor
job.

M u s tf o l l o w t h e J O B
statementand precede
a LOAD statement
(eitherbeforethe first
stepor betweensteps).

BeforeLOAD statement.

None

partiChanges
tion datefor
step.

Mustfollow the LOAD
or CALL statementand
precedethe RUN.

After LOAD and before
RUN.

Cannotbe entered
if DATE was usedto
changepartition
date for job.

Suppliesinformation about a file
to the system.

Mustfollow LOAD or
CALL statementand
orecedethe RUN
statement.

Must follow the LOAD
statementand precede
the RUN statement
(if RUN isused).

Requiredfor every
new file createdand
for existingfiles
beingused.

Statement

Function

// ASSIGN

Allows reassignment of a5444
u n i t c o d e( R1 ,
F1, R2,F2) to a
simulation
area.

// BSCA

II FILE

Figure 1-2 {Part I of 5}, Table of OCL Statements
StatementDescriPtions

1'9

StatementAppears
In Job Stream

Coding Notes

// HALT

I nstructssystem
t o h a l tw h e n
programends;
cancelsthe effect
o f n o h a l tm o d e .

Anywhereamongthe
OCL statements.

Must precedethe RUN
statement(if RUN is
u s e d) .

// IMAGE

Tells the system
to replacethe
chain-imagearea
with characters
indicated in the
data records that
are read from the
system input device or read from
t h e s o u r c el i b r a r y .

Anywhereamongthe
OCL statements.

Must precedethe RUN
s t a t e m e n(ti f R U N i s
used).

// INCLUDE

l d e n t i f i e st h e
entry in the
source library
that contains
the OCL statements to be
merged into the
job stream.

Anywhereamongthe
OCL statements.

//jobnameJOB

// LOAD
or
//stepname
LOAD

been changed.

M u s tp r e c e d e
the RUN
s t a t e m e n(ti f R U N i s
u s e d) .

1 . l f s y s t e ms e r v i c e
programcontrol
statements
follow
the RUNstatem e n ti n t h e s o u r c e
m e m b e rt.h e y a r e
placedin the SWA
and readfrom
thereby the system
serviceprogram.
2 . M u s tn o t b e
b e t w e e nC A L L
a n dR U N .

Allows you to run Must precedethe first
relatedjob steps
LOADor CALL state.
togetherto ensure m e n tf o r a j o b .
they are run
sequentially.

Cannotbe usedin a
procedure.

Placesa partition
in job mode. Re-

l d e n t i f i e tsh e
programto be
run andindicates
the disk that con.
tainsthe object
l i b r a r yf r o m w h i

M u s tp r e c e d e
the RUN
s t a t e m e n(ti f R U N i s
u s e d) .

lVlustprecedethe RUN
s t a t e m e n tM
. u s tf o l l o w
t h e J O Bs t a t e m e nwt h e n
the systemis operating
in job mode.

it is to be loaded.
Figure 1-2 (Part 2 of 5). Table of ocl

1-10

R e q u i r e di f t h e
printer chain has

statem€nts

quired whenever
s p o o l i n gi s a c t i v e .

Placement

Statement
*
// LOAD
or
//stepname
LOAD -

Function
I nd icatesthat
after the RUN
statement is
processed,the
object program

StatementAppears
In Job Stream

StatementAppears
In a Procedure

M u s tp r e c e d teh e R U N
s t a t e m e n tM
. u s tf o l l o w
t h e J O Bs t a t e m e nwt h e n
t h e s y s t e mi s o p e r a t i n g
in job mode.

M u s tp r e c e d e
the RUN
(
i
f
statement RUN is
used). Objectprogram
w i l l b e r e a df r o m t h e
s v s t e mi n p u t d e v i c e .

*
A LOAD program
cannotbe loadedif
*
a n o t h e rL O A D
Program(with overl a y s )i s e x e c u t i n g
in
a n o t h e rp a r t i t i o n .

M u s tp r e c e d e
the RUN
s t a t e m e n t(si f R U N i s
u s e d) .

A p p l i e so n l y t o t h e
partition in which it

will be loaded
from the system
i n p u t d e v i c eo r
from the file
indicated on the
s p e c i f i e du n i t .

// LOG

Changesthe device Anywhere among the
u s e df o r d i s p l a y OCL statements.
ing system
messages
and
controls page

CodingNotes

was entered.

ejection before
EJ and ES and
after EJ.

// NOHALT

I nstructssystem
t o c o n t i n u ew i t h out stopping
w h e na p r o g r a m
endsand/orsets
t h e s e v e r i t yl e v e l
of halts.

Anywhere among the
OCL statements.

M u s tp r e c e d e
the RUN
s t a t e m e n(ti f R U N i s
u s e d) .

None

// PAUSE

C a u s e sO C L
processingto stop
in order to give

Anywhere amongthe
OCL statements.

M u s tp r e c e d e
the RUN
s t a t e m e n(ti f R U N i s
u s e d) .

T h i si s t h e o n l y O C L
s t a t e m e ndt i s p l a y e d
on the CRT.

A n y w h e r ea m o n gt h e
OCLstatements.

M u s tp r e c e d e
the RUN
s t a t e m e n(ti f R U N i s
u s e d) .

None

t h e o p e r a t o rt i m e
to perform a
function. Operator must restart
OCL processing.

// PRINTER

E n a b l e sy o u t o
d e s c r i b et h e
functionsperformed by the
s y s t e mp r i n t
d e v i c ea n d
control options
r e l a t e dt o p r i n t
spooling.

Figure 1-2 (Part 3 of 51. Table of OCL Statements

Statement Descriptions

1 - 11

Placement
StatementAppears
In Job Stream

StatementAppears
ln a Procedure

E n a b l eyso u t o
d e s c r i b teh e
f u n c t i o n sp e r f o r m e db y t h e
systempunch
d e v i c ea n d
c o n t r o lo p t i o n s
r e l a t e dt o p u n c h
spooling.

Anywhere amongthe

M u s tp r e c e d teh e R U N
s t a t e m e n( ti f R U N i s
u s e d) .

None

// READER

C h a n g etsh e
s y s t e mi n p u t
d e v i c eu s e dt o
r e a dO C L
statements.

M u s t p r e c e d eL O A D
or CALL statement.

M u s t p r e c e d et h e L O A D
s t a t e m e n t( i f L O A D i s
u s e d) .

l f u s e di n a p r o c e d u r e ,
t h e s y s t e mi n p u t d e v i c e i s c h a n g e dw h e n
the READER statem e n t i s p r o c e s s e db; u t
O C L s t a t e m e n t sa r e
not read from the new
s y s t e mi n p u t d e v i c e
u n t i l t h e p r o c e d u r ei s
c o m p l e t e l ye x e c u t e d .

// RUN

Indicatesthe end
of the OCL statementsfor a job
stepand tells
systemto run
the program.

Must follow the LOAD or
CALL statementand be
the lastOCL statement
for a job step.

lf used,mustfollow the
LOAD statementand be
the lastOCL statement
in the procedure.

R e q u i r e di n t h e j o b
streamfor eachjob
stepwhich is tir
be run.

// SWITCH

Usedto set one
or more external
indicatorson or
off or to leavethe
indicatoras it is.

Anywhereamongthe
OCL statements.

O n l v o n es w i t c h
M u s tp r e c e d e
the RUN
s t a t e m e n(ti f R U N i s u s e d ) . statementallowed
betweenLOAD or
C A L L a n dR U N .

l&

Acts as a delimiter Recommended
asthe
betweenjob steps. lastOCL statementof
a job step.

Statement

Function

// PUNCH

OCL statements.

Figwe 1-2 (Part 4 of 51. Table of OCL Statements

1-',!2

Not allowed in a
procedure.

Coding Notes

Not allowedin a
procedure.

Placement

Statement

Function
1 . W i t hs p o o l i n g
active,actsas
a delimiter
betweenjobs.
Causesend of
job.

StatementAppears
In Job Stream

StatementAppears
In a Procedure

Coding Notes

Recommended
asthe
lastOCL statementof
a job.

Not allowedin a
procedure.

Not allowedin a
procedure.

Not allowed in a
procedure.

Not allowed in a
procedure.

Not allowed in a
procedure.

Not allowed in a
procedure.

2. W i t h i n p u t

Lasttwo OCL statespoolingactive, mentsin the input
two consecutivejob stream.
/. statements
indicateend of
spooledinput.

3. W i t h s p o o l i n g

LastOCL statement

inactive.indicatesend of
lob mode.
Causes
end of
j o b . N e x tO C L
statementmay
start job step
mode.
" (Comment)

U s e dt o e x p l a i n
the job, to write a
time stampto the
SHA, or to give
the operator
instructions;
does
not affect programoperation.

Anywhereamongthe
OCL statements.

Anywhereamongthe
OCL statements.

Commentsare not
d i s p l a y eo
dn t h e
CRT.

Figure 1-2 (Part 5 of 5), Table of OCL Statements

Statement Descriptions

1 - 13

// ASSIGN

R1-

D 1 A ,D 1 B ,D 1 C ,D 1 D ,
D2A, D2B, D2C, D2D,
D 3 A , D 3 B , D 3 C ,D 3 D ,
D 3 E ,D 3 F ,D 3 G ,D 3 H ,
D 4 A , D 4 B , D 4 C ,D 4 D ,
D 4 E , D 4 F ,D 4 G ,D 4 H

A s s i g n( b y p a r t i t i o n )a 5 4 4 4u n i t c o d et o a s i m u l a t i o n
areacode. (RefertoAS.S/G/V
Statement.l

AREA

AREA-name

N a m eo f s i m u l a t i o n
a r e at o b e a s s i g n e d .

PACK

PACK-name

Nameof main dataareaassociated
with simulationarea.

R2
F1
F2

// BSCA

// CALL

C h a n g ea l l B S C A D T F l i n e c o d e st o t h e l i n e n u m b e r
s p e c i fi e d .

procedu re
name

N a m e t h a t i d e n t i fi e s t h e p r o c e d u r ei n t h e s o u r c el i b r s r y .

unit

S p e c i f i e st h e s i m u l a t i o n a r e at h a t c o n t a i n st h e p r o c e d u r e .

switch
characters

5444 unit code

U n i t c o d e f o r s i m u l a t i o n a r e a . P o s s i b l ec o d e sa r e R 1 , F 1 ,
R2, F2.

XXXXXXXX

Specifies8 switch charactersthat are compared with the
e i g h t e x t e r n a l i n d i c a t o r s . P o s s i b l ec h a r a c t e r sa r e 0 , 1 ,
or X.

i/ COMPILE

SOURCE
UNIT

S O UR C E - n a m e
U Nl T - 5 4 4 4u n i t c o d e

OBJECT

O B J E C T - 5 4 4u4n i t c o d e S p e c i fe st h e s i m u l a t i o na r e at h a t i s t o r e c e i v e
theobject
p r o g r a m .P o s s i b lceo d e sa r e R 1 , F 1 , R 2 , F 2 .

LINKADD

L IN K A D D - 4 O O O
8000

L i n k a g eE d i t o r : s t a r ta d d r e s (sh e x a d e c i m a l ) .

ATTR

ATTR_MRO

Requests
that the objectprogrambe link-editedto use
R E M A Pm o d e ,m e m o r yr e s i d e not v e r l a y s .

Nameof sourceprogram.
S p e c i fe st h e s i m u l a t i o na r e at h a t c o n t a i n st h e s o u r c e
l i b r a r y . P o s s i b lceo d e sa r e R 1 , F 1, R 2 , F 2 .

Requests
that the object programbe link-editedto use
M O V E m o d e ,m e m o r yr e s i d e not v e r l a y s .
// DATE

Figure 1-3 (Part 1 of 7). Table of Parameters

1-14

System date or partition date (domestic date format).
System date or partition date (World Trade date format).

Statement

Parameter

II FILE
( d i s kf i l e s )

NAME
UNIT

PACK
LABEL

Meaning of Code

Code

I N A M E - ifl e n a m e
I U n t f - S + + 4u n i t c o d e

I N a m et h e p r o g r a mu s e st o r e f e rt o t h e f i l e .
or will conI S o e c i f i etsh e s i m u l a t i o na r e at h a t c o n t a i n s
I t a i nt h e f i l e . P o s s i b cl eo d e sa r eR 1 , F 1, 3 2 , F 2 .

I U N I T m a l nd a t aa r e a
I code
I
t

t h a t c o n t a i n so r w i l l c o n I S p e c i f i etsh e m a i nd a t aa r e a
I t a i n t h e f i l e . P o s s i b lceo d e sa r eD 1, D 2 , D 3 o r D 3 1 , D 3 2 .
I D 3 3 , D 3 4 , D 4 o r D 4 1, D 4 2 , D 4 3 ,D 4 4 .
l

I P A C Kn a m e
UAel titename
I
|

N a m eo f a r e at h a t c o n t a i n so r w i l l c o n t a i nt h e f i l e "
I
N a m eb y w h i c hy o u r f i l e i s i d e n t i f i e od r w i l l b e
I
i d e n t i f i e do n d i s k .
|

I neCOnOS-number
or
I TRACKS-number
I LOCnf tOnI t r a c kn u m b e r
I lOCRf tOru
I c y l i n d e nr u m b e r
I LOCnrrOnr
c v l i n d e nr u m b e r /
i
I t r a c kn u m b e r
nerarfl-r
I
S
I

r f r e c o r dfso r t h e f i l e .
I A p p r o x i m a tneu m b e o

t

l

RECORDS
or
TRACfis
L O C A Tt O N

RETAIN

II onre mmooyy
dd-.yy

HIKEY

I HtKf V'highest
u n O a c k ekde y f i e l d s
I

VERTFY

N u m b e ro f t r a c k sr e q u i r e db v t h e f i l e .
T r a c kn u m b e ro n w h i c hf i l e b e g i n so r i s t o b e g i n
( s i m u l a t i oanr e ao n l y ) '
C y l i n d enr u m b e ro n w h i c hf i l e b e g i n os r i s t o b e g i n .
t r a c k a s s u m ezde r o( m a i nd a t aa r e ao n l y ) '
numbeo
r n w h i c hf i l e b e g i n s
I C v t i n O .nt u m b e rt,r a c k
o r i s t o b e g i n( m a i nd a t aa r e ao n l y ) .
|
I
T e m o o r a rfvi l e .
I
lScratcltfile.

I
|
|
|
I

lParm3nsnlfilg.

I
I

l
"
'
I Utf eV-e'highest
k e y e df i e l d s
I OackeO
lallowed'
I Vf nf FY YES

t.i,, ,n, system
thedatethef ilewasoeated.

I L i s to f h i g h e sut n p a c k e kde y f i e l d sa l l o w e do n e a c h
( m a i nd a t aa r e a
I n a c ko f a n i n d e x e dm u l t i v o l u mfei l e

arroweo'

l

lonrv).

*O
I
I S H n R gV
- eS

pack
I L i s to t h i g h e spt a c k e dk e y f i e l d sa l l o w e do n e a c h
o f a n i n d e x e dm u l t i v o l u mfei l e ( m a i nd a t aa r e ao n l y ) .
I
I
v e r i t y d i s kw r i t eo p e r a t i o nf so r t h i sf i l e ( m a i nd a t a
I
| a r e ao n l y ) .
o p e r a t i o nf so r t h i sf i l e .
I O o n o t v e r i f yd i s kw r i t e
s ethods
n a r t i t i o nisf a c c e sm
getweep
I A l l o w f i l es h a r i n b

I
I
I
|
|

larecomoatible.
f i l es h a r i n g .
I Do notellow
M
u
l
t
i
p
l
e
r
e
f
e
r e n c et o
s t h e s a m ef i l e w i t h i n o n e p r o g r a m
I
i s s p e c i f i e dl .f p a r a m e t e r
n
o
t
i
f
S
H
ARE-NO
allowed
| are
| i s o m i t t e dS
. H A R EY E S i s a s s u m e d .

|
SHARE

r

D

I

DATE

I

l

NO

Figure 1-3 (Part2 ol 7). Table of Parameters

StatementDescriptions

1-15

Statement

Parameter

Code

Meaning of Code

I/ FILE
( t a p ef i l e )

NAME
UNIT

N A M E -ifl e n a m e
UNIT.Tl
T2
T3
T4
REEL-nnnnnn

N a m e t h e p r o g r a m u s e st o r e f e r t o t h e f i l e .
W h e r et h e t a p e t h a t c o n t a i n so r w i l l c o n t a i n t h e f i l e
is mounted.

REEL

NL
NS
BLP
LABEL

L A B EL - n a m e
or
L A B EL 'character
string'
DATE-mmddyy
ddmmyy
RE T A I N - n n n

DATE
RETAIN
BLKL
RE C L
RE C F M

END

DENSITY

B L K L - b l o c kl e n g t h
RE C L - r e c o rlde n g t h
RECFM.F
V
D
FB
VB
DB
END-LEAVE
UNLOAD
REWIND

DENSITTZOb,
556
800
1600

ASCI
DEFER
CONVERT

A S C I IY E S
NO
D E F ER - Y E S
NO
CONVERT-ON
OFF

TRANSLATE

TRANSLATE.ON
OFF

Figure 1-3 (Part 3 of 7). Table of parameters

N a m e o f t h e l a b e l e dt a p e t h a t c o n t a i n so r w i l l c o n t a i n
the file.
The tape is not labeled.
T h e t a p e c o n t a i n sn o n - s t a n d a r dl a b e l s( i n p u t o n l y ) .
A s t a n d a r dl a b e l e dt a p e i s m o u n t e d . B y p a s sl a b e t
p r o c e s s i n g( i n p u t o n l y ) .
N a m e b y w h i c h y o u r f i l e i s i d e n t i f i e do n t a p e .

The date the file was created.
T h e n u m b e r o f d a y s a f i l e s h o u l d b e r e t a i n e db e f o r e
it expires.
T h e n u m b e r o f b y t e s i n a p h y s i c a lb l o c k o n t a p e .
T h e n u m b e r o f b y t e s i n a l o g i c a lr e c o r d .
F i x e d l e n g t h ,u n b l o c k e d r e c o r d s .
V a r i a b l el e n g t h ,u n b l o c k e d r e c o r d s .
V a r i a b l el e n g t h ,u n b l o c k e d D - t y p e A S C I I r e c o r d s .
F i x e d l e n g t h ,b l o c k e d r e c o r d s .
V a r i a b l el e n g t h ,b l o c k e d r e c o r d s .
V a r i a b l el e n g t h ,b l o c k e d , D - t y p e A S C I I r e c o r d s .
T h e t a p e r e m a i n si n p o s i t i o n a f t e r t h e f i l e i s p r o c e s s e d .
T h e t a p e i s r e w o u n d a n d u n l o a d e da f t e r p r o c e s s i n g .
The tape is rewound after processing.
The tapewill be written at 200 bpi (bitsper inch)density.
The tapewill be written at 556 bpi density.
The tape will be written at 800 bpi density.
The tapewill be written at 1,600 bpi density.
Defaultfor 7-trackis 800 bpi.
Defaultfor 9-trackis 1,600 bpi.
A n A S C I I f i l e i s b e i n g p r o c e s s e do r c r e a t e d .
A n E B C D I C f i l e i s b e i n g p r o c e s s e do r c r e a t e d .
The tapevolume will be mounted later.
T h e t a p e i s p r e s e n t l ym o u n t e d .
Data read from or written to a 7-track tape file will
be converted.
D a t a r e a d f r o m o r w r i t t e n t o a 7 - t r a c kt a p e f i l e w i l l
not be converted.
Data read from or written to a 7-track tape file will
be translated.
D a t a r e a d f r o m o r w r i t t e n t o a 7 - t r a c kt a p e f i l e w i l l
not be translated.

Statement

Parameter

Code

Meaningof Code

// FILE
(tape1
(continued)

PARITY

PARITY.EVEN

The 7-track tape file will be read or written in even
parity.

// FILE
( d e v i c ei n d e pendentcard,
d i s k e t t eo, r
p r i n t e rf i l e s )

ODD

SEONUM

SEONUM-nnnn
X

F i l e s e q u e n c en u m b e r c a n b e 0 0 0 1 t o 9 9 9 9 .
P r e p o s i t i o n e df i l e .

NAME

NAME-filename

Name the program usesto refer to the file.

UNIT

UNIT-MFCU1
MFCU2
MFCMl
MFCM2
1442
2501
3741
1403
3284
READER
PRINTER
PUNCH
P RI N T - Y E S
NO
RECL-recordlength

Primaryhopperof 5424 MFCU.
Secondaryhopperof 5424 MFCU.
P r i m a r yh o p p e ro f 2 5 6 0 M F C M .
S e c o n d a rhy o p p e ro { 2 5 6 0 M F C M .
1442 CardReadPunch.
2501 Card Reader.
Work Station.
3741 DataStation/Programmable
1 4 0 3P r i n t e r .
3284 Printer.
systeminput device.
Usethe partition'sassigned
U s et h e p a r t i t i o n ' sa s s i g n esdy s t e mp r i n t d e v i c e .
Usethe partition'sassigned
systempunchdevice.
I n t e r p r e t i n igs t o b e d o n eo n p u n c hf i l e s .
I n t e r p r e t i n igs n o t t o b e d o n eo n p u n c hf i l e s .
N u m b e ro f b y t e si n a l o g i c arl e c o r d( 3 7 4 1o n l y ) .

HEX

Charactersfrom system input device are in hexadecimal
form.
Charactersfrom system input device are in EBCDIC
form.
Charactersare from the source library.
Number of new characters.
ldentifies the source member containing the characters

PRINT
RE C L
// HALT

None

// IMAGE

format

CHAR

// INCLUDE

The 7-tracktape file will be reador written in odd
parity.

number
name

MEM
v a lu e
name

unit

5444 unit code

proced u re

name

The name of the procedure that contains the OCL to be
merged.

un i t

5444 unit code

switch
characters

XXXXXXXX

Specifiesthe simulation area that contains the procedure.
P o s s i b l e c o d e s aR
r e1 , F 1, R 2 , F 2 .
Specifies8 switch charactersthat are compared with the
e i g h t e x t e r n a l i n d i c a t o r s . P o s s i b l ec h a r a c t e r sa r e 0 , 1 , X .

name

i n t h e s o u r c el i b r a r y .
Specifies the simulation area that contains the source
l i b r a r y . P o s s i b l ec o d e sa r e R 1 . F 1 , R 2 , F 2 .

Figure 1-3 (Part 4 of 7). Table of Paranreters

Staternent DescriPtions

1-17

Statement

Parameter

Code

Meaningof Code

//jobnameJOB

P R I O RI T Y

PRIORITY.O
1
2

Specifiesa job's priority on the readerqueueand on the
o u t p u t q u e u e su n l e s so v e r r i d d e b
ny a pRlORlTy
p a r a m e t eorn a P R I N T E Ro r P U N C Hs t a t e m e n t .

,l

4
5
C O RE - s i z e

CORE
SPOOL
PARTITION

SPOOL-YES
NO
PARTITION-1

T
3
A
B

Specifies
amountof main storagerequiredto execute
the largeststepof a job.
I n d i c a t ew
s h e t h e rs p o o l i n gc a no r c a n n o tb e u s e df o r
t h e j o b . D e f a u l ti s Y E S .
S p e c i f i etsh e p a r t i t i o ni n w h i c ha s p o o l e dj o b s h o u l db e
executed.A means1 or 2; B meanst or 3; C means2
o r 3 ; D m e a n s1, 2 . o r 3 .

c
D
OCOPY

VtrE

ocoPY-N;:

A l l o w s( O C O P Y - Y E So)r d i s a l l o w (sO C O p y - N Ot)h e
spoolf ile copy program($OCOPY)to access
this job on
the readerqueue.

// LOAD
or
//stepname
LOAD

asterisk
program-name n a m e
unit
main data area code
switch
xxxxxxxx
characters

Program is to be loaded from the system input device.
l d e n t i fi e s t h e f i l e t h a t c o n t a i n st h e o b j e c t p r o g r a m .
S p e c i fi e s t h e m a i n d a t a a r e at h a t c o n t a i n st h e f i l e .
Specifies8 switch charactersthat are compared with the
eight external indicators. Possiblecharactersare 0, 1, X.

lI LOAD
or
//stepname
LOAD

program-name n a m e

Name of program that is to be loaded from an object
library on disk.
S p e c i f i e st h e s i m u l a t i o n a r e at h a t c o n t a i n st h e p r o q r a m .
P o s s i b l ec o d e sa r e R 1 , F 1 , R 2 , F 2 .
Specifies8 switch charactersthat are compared with the
eight external indicators. Possiblecharactersare 0, 1, X.

// LOG

unit

5444 unit code

switch
characters

xxxxxxxx

device

CONSOLE
1403
3284

mode

EJECTl
NOEJECT'

lwhen

Log to CRT and systemhistoryareaon systempack.
Log to CRT, the 1403 printer,and the systemhistory
areaon the systempack.
Log to CRT, the 3284 printer,and the systemhistory
areaon the systempack.
Ejecta pagebeforeES and EJ and after EJ.
Do not ejecta pagebeforeES and EJ and after EJ.

y o u u s e t h e s p o o l p r i n t w r i t e r , a n e . i e c to c c u r s a t t h e s t a r t
of every.jobstep, regardteso
s f t h e m o d e s p e c i f i e di n t h e L o G
statement.

Figure 1-3 (part 5 of 7). Table of parameters

1-18

Statement

Parameter

Code

// NOHALT

SEVER
ITY

S E V E RI T Y - 1

Meaning of Code

2
4

T e l l st h e s y s t e mt o s e l e c dt e f a u l to p t i o n sf o r e r r o r
hal t s .

tt

// PAUSE

None

// PRINTER

DEVICE
L I NE S
FORMSNO

DEVICE-i403
3284
L I NE S - n u m b e r
FORMSNO-forms
type

C O PE
I S

COPIES-number

DEFER

DEFER.YES
NO

CLOSE

CLOSE.YES
NO
OCOPY.YES
NO
ALIGN.YES
NO
P RI O RI T Y - O

OCOPY
ALIGN
PRIORITY

1
2

1 4 0 3 P r i n t e r i s u s e da s t h e s y s t e m p r i n t d e v i c e .
3 2 8 4 P r i n t e r i s u s e da s t h e s y s t e m p r i n t d e v i c e .
S p e c i f i e st h e n u m b e r o f p r i n t l i n e s p e r p a g e .
I n f o r m s t h e o p e r a t o rw h i c h f o r m s t y p e s h o u l d b e
m o u n t e d o n t h e p r i n t e r , a n d d e t e r m i n e st h e f o r m s t y p e
o f t h e s p o o l e dp r i n t e d o u t p u t .
W i t h s p o o l i n ga c t i v e ,a l l o w s y o u t o o b t a i n m o r e t h a n
o n e c o p y o f e a c hj o b s t e p ' sp r i n t e d o u t p u t .
A l l o w s y o u t o b e g i n p r i n t i n g a j o b s t e p ' ss p o o l e do u t p u t b e f o r e t h e j o b s t e p c o m p l e t e se x e c u t i o n
( D E F E R N O } . D C f A U Ii S
t DEFER-YES.
A l l o w s y o u t o c o n t r o l w h e n p r i n t s p o o l w i l l c l o s ea n
i n t e r c e p t e dj o b s t e p o n t h e s p o o l f i l e .
A l l o w s y o u t o p r e v e n ts p o o l f i l e p r i n t r e c o r d sf r o m
b e i n gc o p i e d b y t h e s p o o l f i l e c o p y p r o g r a m .
A l l o w s y o u t o p e r f o r m f o r m s a l i g n m e n tf o r s p o o l e d
p r i n t e do u t p u t ( A L I G N - Y E S ) . D e f a u l t i s A L I G N - N O .
S p e c i f i e sa j o b s t e p ' sp r i o r i t y o n t h e s p o o l p r i n t q u e u e .
Default is the priority of the job at the time it is
executed.

J

4

i/ PUNCH

DEVICE

CARDNO
C O PE
I S

DEVICE.MFCMl
MFCM2
MFCUl
MFCU2
1442
3741
C A R D N O - c a rtdy p e
COPIES-number

DEFER

DEFER.YES
NO

OCOPY

OCOPY.YES
NO
P RI ORI T Y . O
1
2
3
4
5

PRIOR
ITY

Primaryhopper of 2560 MFCM.
S e c o n d a r yh o p p e r o f 2 5 6 0 M F C M .
Primaryhopper oI 5424 MFCU.
S e c o n d a r yh o p p e r o f 5 4 2 4 M F C U .
1442 Card Read Punch.
3 7 4 1 D a t a S t a t i o n / P r o g r a m m a b lW
e ork Station.
T e l l s t h e o p e r a t o r w h i c h c a r d t y p e t o u s ef o r p u n c h i n g .
W i t h s p o o l i n ga c t i v e ,a l l o w s y o u t o o b t a i n m o r e t h a n
o n e c o p y o f e a c hj o b s t e p ' sp u n c h e d o u t p u t .
A l l o w s y o u t o b e g i n p u n c h i n ga j o b s t e p ' ss p o o l e d
o u t p u t b e f o r e t h e j o b s t e p c o m p l e t e se x e c u t i o n
( D E F E R - N O ) .D e f a u l ti s D E F E R - Y E S .
A l l o w s y o u t o p r e v e n ts p o o l f i l e p u n c h r e c o r d sf r o m
b e i n gc o p i e d b y t h e s p o o l f i l e c o p y p r o g r a m .
S p e c i fi e s a j o b s t e p ' sp r i o r i t y o n t h e s p o o l p u n c h q u e u e .
Default is the priority of the job at the time it is
executed.

Figure 1-3 (Pan 6 of 7). Table of parameters
StatementDescriotions

1-19

Statement

Parameter

Code

Meaning of Code

// READER

code

CONSOLE
MFCUl
MFCU2
MFCMl
MFCM2
1442
2501
3741

CRT/keyboard.
P r i m a r yh o p p e ro f 5 4 2 4 M F C U .
Secondaryhopperof 5424 MFCU.
P r i m a r yh o p p e ro f 2 b 6 0 M F C M .
S e c o n d a rhyo p p e ro f 2 5 6 0 M F C M .
1442 CardReadPunch.
2 5 0 1 C a r dR e a d e r .
3741 DataStation/Programmable
Work Station.

// RUN

None

0
1
X

Set external indicator off.
S e t e x t e r n a li n d i c a t o ro n .
L e a v ee x t e r n a l i n d i c a t o r a s i t i s

i/ SWITCH

indicatorsetti ngs

/&

None
None

(Comment)

None

* TIME
Figure 1-3 (Part 7 of 7). Tabte of Parameters

W r i t ea t i m e s t a m pt o t h e S H A ( s y s t e m
h i s t o r ya r e a ) .

Pageof GC21-5162-1
lssued28 September1979
By TNL: GN2t-5674

Function

of the 5444 unit codes(F 1, R 1. F2, Rzl
The ASSIGNstatementallowsthe reassignment
appliesonly to the partito any of the supportedsimulationareas.The reassignment(s)
tion in which the ASSIGNstatementis processed.The systempackcannotbe reassigned.
simulationareasis allowed(threeper partiTherefore,a maximumof nine user-assigned
or
remainin effect until anotherASSIGNstatementis processed
tion). All reassignments
until anotherinitial programload (lPL) is performed.

Placement

The ASSIGNstatementcan appearanywhereamongthe ocl statements.In a procedure,
the ASSIGNstatementmust precedethe RUN statement.

Format

// ASSIGN5444 unit code - simulationareacode [,AREA'name] [,PACK-name]

Cpntents

Possibf
e 5444 unit codesare R1, F 1, R2, F2.
Possible
simulationareacodesare:
3340 drive 1
3340 drive 2
3340 drive3
3340 drive 4
3344 drive 3
v o l u m e1
volume2
v o l u m e3
v o l u m e4
3344 drive 4
v o l u m e1
v o l u m e2
volume3
volume4

, l C ,D l D
D 1 AD
, 1 BD
DzA,D2B,DzC,D2D
D3E,D3A
D4E,D4A
D3E,D3A
D3F,D3B
D3G,D3C
D3H,D3D
D4E,D4A
D4F,D4B
D4G,D4C
D4H,D4D

AREA-name: This optionalparameteris usedto verify the nameof the simulationarea.
The systemchecksthis nameagainstthe actualsimulationareanameto ensurethat the
propersimulationareais beingassigned.For informationabout how a simulationareais
given a name, refer to Simulation Area Program ($SCOPY)PACK-name:This optionalparameteris usedto verify the nameof the maindataarea
associated
with the simulationareaspecifiedon the ASSIGNstatement.The system
checksthis nameagainstthe actualmain dataareanameto ensurethat the propermain
dataareais onlineand in a readystate. For informationabout how a maindataareais
given a name, refer to Dr'sklnitialization Program ($lNlT).

Examples

1
I N F2-D4C,R
1- D 3 8 . R 2 . DD
/ / A S SG
the followingsimulation
For the partitionin which the ASSIGNstatementis processed,
areaassignments
are made:
o SimulationareaD4C on volume3 of 3344 drive4 will be referenced
as F2.
o Simufation areaD3B on volume2 of 3344 drive3 will be referenced
as R 1.

ASSIGN Statement

1-21

o sinrulationareaDrD on 3340 drive 1 wiil be referenced
as R2.
o T h es i m u l a t i o n
a r e aa s s i g n m e n
f ot r F l w a sm a d ed u r i n gl p L .
/ / , A S S I G NR 1 . D 3 E , P A C K . D 3 D 3 D 3 , A R E A . D 3 E D 3 E
o For the partitionin which the ASSIGNstatementis processed,
simulationareaD3E on
drive3 will be referenced
as Rl.
o T h e n a m eo f t h e s i m u l a t i o n
a r e ai s v e r i f i e da sb e i n gD 3 E D 3 E( A R E A - D 3 E D 3 E ) .
'

Considerations
and
Restrictions

Thelnameof the main dataareaassociated
with the simulationareais verifiedas being
D 3 D 3 D 3( P A C K . D 3 D 3 D 3 ) .

The reassignment
of the simulationareasis effectiveimmediatelyafter the ASSIGN
statementis processed.
Assumethat an IPL is performedwith the PRoGRAM LoAD sEtEcToR switchsetting
a t D I S K 1 F 1 . T h e s y s t e mw i l l a s s i g nF l t o D I A f o r a l l p a r t i t i o n st jh e u n i t c o d ea s s i g n e d
to the systempackmust not be usedin the ASSIGNstatement.Two different5444
unit
codescannotbe assigned
to the samesimulationareawithin a partition.
An ASSIGNstatementis not processed
when it is includedamongthe OCL statements
of
a job stepthat is flushed.
lf the PACK and/orAREA parameteris specified,only one simulationareacan be reassigned
on eachASSIGNstatement.
The nameof the area(maindataand/orsimulation)is checkedonly if the appropriate
parameter(PACKand/orAREA) is specified.

BSCAStatement
Function

The BSCAstatementallowsyou to changeall BSCAline specifications
in your program.
Therefore,you can useBSCAline 1 or 2 without recompilingthe program. lf the BSCA
statementis not entered,the line specifications
in the programarenot changed.

Placement

The BSCAstatementmust follow the LOAD or CALL statementand precedethe RUN
statement.

Format

i/ BSCAparameter

Contents

The parameterLINE-codeis a keywordparameter.The codesareasfollows:
Code

SpoolingConsiderations

Meaning

1

Changa
e l l B S C Al i n es p e c iifc a t i o n st o B S C Al i n e 1 .

2

Changeall BSCAline specifications
to BSCAline 2.

None

BSCA Statement

1-23

Function

CALL statements
areneededonly whenyou want to call a procedurefrom the source
library.
To understand
the function of the cALL statement,you must understand
the relationship
betweenthe job streamand procedures.The job streamcontains
the OCL statements
that control the system. The systemreadsthe job streamfrom
the systeminput device.
Procedures
aresetsof ocL statements
in a sourcelibrary on disk. They haveno effect
on the streamuntil they are mergedinto the job stream.
You can modify the procedureidentifiedby a cALL statement, providing
by
other ocL
(procedureoverridestatements,seeChangingProcedureparametercl
statemernts
after the
CALL statement.Thesestatements
temporarilymodify the procedure.The laststatement o1ithe CALL sequence
must be a RUN statement.The RUN statementis required
whethenor not you supplyother OCL statements.(Procedures further
are
explainedin
Part2.)

Placement

cALL statements
can be usedin the job streamor in a procedure.They are,in effect,
replacecl
by the procedures
they identify. The CALL statementmust precedethe RUN
statement.on spooledsystems,it mustfollowthe JoB statement.lt must
not be
b e t w e e nL O A D a n d R U N o r C A L L a n d R U N .

Format

// CALI- procedure-name.unit,switch
(optional)
characters

Contents

Procedure-name"The procedure-name
is the namethat identifiesthe procedurein the
sourcelibrary. You supplythe procedure-name
in the library maintenance
control statements\ hen you usethat programto placethe procedurein the library. (See
Library
MaintenanceProgramin Part 4 of this manualfor restrictionson procedure-name.)
Unit: The unit parameteris a requiredcode. The code identifies
the simulationareathat
containsthe procedure,possiblecodesare R 1 F l, RZ, F2.
,
Switch c'haracters:The switch characters(0. 1, and X) are optional.
Whenyou include
them, you must supply8 characters
because
they are comparedwith the eightexternal
indicatons.The systemdoesa comparisonfor eachpositionif the
switchcharacteris a 0
or 1. An X cancelsthe compareoperationfor that positiononly.
The f irst (leftmost)
switchclraracteris comparedwith externalindicatorl; then the second
switchcharacter
is comparred
with externalindicator2; this processcontinuesuntil the g switchcharacters
and the eightexternalindicatorpositionsareeithercomparedor bypassed.
lf an equal
conditiorrexists,the procedureis called. Otherwise,an informational
message
is displayed
and the job streamis flushedto the next step.

Example

The Proceduressectionin part 2 containscALL statementexampres.

Spooling Considerations

None

Function

The COMPILEstatementtellsthe systemwherethe sourceprogramto be compiledis
located(if it is comingfrom a sourcelibrary),and wherethe objectprogramisto be
placed. (An objectprogramis the resultof compilingor assembling
a sourceprogram.)
The COMPILEstatementalsospecifies
the optionsto the linkageeditor.

Placement

The COMPILEstatementmust be within the set of OCL statements
that apply to the
compilationT
. h e C O M P I L Es t a t e m e nm
t u s tf o l l o w t h e L O A D o r C A L L s t a t e m e nat n d
precedethe RUN statement.

Format

/ / C O M P I L Ep a r a m e t e r s

Contents

All the parameters
are keywordparameters.The keywordsare:
SOURCE: The SOURCEparameter
tellsthe systemthe nameof the sourceprogram.
The keywordSOURCEmust be followedby the nameof the sourceprogramon disk.
The nameis the nameby which the sourceprogramis identifiedon disk in the source
library. You can placesourceprogramsin a sourcelibrary by usingthe library maintenanceprogram.The programnameyou supplyin the librarymaintenance
control statementsis the nameusedto identifythe sourceprogramin the library. (For more information, seeLibrary MaintenanceProgramin Part 4 of this manual.)
lf the SOURCEparameteris not used.the sourceprogramis assumed
to be in the job
streamfollowingthe RUN statement.
The SOURCEparametermust be accompanied
by the UNIT parameter.
UNIT: The UNIT parameteris usedonly when the SOURCEpararneter
is used.
T h e U N I T p a r a m e t ei rs a c o d ei n d i c a t i n g
the simulation
a r e at h a t c c n t a i n st h e s o u r c e
program.Possible
codesare R 1, F 1, R2, F2.
OBJECT: The OBJECTparametertellsthe systemwhereto placethe objectprogram.
The OBJECTparametermay be specifiedwithout the SOURCEand UNIT parameters.
The codesusedto indicatethe simulationareaon which the objectprogramis to be
p l a c e da r e R1 , F l , R 2 , F 2 .
Note: lt the OBJECTparameteris omitted,the objectprogramis placedon the same
simulationareathe compilerwasloadedfrom. The OBJECTparameterdoesnot affect
the placementof FORTRAN or COBOLobjectprograms.
LINKADD: This parameteris the link-editstartaddress.The System/3compilers
( R P Gl l , c O B O L , F O R T R A N )u s et h e o v e r l a yl i n k a g ee d i t o rt o g e n e r a toeb j e c tm o d u l e s .
Normallythe startingaddresses
for theseobject modulesare predetermined.However.
for someapplications,
suchasexecutingobjectprogramsundercontrol of CCP,it is
necessary
to alterthe startingaddresses.
The LINKADD parametercan be usedfor this
purpose(allowableentriesarehex addresses
4000 or 80001.
For executionunderCCP,LINKADD-8000must be usedfor RPG ll objectprogramsand
shouldbe usedfor COBOLand FORTRAN objectprograms.For executionunderother
than CCP,LINKADD-4000must be usedfor RPG ll objectprograms(or the parameter
m u s tn o t b e s p e c i f i e d )F. o r C O B O La n d F O R T R A No b j e c tp r o g r a m sL, I N K A D D - 4 0 0 0
shouldbe specified{or the parametershouldnot be specified).

COMPILE Statement

1-25

ATTR: The ATTR-MROparametertells the overlaylinkageeditor to link-edit
an object
moduler
for the REMAPtechniqueof memoryresidentoverlays.The ATTR-MOV parameter tellsthe overlaylinkageeditor to link-editan object modulefor the MOVE
technique
of memoryresidentoverlays.For additionalinformationabout the memoryresident
overlays,refer to the IBM system/3 overlay Linkage Editor ReferenceManual,
GC21-7561.
'The
Note:
ATTR parametershouldbe usedonly with an o module. (MRo and MoV
prograrnattributeswill not be attachedto an R module.)
The followingsampleCOMPILEstatementtellsthe systemthat the sourceprogramwith
t h e n a m eP R O G 3i s l o c a t e do n t h e s i m u l a t i o n
a r e aa s s i g n etdo F l .

The OBJECT-Rlparametertellsthe systemto placethe objectprogramon the simulation
a r e aa s s i g n etdo R l . T h e L I N K A D D - 4 0 0 0p a r a m e t et re l l st h e l i n k a g ee d i t o rt o l i n k - e d i t
the programto startat addresshex 4000. The ATTR-MRo parametertellsthe linkage
editor to link-editan objectmodulefor the REMAp techniqueof memoryresident
overlays.
Spooling Considerations

1-26

None

DATE Statement
Function

The DATE statementchanges
the systemdateor one of the threepartitiondates.

Placement

SystemDate
To setthe systemdate,the DATE statementis enteredduring IPL beforeany JOB, CALL,
or LOAD statements.
Partition Date
The partitiondatecan be changedby useof the DATE statement.asfollows:
1.

Job Date: lf the DATE statementis enteredafter the JOB statementand beforea
LOAD statement,that datewill remainin effect for the remainderof that job. lt
is restoredto the currentsystemdate for the next job. The DATE statementneed
not precedethe first step;it may be placedprior to any step'sLOAD statement
and will be in effect from that stepto the end of that job.

2.

StepDate: lf the DATE statementis enteredafter a LOAD or CALL statement
and beforethe RUN statementforthat step (that is, if the DATE statementis
enteredwithin a step),the partitiondate is changedfor the durationof that step.
It is restoredto the currentpartitiondate for the next step.

Useof the DATE statementprior to a LOAD statementensures
that the samedate is used
for eachstepin the job. Also,oncea DATE statementis enteredin this manner,a subsequent DATE statementmay be enteredfor the job, but only if it occursprior to a LOAD
statement.
Format

// DATE date

Contents

(mmddyy)or
The systemdatecan be in eitherof two formats: month-day-year
(ddmmyy).
day-month-year
You must specifythe format duringsystemgeneration.

Example

The datecan be written with or without punctuation. For example,July 25. 1993,
could be specifiedin any one of the followingways:
07-25-93

250793

25-07-93

7-2693

072593

25-7-93

Any characters
exceptcommas,apostrophes,
numbersand blankscan be usedas
punctuation.
SpoolingConsiderations

Wheninput spoolingis presenton the system,the dateshouldbe enteredduring lPL.
This entry can be madevia a commandor in response
to the IPL prompt for DATE. lf
the date is not enteredduring lPL, the first job to executemust havea DATE statement
precedingthe first JOB statement.

DATE Statement

1-27

SampleJob Streams

//A

JOB //B JOB / /c JoB

//

LOrAD //

DATE / / DATE

//

DATE //

LOAD / /

LOAD

//

Rr..tN //

RUN

RUN

//

LOAD //

LOAD / /

//

RUN

RUN

/.

//
/.

//

LOAD

/ / DATE
//

RUN

In job A, the partitiondate is changedonly for the first stepof the job. For the second
step,the date is restoredto the systemdate.
In job B. the partitiondate is changedfor all stepsin the job. The date is restoredto the
systemdatefor the next job.
In job C, the partitiondate is changedfor all stepsin the job. The DATE statementin the
secondstepis not allowedand will causea message
to be issued.

t-24

Pageof GC21-5162-1
lssued28 September1979
ByTNL: GN21-5674

(Single
FILE Statement
VolumeDiskFiles)
Function

The FILE statementsuppliesthe systemwith informationaboutdisk files. The system
usesthis informationto readrecordsfrom and write recordson disk.

Placement

You must supplya FILE statementfor eachof the new disk filesthat your programs
create,and for eachof the existingdisk files that your programsuse. The maximum
ler WorkArea in Part 2 of this manual.
numberof f ilesallowedis explainedunderSchedu
The FILE statementmustfollow the LOAD or CALL statementand precedethe RUN
statement.

Format

// FILE parameters

Contents

asfollows (keywordsare in capitalletters):
All of the parameters
are keywordparameters.
N A M E - f i l e n a m(ei n p r o g r a m )
UNIT-5444unit codeor maindataareacode
PACK-name
L A B E L - f i l e n a m(eo n d i s k )
or TRACKS-number
RECORDS-number
/
n r e ao n l y ]
II t r a c k n u m b e r( s i m u l a t i o a
\
number
LOCATION{cvlinder
! tvtaindataareaonly
number
t
f c y l i n d e rn u m b e r / t r a c k
\
RETAIN-code
DATE-date
VERIFY-code
SHARE-code
T h e N A M E , P A C K ,a n d U N I T p a r a m e t e rasr ea l w a y sr e q u i r e d .T h e o t h e r sa r er e q u i r e d
o n l y u n d e rc e r t a i nc o n d i t i o n s .
NAME: The NAME parameteris alwaysneeded.lt tellsthe systemthe namethat your
programusesto referto the file. The NAME parametermust be placedon the first record
or line if two or more recordsor linesare usedfor the FILE statement.(SeeGeneral
CodingRulesf or ruleson continuation.)

F I L E S t a t e m e n t ( S i n g l eV o l u m e D i s k F i l e s l

1-29

Pageof GC21-5162-1
lssued28 September1979
By TN L: GN21-5674

Programs
requiringspecificfile namesf o r d i s kf i l e sa r ea sf o l l o w s :
Program

File

Name

Copy/Dump

In p u t
Output
Output
Work
Work

COPYIN
COPYO
C O P Y P( O p t i o n a l )
$ l N D E X 4 S I( O p t i o n a t )
$ l N D E X 4 O 3( O p t i o n a t )

DiskSort

Input

I N P U To r I N P U T I
I N P U T 2t h r o u g ht N P U T S
W O R K( O p t i o n a l )
OUTPUT

Work
Output
C C P / D i sS
k ort

Input
Work
Input
Work
Output

$SOURCE
$WORK
I N P U To r I N P U T 1
I N P U T 2t h r o u g ht N P U T g )
WORK
OUTPUT

Dump/Restore

Input
Output

BACKUP
BACKUP

SpoolFile Copy

Output
P R I N T O 2( O p t i o n a l )
Output
P U N C H O 2( O p t i o n a t )
Input
R E A D E R 0 2( O p t i o n a t )
Output
R E A D E R 0 2( O p t i o n a t )
Input
C O N T R O L 2( O p t i o n a t ,
Output
D I S P L A Y O 2( O p t i o n a t )
In p u t
R E S T O R E 2( O p t i o n a t )
I nput/update A U T H O R I Z( O p t i o n a t )

Assembler

Input
Output
Work

$SOURCE
$WORK
$WORK2

COBOL
Compiler

In p u t
Work
Work

$SOURCE
$WORK
$WORKX

FORTRAN
Compiler

In p u t
Work

$SOURCE
$WORK

SystemHistory
A r e aD i s p l a y

Output

$HISTORY

SystemHistory
AreaCopy
R P Gl l C o m p i l e r

Output

$ S H A FI L E

Input
Work

$SOURCE
$WORK

In p u t
Work

$SOURCE
$WORK

R P Gl l A u t o
Report

1..
a L A B E L p a r a m e t e r i n t h e F I L E s r a t e m e n t ,i t m u s t b e L A B E L - $ l N D E X 4 5 .
2rT.yojr.suppry
t"r name can be repraced by the name specified on
a contror statement paramerer.
,,',n"
r T y o u s u p p r y a L A B E L p a r a m e t e ri n t h e F r L E s t a r e m e n t ,
ir must be LABEL-$rNDEX4o.

1-30

Names
r e q u i r e do n l y
for generation
(compile)

Program

File

Name

MacroProcessor

Output

$ S O UR C E

O v e r l a yL i n k a g e
Editor

Input
Work

$SOURCE
$WORK

Spool (SeeNote)

Work

$SPOOL

Any program
addingto large
i n d e x e df i l e so r
l o a d i n ga l a r g e
unordered
i n d e x e df i l e .

Work

$ l N D E X 4 5 1( O p t i o n a l )
( f o r m a i nd a t aa r e af i l e )
or
$ l N D E X 4 O 2( O p t i o n a l )
( f o r m a i nd a t aa r e af i l e )

O p t i o n a -l e i t h e rb o t h
presentor both absent

on
lUote.'The $SPOOLfile is internallygeneratedby spoolingand cannotbe referenced
a FILE statement.
The keyword,NAME, must be followed by the filenameusedby the program.The fileor blanks. The
exceptcommas,apostrophes,
namecan be any combinationof characters
not
exceed
8. The
must
first charactermust be alphabetic.The numberof characters
F
I
L
E
A
w
o
u l db e
p
a
r
a
m
e
t
e
r
n
a
m
e
d
for a file
f o l l o w i n ge x a m p l es h o w sh o w t h e N A M E
coded:

IJNIT: The UNIT parameteris alwaysneeded.lt tellsthe systemthe simulationareaor
m a i nd a t aa r e at h a t c o n t a i n so r w i l l c o n t a i nt h e f i l e . T h e k e y w o r d ,U N I T . m u s tb e
R 1 , F 1 , R 2 , F 2 , D 1, D 2 ,
f o l f o w e db y a c o d et h a t i n d i c a t et sh e a r e a .P o s s i b cl eo d e s a r e
D 3 o r D 3 1 .D 3 2 ,D 3 3 ,D 3 4 , D 4o r D 4 1 , D 4 2 , D 4 3 , D 4 4 .
The previousexampleshowshow the UNIT parameterfor a file locatedon the maindata
areaD1 would be coded.
PACK: The PACK parameteris alwaysneeded.lt tellsthe systemthe nameof the area
that containsor will containthe file. The systemchecksthis nameto ensurethat the
properareais beingused. (For informationabout how an areais givena name.seeDisk
lnitialization Program or Simulation Area Program in Part 4 of this manual.)
The keyword,PACK,must be followed by the nameof the area. The exampleunder
N A M E s h o w sh o w t h e P A C Kp a r a m e t ef ro r a f i l e o n a n a r e an a m e dV O L I w o u l db e
coded.

1lf you
s u p p l ya L A B E L p a r a m e t e ri n t h e F I L E s t a t e m e n t ,i t m u s t b e L A B E L - $ l N D E X 4 5 .
'lf you
s u p p l y a L A B E L p a r a m e t e r i n t h e F I L E s t a t e m e n t ,i t m u s t b e L A B E L - $ l N D E X 4 0 .
F I L E S t a t e m e n t( S i n g l eV o l u m e D i s k F i l e s )

1-31

L A B E L : T h e L A B E L p a r a m e t et re l l st h e s y s t e mt h e n a m eb y w h i c hy o u r f i l e i s i d e n t i f i e d
or will be identified.
l f t h e f i l e i s b e i n gc r e a t e dt,h e n a m ey o u s u p p l yi n t h e L A B E L p a r a m e t ei rs u s e dt o
i d e n t i f yt h e f i l e . l f y o u o m i t t h e L A B E L p a r a m e t efr o m a d i s k F I L E s t a t e m e n t h
.e
n a m ef r o m t h e N A M E p a r a m e t ei rs u s e d .
W h e nt h e n a m ey o u r p r o g r a mu s e st o r e f e rt o a n e x i s t i n gd i s kf i l e d i f f e r sf r o m t h e n a m e
b y w h i c ht h e f i l e i s i d e n t i f i e dy, o u m u s ts u p p l ya L A B E L p a r a m e t e r .
The keyword,LABEL, must be followedby the nameof the file. The namecan be any
combinationof characters
exceptcommas,apostrophes,
or blanks. The first character
must be alphabetic.The numberof characters
must not exceed8. The LABEL parame t e rf o r a f i l e n a m e dP A Y R O L Li s c o d e di n t h e f o l l o w i n ge x a m p l e :

TRACKSor RECOBDS: The TRACKSor RECORDSparameteris neededfor f ilesthat
arebeingcreated.The parametertells the systemthe amountof spaceneededon disk for
thef ile.
l f y o u u s et h e T R A C K Sk e y w o r d y, o u s p e c i f yt h e n u m b e ro f d i s kt r a c k sn e e d e df o r t h e
file.
lf you usethe RECORDSkeyword,you specifythe approximatenumberof recordsfor
t h e f i l e . T h e t o t a l s p a c ea l l o c a t e d
w i l l b e r o u n d e du p t o f u l l t r a c k s a
, l l o w i n ga d e q u a t e
spaceto accommodate
at leastthe numberof recordsindicated.This meansthe file could
h o l d m o r er e c o r d st h a ns p e c i f i e o
d n t h e R E C O R D Sk e y w o r d .a l l o w i n gy o u t o a d d m o r e
recordsto the file. Therefore,when usingthe copy/dumpprogram($COPY)to copy
the file to anotherdisk.you may haveto specifymore recordsthan werespecifiedin the
RECORDSkeywordwhen the file wascreated.
E i t h e rT R A C K So r R E C O R D Sc a na p p e a irn t h e F I L E s t a t e m e n tb, u t n o t b o t h . T h e
keywordmust be followedby a numberindicatingthe amountof spaceneeded.
W h e nl o a d i n ga n e w f i l e a t t h e s a m el o c a t i o na sa n e x i s t i n gf i l e , u s i n gt h e L O C A T I O N
parameter,
you must specifythe sameparameter(TRACKSor RECORDS)that wasused
w h e nt h e e x i s t i n gf i l e w a sc r e a t e d .( T h ee x i s t i n gf i l e m u s tb e a t e m p o r a r yf i l e . )
Severalversionsof a file can be createdon the samedisk and be giventhe samename. lf
t h e T R A C K So r R E C O R D Sp a r a m e t eyro u a r eu s i n gi n c r e a t i n ga f i l e i s t h e s a m ea st h e
T R A C K So r R E C O R D Ss p e c i f i e fdo r a n e x i s t i n gf i l e , y o u m u s ts p e c i f yL O C A T I O N .Y o u
can reference
eachof thesefiles by its nameand date,or by its nameand locationon
disk. Both dateand locationmust be uniquefor eachversion. (SeeExample2, Example
4, and File ProcessingConsiderations.l

1-32

l f T R A C K Si s u s e d t, h e n u m b e rm u s tb e w i t h i n t h e r a n g eo f 1 - 3 9 8 f o r a s i m u l a t i o n
area;
1-3320for a maindataareaon a 3340, and 1-3720 for a maindataareaon a 3344. The
f o l l o w i n ge x a m p l es h o w sh o w t h e T R A C K Sp a r a m e t ef ro r a f i l e r e q u i r i n g2 0 t r a c k si s
coded:

l f R E c o R D S i s u s e d t, h e n u m b e rc a n b e u p t o s i x d i g i t sl o n g . T h e R E c o R D Sp a r a m e t e r
f o r a f i l e c o n t a i n i n g2 5 0 r e c o r d si s c o d e da sf o l l o w s :

L O C A T I O N : L O C A T I O Ni s r e q u i r e dw h e ny o u c r e a t ea f i l e w i t h t h e s a m eL A B E L ( t h e
d a t em u s tb e u n i q u e )a n d t h e s a m es i z ea so n e t h a t a l r e a d ye x i s t s( L O C A T I O Ni s n o t
r e q u i r e di f s i z e sd i f f e r ) , l o a dt o a n e x i s t i n gf i l e , a n dl o a da n o f f l i n em u l t i v o l u m e
fileto
v o l u m e st h a t c o n t a i no t h e rf i l e s .
The LOCATION parametercan be usedto specifythe first track of a new file. lt may
a l s ob e u s e dw h e na f i l e i s r e f e r e n c e d
f o, r a m o r es p e c i f i ci d e n t i f i c a t i ocnh e c k ,a n d f o r
i d e n t i f y i n go n eo f s e v e r af il l e sh a v i n gt h e s a m en a m ea n d s a m es i z e .
l f y o u a r ec r e a t i n ga f i l e .t h i s p a r a m e t et re l l st h e s y s t e mt h e n u m b e ro f t h e t r a c ko n w h i c h
t h e f i l e i s t o b e g i n .l f y o u o m i t t h e p a r a m e t e trh. e t r a c k i s c h o s e nf o r y o u . T h e s y s t e m
p l a c e tsh e f i l e i n t h e s m a l l e sat v a i l a b lsep a c eo n t h e p a c k ,l e a v i n g
a sf e w e m p t ys p a c e s
a sp o s s i b l e .
lf you are referencing
a file, the parametertells the systemthe numberof the track on
w h i c ht h e f i l e b e g i n s .I n t h i sc a s et,h e s y s t e mu s e st h e t r a c kn u m b e rt o d i s t i n g u i sohn e
file fromanother.
F o r a s i m u l a t i o na r e a t, h e L O C A T I O Nf o r m a ti s :
L O C A T I O N - t r a cnku m b e r
Tracknumbermust be between8 and 405.
Tracks0-7 are reserved
for the svstem.
F o r a m a i nd a t aa r e a t, h e L O C A T I O Nf o r m a ti s :

t

Tralk numbermust be between0 and 19. Track
n u m b e r0 i s a s s u m e idf t r a c kn u m b e ri s n o t s p e c i f i e d .
Cylinden
r u m b e rm u s tb e b e t w e e n1 a n d 1 6 6 ( m a i n
dataareaon 3340) or 1 and 186 (maindataareaon
a 3344). Cylinder0 is reserved
for the system.
F I L E S t a t e m e n t( S i n g l eV o l u m e D i s k F i l e s )

1-33

R E T A I N : T h e R E T A I Nk e y w o r dm u s tb e f o l l o w e db y a c o d et h a t i n d i c a t e s
theclassific a t i o n so f t h e f i l e . T h e c o o e sa r e :
Codr:

Meaning

S

Scratch file

T

T e m p o r a r yf i l e

P

P e r m a n e n tf i l e

A scratch file is used only once in a program and cannot be retrieved
after the program
h a s e n d e d . T o r e m o v ea p e r m a n e n tf i l e y o u m u s t u s e t h e f i l e
delete(gDELET) system
s e r v i c ep r o g r a m . Y o u c a n r e m o v ea t e m p o r a r y f i r e b y u s i n g
t h e f i r e d e r e t e( g D E L E T )
s y s t e ms ; e r v i c p
e r o g r a mo r b y u s i n ga R E T A I N - s p a r a m e t e r . A t e m p o r a r y f i l e
can be
c h a n g e dt o a p e r m a n e n tf i l e o n l y i f t h e f i l e n a m e i s c h a n g e d
o r c o p i e d a sa p e r m a n e n t
f ile.
A t e m p o r a r y f i l e i s u s u a l l y u s e d m o r e t h a n o n c e . T h e a r e ac o n t a i n i n g
a temporaryfile
c a n b e g i v e nt o a n o t h e r f i r e o n r y u n d e r o n e o f t h e f o i l o w i n g
conditions:
'

A F l l - E s t a t e m e n tc o n t a i n i n gt h e R E T A I N - S p a r a m e t e ri s s u p p l i e d
for the temporary
f i l e a n d t h e f i l e r e f e r e n c e d( o p e n e da n d c l o s e d )b y t h e u s e r p r o g r a m .
This statement
r e m o ' / e st h e f i l e f r o m t h e V T o c ( v o l u m et a b l e o f c o n t e n t s )
w h e n t h e p r o g r a mw i t h
t h e F I L E s t a t e m e n tg o e st o e n d o f j o b . T h e u s e r m u s t b e a w a r e
of any external
i n d i c a t o r st h a t c o n d i t i o n t h e u s e o f t h a t f i l e . M o r e i n f o r m a t i o n
a b o u t d e l e t i n gf i l e s
is provided under General Results When the 2 or 3 Option
for a Messageis Selected
in the IBM System/3 Modet lS System Mesages, GC21-5076.

o Another file with the sameLABEL name is
l o a d e d i n t o t h e e x a c t a r e ao c c u p i e d b y
t h e t e m p o r a r y f i l e , b u t t h i s o n l y c h a n g e st h e d a t a . s p a c e a n d l o c a t i o n p a r a m e t e r s
a r e r e q u i r e d . Y o u m u s t s p e c i f y t h e s a m ep a r a m e t e r( T R A C K S
or RECoRDS) that
w a s u s e d w h e n t h e e x i s t i n gf i l e w a s c r e a t e d . F o r e x a m p l e , i f
the TRACKS parameter
w a s s p e c i f i e dw h e n t h e F I L E w a s c r e a t e d ,y o u m u s t u s e t h e
T R A C K S p a r a m e t e rw h e n
r e l o a d i n gt h e s a m el o c a t i o n o n t h e p a c k .
o T h e f i l e d e l e t e p r o g r a m i s u s e dt o d e l e t e
the f ile.
T h e a r e ac o n t a i n i n ga p e r m a n e n tf i l e c a n n o t b e u s e d f o r a n y o t h e r
file until the file
d e l e t e p r o g r a m h a s d e l e t e dt h e p e r m a n e n tf i l e .
A d i s k f i t e i s c l a s s i f i e da s s c r a t c h ,t e m p o r a r y , o r p e r m a n e n tw h e n
it iscreated. lf the
R E T A I N p a r a m e t e ri s o m i t t e d f r o m t h e F I L E s t a t e m e n tw h e n
t h e f i l e i s c r e a t e d ,t h e f i l e
i s a s s u m e dt o b e a t e m p o r a r y f i l e . Y o u m a y o m i t t h e R E T A I N p a r a m e t e r
when accessino
a n e x i s t i r r gf i l e .

1-34

Notes:
1 . T h e o u t p u t f i l e w i l bl e s c r a t c h e d ( d e l e t ief da)l l t h r e e o ft h e f o l l o 6 n g c o n d i t i o n s
existat end of job step:
a . A p a c kc o n t a i n i n g
a n i n p u t f i l e i s n o t o n l i n ea t t h e s t a r to f t h e i o b
( d e f e r r em
d ount).
b. The output fire is to be written overthe input fire (roadto ord).
c . R E T A I N - Si s u s e do n t h e F I L E s t a t e m e nfto r t h e i n p u t f i l e .
To preventthe deletionof theoutput fire, you shourduseRETATN-Tfor
the
input file.
2 ' Y o u s h o u l dr e l o a da n e x i s t i n g t e m p o r a rf yi l e ( l o a dt o o l d ) w i t h f i l e so f l i k e
attributes.
l f a n e x i s t i n gi n d e x e df i l e i s r e l o a d e d
w i t h a s e q u e n t i af ill e ,t h e n e w d a t aw i l l o v e r l a y
only the data portion of the indexedfile. The index portion of the file
will remain
i n t a c tb u t w i l l n o t b e u s a b l e .
The R ETAIN parameterfor a permanentf ile is codedas follows:

DATE: The DATE parameterteilsthe systemthe creation
dateof an input fire. rt is
usedto ensurethat the properversionof the file is used.
The datespecifiedis compared
with the creationdatecontainedin the file label. No comparison
is donewhen DATE is
not specified.
For output files,the partitiondate is alwaysusedas
the creationdate. rf the DATE
parameteris specifiedfor an output file, the system
comparesthe specifieddatewith the
creationdateof the existingfile. lf no file exists,or if the
datesdo not agree,the system
halts' (Seelnterval Timer for informationon the effect
of the intervaltimer on date.)
The date may be codedin one of two formats: month_day-year
(mmddyy),or
day-month-year
(ddmmyy). The format must matchthe format
of the systemdate
chosenduringsystemgeneration.The datemay be coded
with or without punctuation.
Blanks,commas,numbers,or apostrophes
are not ailowedas punctuation. Leadingzeros
in month and day may be omitted if punctuationis used.
To illustratethis parameter,
assumethat two versionsof a file arewritten on the same
m a i nd a t aa r e a . I n t h e n e x t e x a m p l ea r et h e N A M E , L A B E
L , a n d D A T E p a r a m e t e rf o
sr
two versionsof a file on the samemain dataarea,one written
on April s, 1976,theother
o n A u g u s t3 , 1 9 7 6 . B o t hf i l e sh a v et h e s a m el a b e:l F 0 0 0 1 .

F I L E S t a t e m e n t( S i n g t eV o l u m e D i s k F i t e s )

1_35

VERIFY': The VERIFY parameteris usedto specifyverificationof disk write operations
f o r t h i s f i l e i n t h i s s t e p ( m a i n d a t a a r e a o nl fl V
y )E. R I F Y - Y E s i s s p e c i f i e d , v e r i f i c a t i o n
t a k e sp l a c e .l f V E R I F Y - N Oi s s p e c i f i e dw, r i t ev e r i f i c a t i o n
i s b y p a s s e dl.f V E R I F Y i s n o t
s p e c i f i e dV, E R I F Y - Y E Si s a s s u m eudn l e s sR E T A I N - Si s c o d e d ,i n w h i c hc a s eV E R I F Y - N O
i s a s s u m e dV. e r i f i c a t i o ni s a l w a y sd o n ew h e na s i m u l a t i o na r e ai s a c c e s s e d .
SHARE: The SHARE parameteris usedto allow or disallowfile sharingbetweenpartit i o n s i f t h e a c c e s s m e t h o d s a r e c o m p a tIifbSl e
H.A R E - Y E S i s s p e c i f i e d , f i l e s h a r i n g i s
a l l o w e db e t w e e np a r t i t i o n s( o f f l i n em u l t i v o l u m e
f i l e sc a n n o tb e s h a r e d )S; H A R E - N O
d o e s n o t a l l o w f i l e s h a r i n g b e t w e e n p a r t i t il o
f n
RsE. T A I N - S i s s p e c i f i e d o n t h e F l L E
s t a t e m e n ft i,l e s h a r i n gi s n o t a l l o w e d .l f t h i s p a r a m e t ei rs o m i t t e d ,S H A R E - Y E Si s
assumed.For additionalinformationabout f ile sharing,referto File Sharingin Part2
of thismanual.
Examples

T h e f o l l o w i n ga r ee x a m p l eos f F I L E s t a t e m e n t sI.n e a c he x a m p l et,h e f i l e i s d e s c r i b e d
first, therrthe corresponding
FILE statementis shown.
Example/.' Supposethat eachweekyou createa disk f ile that containsthe recordsfor
you had madethat week. Assumethe followingfactsabout that file:
the transactions
.

The nameyour programusesto referto the file is TRANS.which is alsothe nameyou
w a n tt o u s et o i d e n t i f yt h e f i l e o n d i s k .
Y o u a r ep l a c i n gt h e f i l e i n a m a i nd a t aa r e an a m e dV O L 0 3 .
You irrtendto mount the data moduleon drive 2.
You want to savethe file for useat the end of the month.
The file contains225 records.
You are lettingthe systemchoosethe areathat will containthe file.

T h ef o l l o w i n ge x a m p l es h o w sh o w t h e F I L E s t a t e m e nfto r t h e p r e c e d i nfgi l e i s c o d e d :

1-36

Example2.' supposeyou had created,on the samedata module(voLo3), four versions
of the transactionfile describedin the precedingexample-onefor eachof the weeksin
F e b r u a r y1 9 7 6 . A s s u m et h e f o l l o w i n g :
o Y o u h a dc r e a t e dt h e f i l e so n t h e f o l l o w i n gd a y s : 2 1 6 / 7 6 , 2 1 1 3 1 7 6 , 2 / 2 0 / 7a6n.d
2127176(thesewerethe systemdatesusedfor eachof the files).
o You want to referencethe third file (the one created2120176l
.
r

Y o u i n t e n dt o m o u n tt h e d a t am o d u l eo n d r i v e2 .

T h e F I L E s t a t e m e nyto u w o u l dn e e di s :

Example3.' Supposethat at the end of the month you combinethe files referredto in
e x a m p l e2 , f o r u s ei n p r e p a r i n ygo u r m o n t h l yb i l l s . F u r t h e ra s s u m teh e f o l l o w i n g :
o Your programusesthe nameTRANS to referto the file, but you want to usethe name
B I L L I N Gt o i d e n t i f yt h e f i l e o n d i s k .
o You areexpressing
the amountof disk spaceasthe numberof tracksrequiredto cont a i n t h e f i l e ( a s s u mteh e n u m b e ri s 1 5 ) ,a n d y o u w a n t t h e f i l e t o b e g i no n c y l i n d e r8 ,
track 0.
o Y o u a r ep l a c i n gt h e f i l e i n a m a i nd a t aa r e an a m e dV O L 0 3 .
o You intendto mount the data moduleon drive 2.
T h e f o l l o w i n ge x a m p l es h o w st h e F I L E s t a t e m e nyt o u w o u l du s ef o r t h i sf i l e .

F f L E S t a t e m e n t ( S i n g l eV o l u m e D i s k F i l e s )

1-37

Example4" Supposeyou want to createtwo versions
of two fileson disk and laterto
access
one versionof eachf ile. Furtherassumethe following:
o The namesyour programusesto referto the files
are AA and BB, which arealsothe
namesyou want to useto identify the fileson disk.
o FilesAA and BB are beingpracedon a datamodure
on drive 2 named D2D2D2.
o O n ev e r s i o no f e a c hf i l e i s c r e a t e do n 1 1 1 2 / 7 6
a n d1 / 1 3 1 7 6 .
o Disk spaceand locationfor the filesare:

File

Version

AA

1112/76
1/13176

10
10

120/O
130/0

BB

1/12/76
1/13/76

20
20

140/O
150/0

Tracks

Location

o Y o u w a n t t o a c c e sfsi r eA A , v e r s i o n1 / 1 2 / 7 6 , a n d
f i r e B B ,v e r s i o n1 1 1 3 / 7 6 .
The followingOCL statements
are neededto createthe aboveversionsof filesAA and BB
and to access
a versionof eachfile.

1-38

F i l eP r o c e s s i nCgo n s i d e r a t i o n s

L O C A T I O Na n d s p a c e( T R A C K So r R E C O R D Sm
) u s tb e s p e c i f i e w
d h e ny o u a r er e l o a d .
i n ga n e x i s t i n gt e m p o r a r yf i l e . Y o u m u s ts p e c i f yt h e s a m ep a r a m e t e(rT R A C K So r
R E C O R D St)h a t y o u u s e dw h e nt h e e x i s t i n gf i l e w a sc r e a t e d .
lf you arereferencing
a file by the DATE parameterand spaceis given,the spacemust
be equalto the spacegivenwhenthat file wascreated.
lf you areaccessing
a file by the LOCATIONparameterand spaceis given,the space
must be equalto the spacegivenwhen that file wascreated.
You can createseveralversionsof a file with a programby changingthe locationsof the
f i l e sa n d u s i n gd i f f e r e n tp a r t i t i o nd a t e s .
You can createdifferentversionsof a file without LOCATIONif the spaceparameters
as
well asthe partitiondatesaredifferent.
T h e D A T E p a r a m e t ei rs a l l o w e do n l y f o r a c c e s s i negx i s t i n gf i l e s .
Whenever
a load is performedto an existingfile (loadto oldl, the partitiondate replaces
previous
the
datefor that f ile.
T h eo n l y f i l e t h a t c a nb e r e l o a d e d
i s a f i l e t h a t h a sa R E T A I N - Tc l a s s i f i c a t i o n .
Whena scratchfile is created,it is not enteredin the volumetableof contents(VTOC).
After the job stepthat createdthe file is executed,the file cannotbe accessed.

SpoolingConsiderations

None

F I L E S t a t e m e n t ( S i n g l eV o l u m e D i s k F i l e s )

1-39

FILE Statement
(Multivolume
Disk Files)
Function

T h e F I L E s t a t e m e nstu p p l i etsh e s y s t e mw i t h i n f o r m a t i o na b o u td i s kf i l e s . T h e s y s t e m
usesthisinformationto readrecordsfrom and write recordson disk.

Placement

Y o u m u s ts u p p l ya F I L E s t a t e m e nfto r e a c ho f t h e n e w d i s kf i l e st h a t y o u r p r o g r a m s
create,and for eachof the existingdisk filesthat your programsuse. The FILE
statement
mustfollow the LOAD or GALL statementand precedethe RUN statement.

Format

// FILE parameters

Contents

T h e F I L E s t a t e m e nfto r m u l t i v o l u m e
d i s kf i l e sr e q u i r e s p e c i acl o n s i d e r a t i o w
n sh e ny o u
d e f i n ea n dc o d et h e s ek e y w o r dp a r a m e t e r sP: A C K ,u N l r . T R A C K So r R E C O R D S ,
H I K E Y ,a n d L o c A T l o N . T h e m a x i m u mn u m b e ro f m u r t i v o r u mfei r e sa i l o w e d
is
explainedunderSchedulerWorkArea in Part2 of this manual. Theseconsiderations
arenecessary
for the followingreasons:
o W h e np r o c e s s i ndgi s kf i l e sc o n t a i n e d
o n m o r et h a n a s i n g l ev o l u m e t, h e s y s t e mr e q u i r e s
informationabout eachvolumeto performall the necessary
protectionand checking
functions.
o Additionalinformationis neededto determineand check
the sequence
in which the
volumesare processed
and whenthey areto be mountedon the disk drives.
The rulesfor codinga list of data or codesafter a kevwordareasfollows:
The list must be enclosedby apostrophes.
The itemsin the list must be separated
by commas.No blanksareallowedwithin or
b e t w e e ni t e m s( H I K E Yc a nc o n t a i nb l a n k s ) .
T h e f o l l o w i n ge x a m p l es h o w sl i s t si n p a r a m e t e r sT.h e f i l e i s a n o n l i n em u l t i v o l u m e
file
( n u m b eo
r f u n i t s= n u m b e ro f v o l u m e s ) .

T h e P A C K ,L o c A T l o N , T R A C K So r R E C o R D Sa, n d H I K E y p a r a m e t e r se q u i r et i s t s .
T h e U N I T p a r a m e t em
r a y r e q u i r ea l i s t . T h e c o n s i d e r a t i o n
f osr u s i n gt h e l i s t si n t h e s e
parameters
are includedin the followingparameterdiscussions.
(Parameters
not mentionedhereare usedasexplainedunderthe FILE Statement[single Volume Disk FilesJ.l

140

P A C K : T h e n a m e so f t h e v o l u m e st h a t c o n t a i no r w i l l c o n t a i nt h e m u l t i v o l u m e
filemust
f o l l o w t h e k e y w o r dP A C K . ( P A C Kn a m e sm u s tb e u n i q u ef o r p r o p e rf u n c t i o n i n g . )
W h e na m u l t i v o l u m e
f i l e i s c r e a t e dt,h e s y s t e mw r i t e sa s e q u e n cneu m b e ro n t h e d i s k st o
indicatethe orderof the volumes.The volumesare numberedin the order in which vou
l i s t t h e i rn a m e si n t h e P A C Kp a r a m e t e r .
Whena multivolumefile is processed,
the systemprovidestwo checksto ensurethat the
v o l u m e sa r eu s e di n t h e p r o p e ro r d e r :
o l t c h e c k st o e n s u r et h a t t h e v o l u m e sa r eu s e di n t h e o r d e rt h a t t h e i rn a m e sa r el i s t e di n
the PACK parameter.
o lt checksthe sequence
numbersof the volumesusedto ensurethat thev areconsecutive and in ascending
order (01, 02, andso on ).
The systemstopswhen it detectsa volumethat is out of sequence.The operatorcan do
o n e o f t h r e et h i n g s :
o M o u n tt h e p r o p e rv o l u m e( i f d i s m o u n ti s a l l o w e d a
) n dr e s t a r th e s y s t e m .
Restartthe systemand processthe volumethat is mountedif the sequence
is ascending
(for indexedfiles processed
offline, consecutive
input, and consecutive
updateprocess
i ng).
End the program.
Consecutiveinput or update sequencenumbers do not exist if the file was not created as
a m u l t i v o l u m e f i l e . l f a f i l e i s c r e a t e da s m u l t i v o l u m e a n d t h e s e q u e n c ei s a s c e n d i n gb u t
n o t c o n s e c u t i v ea, d i a g n o s t i ch a l t i s g i v e n .
T h e f o l l o w i n g i s a n e x a m p l e o f t h e P A C K p a r a m e t e rf o r a n o f f l i n e m u l t i v o l u m e f i l e t h a t
i s c o n t a i n e do n t h r e e v o l u m e s ,n a m e d V O L 1 , V O L 2 , a n d V O L 3 :

UNIT: The keywordUNIT must be followed by a codeor codesindicatingthe location
o n t h e d i s k u n i t t h a t c o n t a i n so r w i l l c o n t a i nt h e f i l e . N o U N I T p a r a m e t em
r aybe
r e p e a t e dP
. o s s i b lceo d e sf o r o f f l i n em u l t i v o l u m ef i l e sa r eD 1 a n d / o rD 2 . ( D 1 i s a p o s s i b l e
c o d eo n l y i f t h e I P L w a sp e r f o r m e df r o m d r i v e3 ) . P o s s i b lceo d e sf o r o n l i n em u l t i v o l u m e
f i l e sa r eD 1 , D 2 , D 3 o r D 3 1 ,D 3 2 ,D 3 3 ,D 3 4 , D 4o r D 4 1 , D 4 2 , D 4 3a, n dD 4 4 .
The orderof codesin the UNIT parametermust correspondto the orderof namesin the
PACK parameter.
W h e nt h e s y s t e mi s p r o c e s s i nogf f l i n em u l t i v o l u m e
f i l e sa n d m o r et h a no n e u n i t i s s p e c i f i e d ,t h e u n i t p a r a m e t e rms u s tb e i n a s c e n d i nsge q u e n c e .

F I L E S t a t e m e n t( M u l t i v o l u m eD i s k F i l e s )

1-41

when you are creatingor processing
a sequential
or indexedfile, you can usethe same
d r i v ef o r m o r et h a n o n eo f t h e v o l u m e sh; o w e v e rt,h e v o l u m e sm u s tt h e n a l l b e r e m o v a b l e .
l f y o u d o u s et h e s a m ed r i v e ,y o u m u s tn o t r e p e at h e c o d ef o r t h e d r i v ei n t h e U N l r
p a r a m e t e rW
. h e nt h e n u m b e ro f c o d e si n t h e U N I T p a r a m e t eirs l e s st h a n t h e n u m b e ro f
namesin the PACK parameter,
the systemusesthe codesalternately.
l f y o u s p e c i f ya v o l u m eo n d r i v e3 o r d r i v e4 , t h e f i l e m u s tb e o n l i n em u l t i v o l u m e .
Assumethat your programprocesses
an offline file consecutively.Furtherassumethe
following:
o T h ed i s k sc o n t a i n i n g
t h e f i l e a r en a m e dV o L l , v o L 2 , a n d V o L 3 . r e s p e c t i v e l y .
.

Y o u i n t e n dt o m o u n t V o L l a n d V O L 3 o n 3 3 4 0 d r i v e1 . a n d V o L 2 o n 3 3 4 0d r i v e2 .
( T h eI P L m u s tb e p e r f o r m e df r o m d r i v e3 . )

I n t h e f o l l o w i n s@
, s h o w st h e P A C Ka n d U N l r p a r a m e t e rf so r t h e f i l e . l f a l l t h r e e
volumeswereusedon 3340 drive2, the uNlr parameterin
@ would havebeenused.

TRACKSoTREC)RDS: Thesekeywords,TRACKSor RECoRDS,must be followedby
n u m b e r st h a t i n d i c a t et h e a m o u n to f s p a c en e e d e do n e a c ho f t h e v o l u m e st h a t w i l l c o n t a i nt h e m u l t i v o l u m e
f i l e . T R A C K So r R E C O R D Sm u s tb e s p e c i f i e dA
. ny multivolume
f i l e l o a dr e q u i r e as T R A C K So r R E C O R D Sp a r a m e t ewr h e t h e rt h e f i l e p r e v i o u s leyx i s t e d
or not. The orderof thesenumbersmustcorrespondto the order of the namesin the
P A C Kp a r a m e t e rF. o r e x a m p l ea, s s u m teh e f o l l o w i n g :
o T h e p r o g r a mi s c r e a t i n ga s e q u e n t i a( o
l f f l i n e )f i l e o n t h r e ev o l u m e s :v o L 1 , V o L 2 , a n d
VOL3.
o The first 50 recordsareto be placedon voLl, the next s00 on voL2, and the last 200
on VOL3.
T h e P A C Ka n d R E C O R D Sp a r a m e t e rf o
s r t h e f i r ea r e :

LOCATION: The keyword LOCATIONrnustbe followedby the numbersof the tracks
on which the f ile is to beginon eachof the volumesyou usefor the file. The orderof the
numbersmustcorrespondto the order of the namesin the PACK parameter.For
e x a m p l ea, s s u m teh e f o l l o w i n g :
.

T h ev o l u m e sc o n t a i n i n tgh e f i l e a r eV O L 1 , V O L 2 . a n d V O L 3 .

.

T h e f i l ei s t o b e g i no n c y l 1 0 0i n V O L 1 , c y l 1 0 i n V O L 2 ,a n dc y l 8 i n V O L 3 .

The PACK and LOCATIONparameters
for the file areshownin the followingexample.

lf you omit the LOCATIONparameter,
the systemchoosesthe beginningtrack on each
o f t h e v o l u m e s .W h e na n o f f l i n em u l t i v o l u m e
f i l e i s c r e a t e do, f f l i n ev o l u m e sc a n n o t
containfiles if the LOCATIONparameteris not specified.lf LOCATIONis specified
f o r o n ev o l u m e ,i t m u s tb e s p e c i f i e fdo r a l l v o l u m e s .l f t h e m u l t i v o l u m e
fileexists,
LOCATIONgivenfor all volumesmust be identicalto the LOCATIONparameters
specified when the file wascreated.
R E T A I N : R E T A I N - sm u s tn o t b e s p e c i f i e u
d n l e s st h e f i l e i s o n l i n em u l t i v o l u m e .
H I K E Y : T h e H I K E Y p a r a m e t ei rs u s e do n l y f o r m u l t i v o l u m ei n d e x e df i l e s . H I K E y
l i m i t st h e h i g h e skt e y f i e l d t h a t c a n b e p u t o n e a c hv o l u m eo f a m u l t i v o l u m e
file. The
f o l l o w i n ge x a m p l ec o n t a i n sa n e x a m p l eo f a H I K E Y p a r a m e t el ri s t . I n t h i sc a s et,h e
threevolumescontainlistsof names.The highestkeyfieldallowedon the first volumeis
J O N E S .T h i sm e a n st h a t a l l t h e r e c o r d sb e g i n n i n w
g i t h A a n d i n c l u d i n gJ O N E Sw i l l b e
processed
on this volume. SinceHIKEY parameters
must be in ascending
order,the next
v o l u m ew i l l c o n t a i na l l o f t h e r e c o r d sw i t h n a m e sf o l l o w i n gJ o N E Sa n d i n c l u d i n g
NlcHoL. The lastvolumewill containall the recordswith namesthat comeafter
NICHOL.

O C Lc o n s i d e r a t i o n
f osr t h e H I K E Y p a r a m e t earr e :
All characters
exceptcommasarevalid.
The list of HIKEY parameters
must beginand end with an apostropheevenif only
one parameteris specified.A singleapostrophein a key field must be written asa
doubleapostrophein the H I KEY parameter.
For eachPACK parameterspecified,there must be a corresponding
HIKEY key f ield
parameterfor that pack.

F I L E S t a t e m e n t( M u l t i v o l u m eD i s k F i l e s )

143

T h e H I K E Y f i e l d sm u s tb e e q u a li n l e n g t ha n d m u s tb e s p e c i f i e idn a s c e n d i nogr d e r .
T h e m a x i m u ml e n g t ho f a H I K E y f i e l d i s 2 g c h a r a c t e r s .
T h e H I K E Y f i e l d sm u s tb e t h e s a m el e n g t ha st h e k e y so n f i l e .
C o n t i n u a t i o on f H I K E Y s u b l i s t m
s u s tb e g i ni n c o l u m n4 o f t h e c o n t i n u a t i o n
record
f o l l o w i n gt h e / / b l a n k .
'

Commentsmust not follow the lastcommaon a FILE statementwhen the lastparameter
i sa n i n c o m p l e t e
HIKEy sublist.

PackedHIKEY: The packedHIKEy parameterhasall the ocL considerations
for
H I K E Y ,i n c l u d i n gt h e f o l l o w i n gr e s t r i c t i o n s :
o T h e f i r s t c h a r a c t e r f o l l o w i n g t hHeI K E y k e y w o r da n d h y p h e n( H l K E y - )
m u s tb e a p
t o i n d i c a t ep a c k e dH l K E y .
A l l c h a r a c t e ri sn t h e p a c k e dH I K E y m u s tb e z o n e dn u m e r i c s( 0 _ 9 ) .
The numberof digitsin eachpackedkey must be the same.
o T h e n u m b e ro f z o n e dn u m e r i cc h a r a c t e rpse r p a c k e dH I K E Y m u s tn o t e x c e e d
1 5 .s i n c e
the maximumpackedkey field lengthis 8.
T h e f o l l o w i n ge x a m p l es h o w sa p a c k e dH I K E y p a r a m e t e rI.n t h e e x a m p l et h e k e y f i e l d
l e n g t ho f M V F I L Ei s 2 . T h e H t K E y sa r eX , 0 8 5 F ,X
, , O } 2 F ,a, n dX , 1 O g F , f oV
r OL1.
voL2, and VoL3, respectively.The first two packedkeysrequireda leadingzeroto
makethe lengthsconsistent.

Spooling Considerations

None

FILE Statement(SingleVolumeTapeFiles)
Function

The FILE statementsuppliesthe systemwith informationabout tapefiles. The svstem
usesthis informationto readrecordsfrom and write recordsto tape.

Placement

You must supplya FILE statementfor eachnew tape file that your programcreatesand
for eachexistingtapefile that your programuses.The maximumnumberof filesallowed
is explainedunderSchedulerWorkArea in Part2 of this manual.

Format

// FILE parameters

Contents

All parameters
are keywordparameters.The parameters
are asfollows (keywordsare in
c a p i t al e t t e r s ) :
N A M E - f i l e n a m(ei n p r o g r a m )
UNIT-code
( name

REEL
] ilsL
( er-e
f i l e n a m e( o n t a p e )
L A B E L _j 'character
string'
(
DATE-date
RETAIN-code
B L K L - b l o c kl e n g t h
RECL-record
length
( F

\v
R E C F M3.B{

lut
\DB

( LEAVE
END.< UNLOAD

( newrruo
200
556
800
1600

DENSTTY.
I
Ascil.{6t

F I L E S t a t e m e n t ( S i n g l eV o l u m e T a p e F i l e s )

1-45

YES

D E F E RJ-

INo

q |I
co N V E R r-J
loN

rnnrusmre
II O
9N
FF
\-

P A R I T Y -E
J VEN
} ODD
l v

seoruuvr-l
1
I bequencenumber
The NAME and UNIT parameters
arealwaysrequired.The othersarerequiredonly under
c e r t a i nc o n d i t i o n s .
NAME: The NAME parameteris alwaysrequired. lt tells
the systemthe namethat your
programusesto referto the file. The NAME parameter
must be placedon the first card
o r l i n e i f t w o o r m o r e c a r d s o r l i n e s a r e u s e d f o r t h e F l L E s t a t e m (eSnet .e
G e n e r aCl o d i n g
Rulesfor ruleson continuation.)
Programs
requiringspecificfilenamesfor tapefiresareasfoilows:
Program

File

Name

TapeSort

Input
Output
Work

INPUT
OUTPUT
WORKl
WORK2
WORK3
W O R K 4( o p t i o n a t )

Copy/Dump

In p u t
Output

COPYIN
COPYO

DiskSort

In p u t
Output

I N P U To r I N P U T I
I N P U T 2t h r o u g ht N P U T S
OUTPUT

Dump/Restore

Input
Output

BACKUP
BACKUP

$ HI S T

Output

$HISTORY

$FCOMP
(tapesupport
only)

Input
Output

BACKUP
BACKUP

Program

File

Name

Spool File Copy

lnput
Output
Input
Input
Output
Output
Output
Output

$ S P O O L( o p t i o n a l )
$ S P O O L( o p t i o n a l )
R E A D E R O T( o p t i o n a l )
R E S T O R E (To p t i o n a l )
D I S P L A Y O t( o p t i o n a l )
P R I N T O 1( o p t i o n a l )
P U N C H O T( o p t i o n a l )
R E A D E R O I( o p t i o n a l )

The keywordNAME must be followed by the filenameusedby the program.The first
characterof the NAME must be alphabetic.The remainingcharacters
may be any combinationof characters
exceptcommas,apostrophes,
or blanks. The numberof characters
mustnot exceed8. The followingexampleshowshow the NAME parameterfor a file
n a m e dF l C A O U T w o u l db e c o d e d :

UNIT: The UNIT parameteris alwaysrequired. lt tells the systemthe tapeunit that
containsor will containthe file. The keywordUNIT must be followedby a codethat
indicatesthe unit. The codesareasfollows:
Code

Meaning

T1

Tapeunit 1

T2

T a p eu n i t 2

T3

Tapeunit 3

T4

Tapeunit 4

The previousexampleshowshow the UNIT parameterwould be codedfor a file that
resides
on tapeunit 2.

lThe

fil" name can be replaced by the name specified on a control statement parameter.
F f L E S t a t e m e n t ( S i n g l eV o l u m e T a p e F i l e s l

1-47

R E E L : T h e R E E L p a r a m e t ei rs r e q u i r e df o r t a p ei n p u t f i r e s
a n d o p t i o n a fro r o u t p u t
f i l e s ' l t i d e n t i f i etsh e t a p et h a t c o n t a i n so r w i l l c o n t a i nt h e f i l e .
T h e s y s t e mu s e st h i s
parameterto ensurethat the correcttape is being
used. (For informationabout how a
tape is initializedand identified.seeTapelnitializationprogram_
$TlNtT in part 4 of
this manual') The keyword REEL must be foilowed by one
of the foilowingcodes:
R E E L ' n n n n n n T h i sf o r m a ti s u s e df o r l a b e l e dt a p ef i l e s . y o u i d e n t i f y
t h e v o r u m eb y
codinga maximumof 6 characters,
excludingcommas,apostrophes,
a n d b r a n k s .N S , N L , a n d B L p h a v es p e c i am
r e a n i n gasn d m a y n o t b e
usedasthe nameof the reel.
REEL.N
L

This codingindicatesa tapefile without a label. The first recordof an
unlabeledtape must not be an go-byterecordwith VoLl asthe first
4 characters.

REEL-NS

This codingindicatesan input tapefile with a non-standard
label. These
labelsdo not adhereto the IBM Tape Labelstandard. The first record
of a nonstandard
labeledtape must not be an g0-byterecordwith
V o L l a st h e f i r s t 4 c h a r a c t e r sR. E E L - N Si s i n v a r i df o r o u t p u tf i r e s .

REEL-BLP

Thiscodingindicatesthat labelprocessing
of standardlabeledinput
tapesshouldbe bypassed.

lf the REEL parameteris not specifiedfor an output file. the system
assumes
that the
o u t p u tt a p ec o n t a i n s t a n d a r dl a b e l s .l f R E E L - N so r R E E L - N Li s u s e d .
the LABEL.
D A T E ,a n d R E T A I N p a r a m e t e rms a y n o t b e e n t e r e d .R E E L - B L pm a y n o t
b es p e c i f i e d
for an output tape.
y'Vofe"Userlabelsarefile labels
that follow standardheaderand trailerlabelconventions
( A N S Io r I B M ) . T h e ya r ea v a r i a t i o no f s t a n d a r d
l a b e l sw i t h a p a r t i a l l yf i x e d f o r m a t .
Theselabelsaresometimesprovidedby other systems.Userlabels
arenot checkedby
Model 15 tapedata management
and may not be written as part of the rabergroup,
The exampleunderNAME showshow the REEL parameterwould be
codedfor a file on
a tape namedTAPE1.
LABEL: The LABEL parametertellsthe systemthe name(label)
of the tapefile as it
e x i s t si n t h e h e a d e lra b e r .
For file creation.the nameyou supplyin the LABEL parameter
is usedin the header
l a b e l . l f y o u o m i t t h e L A B E L p a r a m e t e trh, e n a m ef r o m t h e N A M E p a r a m e t e r
i su s e d
u n l e s sR E E L - N SR
, EEL-NLo
, r R E E L - B L pi s a r s os p e c i f i e d U
. p t o g c h a r a c t e rm
s aybe
s u p p l i e di n t h e L A B E L p a r a m e r e r .
For existingfiles,you must supplythe LABEL parameterif
the namein the tapelabelis
differentfrom the nameyour programusesto referto the file (the NAME parameter).
lf the headerlabelcontainsa namelongerthan 8 characters,
only the first g characters
arerecognized
by the systemfor comparison.
T h e L A B E L p a r a m e t em
r a y n o t b e u s e dw i t h t h e p a r a m e t e rRs E E L - N s ,R E E L - N L ,
or
R E E L - B L P 'T h e L A B E L p a r a m e t ecra nb e c o d e da sf o i l o w s : L A B E L - n a m e .
The nameentry must beginwith an alphabeticcharacterand the remaining
characters
must not be commas,apostrophes,
or blanks.

148

A labelmay alsobe identifiedby specialcharacters.The characterstringmust be
enclosedin apostrophes,
may not containcommas,and may not be longerthan 8 characters;for example,LABEL-'character
string'. lf an apostropheis usedasa character,it
must be codedas 2 apostrophes.
DATE: The DATE parametertellsthe systemthe creationdateof an input file. lt is
usedto ensurethat the properversionof the file is used. The datespecifiedis compared
with the creationdatecontainedin the file label. No comparisonis donewhen DATE is
not specified.
For output files,the partitiondate is alwaysusedasthe creationdate. lf the DATE
parameteris specified for an output file, the systemcomparesthe specifieddatewith the
creationdateof the file alreadyon the tape. lf no file existson the tape,or a file with a
differentlabelexists,or the datesdo not agree,the systemhalts. (Seelnterval Timeror
DATE Statementfor more informationabout the effectof the intervaltimer on date.)
(mmddyy)or
The date may be codedin one of two formats: month-day-year
(ddmmyy). The format must matchthe format of the systemdate
day-month-year
chosenduringsystemgeneration.The date may be codedwith or without punctuation.
arenot allowedas punctuation. Leadingzeros
Blanks,commas,numbers,or apostrophes
in month and day may be omitted if punctuationis used.
r a yn o t b es p e c i f i ew
, E E L ' N L ,o r R E E L - B L P .
T h e D A T E p a r a m e t em
d i t h R E E L - N SR
RETAIN: The RETAIN parameterspecifiesthe numberof daysa file shouldbe retained
beforeit expires.This numbermay be from 0 to 999. After the numberof dayshas
elapsed,
the file expiresand the systemallowsthe file to be written over. lf the RETAIN
parameter-is
omitted.a valueof zerois assumed.A valueof 999 indicatesa non-expiring
permanenttapefile.
lf an attempt is madeto write overan unexpiredfile. the systemhalts,allowingthe
operatorto cancelthe job or continue. A tapecontaininga permanenttapefile must be
reinitializedbeforeit can be usedfor output. The RETAIN parametermay not be used
w i t h R E E L - N SR, E E L - N Lo, r R E E L - B L P .
the numberof bytesin a physical
ELKL: The BLKL (block length)parameterspecifies
block of dataon tape. The minimumsizefixed lengthblock (FB) that can be specified
i s 1 8 . V a r i a b l el e n g t h( V B o r D B ) b l o c k sa r ep a d d e dw i t h h e x 0 0 ( E B C D I Co) r h e x 5 E
( A S C l l ) w h e nn e c e s s a tr oy m e e tt h e 1 8 - b y t em i n i m u mb l o c kl e n g t h .T h e m a x i m u ms i z e
block that can be specified,regardless
of recordformat, is32,767. Whenfixed blocked
( F B )r e c o r d s a ru
l u l t i p l eo f r e c o r dl e n g t h . F o r a
es e d b
, l o c kl e n g t hm u s tb e a n i n t e g r am
l e n g t h( V B ) r e c o r d st ,h e b l o c kl e n g t hm u s t
f i l ec o n t a i n i n g
b l o c k e dE B C D I Cv a r i a b l e
includethe 4-byteblock descriptorand the 4-byterecorddescriptor(s).For blocked
ASCII variablelength(DB) records,the buffer offset lengthand the 4-byterecorddescriptor(s)must be includedin the block length.
the numberof bytesin a logical
RECL: The RECL (recordlength)parameterspecifies
t a p er e c o r d .T h e m i n i m u mr e c o r dl e n g t hf o r f i x e d ( F l o r f i x e d b l o c k( F B ) r e c o r d si s 1 8
bytes. Unblockedvariablelength(V or Dl recordsare paddedwith hex 00 (EBCDIC)or
h e x 5 E ( A S C l l ) ,w h e nn e c e s s a rtyo, m e e t t h e 1 8 - b y t em i n i m u mb l o c kl e n g t hr e q u i r e m e n t .
For filescontainingvariablelength(V or D) records.the recordlengthmust includethe
4-byterecorddescriptor.

F I L E S t a t e m e n t ( S i n g l eV o l u m e T a p e F i l e s l

1-49

RECFM: The RECFM(recordformat) parameteridentif
iesthe format of the input or
output file records.The parameterentriesare:
Fixed length.unblockedrecords. Logicarand physicarrecordsare
the
samesize.

V

Variablelength,unblockedrecords.Eachphysicarrecordcontainsone
logicalrecord;the logicalrecordcan vary in lengtn.

D

Variablelength,unblockedrecordsin the D-typeASCII format.

FB

Fixed length,blockedrecords.All recordsareof equallength
and all
blocksareof equallength. Eachphysicarrecordcontainsmore
than one
logicalrecord.

VB

Variablelength,blockedrecords.Eachphysicalrecordcontainslogical
recordsof variouslengths.

DB

Variablerength,brockedrecordsin the D-typeASCil format.

END: The END parameterspecifies
the positionof the tapeafter the file hasbeenorocessed.The optionsareasfollows:
LEAVE

The tape remainsin the positionit was in after the lastrecordwasread
or written.

REWIND

T h e t a p ei s r e w o u n dt o t h e l o a dp o i n t .

UNLOAD

The tape is rewoundand unroadedfor removarfrom the tapedrive.

l f t h e E N D p a r a m e t ei rs o m i t t e d ,R E W I N Di s a s s u m e d .
DENSITY: The DENSlry parameteris usedto specifythe number
of bpi (bits per inch)
at which filesareto be written or read.
The parametermust specifythe densityat which the tapewas initiarized.
see$TrNrr
( t a p ei n i t i a l i z a t i opnr o g r a md) e s c r i p t i o inn P a r t4
o f t h i s m a n u a l .F o r g - t r a c kt a p e st,h i s
parameteraffectsonly the densityof nonlabeledoutput
files. when standardlabeledor
nonstandard
labeledtapesare used,the 9-tracktape hardwareautomaticallydetermines
t h e d e n s i t ya t w h i c ht h e t a p ew a si n i t i a l i z e d W
. h e na t a p ei s i n i t i a l i z e d
t o 1 6 0 0b p i w i t h
standardlables,any file that is written on that tapeis in 1600 bpi, regardress
of the
parameterspecifiedfor DENSITY. No error halts
occur if the wrong9-trackdensityis
specified.The parameterentriesare:

1-50

1600

The file is to be written at 1600 bpi (varidfor ail 9-tracktapeunits).

800

The file is to be written (7- or 9-tracktape units)or read(7_tracktape
units)at 800 bpi (validfor 9-trackdual densitytapeunitsor for all 7-track
t a p eu n i t s ) .

556

The file is to be written or readat b56 bpi (varidfor ail 7-tracktape units).

200

The file is to be written or readat 200 bpi (varidfor ail 7-tracktapeunitsl.

lf the DENSITY parameteris omitted, 1600 bpi is assumed
on 9-tracktapeunits,and 800
bpi is assumed
on 7-tracktapeunits.
, A S C I l : T h e A S C I I p a r a m e t ei rs u s e dt o i n d i c a t et o t h e s y s t e mw h e na n A S C | l f i l e i s
b e i n gu s e d . l f A S C I If i l e sa r eb e i n gu s e d A
, S C I I - Y E Sm u s tb e c o d e d . A S C I I - Y E Si s
i n v a l i df o r f i l e so n 7 - t r a c kt a p eu n i t s . l f t h i s p a r a m e t ei rs o m i t t e do r c o d e dA S C I I - N O ,
a n E B C D I Cf i l e i s a s s u m e d .
D E F E R : T h e D E F E Rp a r a m e t et re l l st h e s y s t e mw h e t h e rt h e f i l e w i l l b e m o u n t e do n a
t a p ed r i v ew h e nt h e f i l e i s a l l o c a t e a
d n d o p e n e d .l f t h e t a p ev o l u m ei s n o t o n l i n e ,
D E F E R - Y E Sm u s tb e c o d e d . l f t h e p a r a m e t eirs o m i t t e d ,D E F E R - N Oi s a s s u m e d .
Note: For RPG ll objectprograms.
this option shouldbe usedonly for filesthat usethe
s a m ed r i v ea sa t a b l ef i l e . A l l o t h e rf i l e sa r ea l l o c a t e d
a n do p e n e da t t h e b e g i n n i nogf t h e
program.
Other programs(suchas COBOLobjectprograms),which do notallocateand openall
f i l e sa t t h e s a m et i m e o r d o i t c o n d i t i o n a l l yb y p r o g r a ml o g i c ,s h o u l dn o t u s et h e
D E F E R - Y Eo
Sp t i o n .
CONVERT: The CONVERTparametertellsthe systemwhetherthe dataconverterwill
b e t u r n e do n o r o f f . T h i sp a r a m e t ei rs v a l i do n l y f o r 7 - t r a c kt a p ef i l e s . C O N V E R T - O N
causes
7-trackdatato be processed
in 8-bit binarvform. The converterwritesthree main
storagecharacters
as4 tapecharacters
and convertsthe oppositeway when reading.
CONVERT-ONmust be specifiedwhen variablelengthrecordsare processed
on 7-track
t a p ef i l e s . S p e c i f y i n b
a n d T R A N S L A T E - O Ni s i n v a l i d .l f t h i s
go t h C O N V E R T - O N
p a r a m e t ei rs o m i t t e d ,C O N V E R T - O F F
isassumed.
TRANSLATE: The TRANSLATE parametertellsthe systemwhetherthe datatranslator
will be turnedon or off. This parameteris validonly for 7-tracktapefiles.
TRANSLATE-ONcauses7-trackdatato be processed
in 6-bit BCD form. The translator
writes8-bit EBCDICmain storagecharacters
and translates
as6-bit BCDtapecharacters
t h e o p p o s i t ew a y w h e nr e a d i n g .S p e c i f y i n b
g o t h T R A N S L A T E - O Na n d C O N V E R T - O N
i s i n v a l i d . l f t h i s p a r a m e t ei rs o m i t t e d ,T R A N S L A T E - O F F
isassumed.
Note: lf CONVERT-OFF
a n dT R A N S L A T E - O F Fa r es p e c i f i e do,n l y t h e 6 l o w - o r d e rb i t s
of the main storagecharacterare written on the tape. Whenthe systemis readingwith
CONVERT-OFF
a n d T R A N S L A T E - O F Ft .h e 2 h i g h - o r d ebri t so f t h e m a i ns t o r a g e
characters
aresetto zeros.
PARITY: The PARITY parameteris usedto specifythe parity at which tapecharacters
will be processed.This parameteris valid only on 7-tracktapefiles. Dataconversion
( C O N V E R T - O Ni s) i n v a l i dw i t h e v e np a r i t y ( P A R I T Y - E V E N ) l.f t h i s p a r a m e t ei rs
o m i t t e d ,P A R I T Y - O D Di s a s s u m e d .

F I L E S t a t e m e n t ( S i n g l eV o l u m e T a p e F i l e s )

1-51

N o t e : T h ef o l l o w i n ga r et h e v a l i dc o m b i n a t i o nfso r T R A N S L A T E ,c o N V E R T , a n d
PARlTy parameters:
P A RI T Y - O D D ,T R A N S L A T E - O F FC. O N V ER T . O F F
P A RI T Y . O D D ,T R A N S L A T E . O N
P A RI T Y - O D D ,C O N V ER T - O N
P A RI T Y - E V E NT, R A N S L A T E . O F F
C,O N V ER T . O FF
P A RI T Y . E V E N ,T R A N S L A T E . O N
SEQNUM: The SEONUMparameteris usedto specifythe numberof the file when the
r e e lc o n t a i n sm o r et h a no n e f i l e ( m u l t i f i l ev o l u m e ) .T h e n u m b e rt o u s ei s t h e n u m b e r
t h a t w a sa s s i g n ewdh e nt h e f i l e w a sw r i t t e n . T h e d e f a u l tv a r u ei s 1 .
lf SEONUM-numbe
i sru s e dw i t h R E E L - B L Pt,h e s y s t e mw i l l s e a r c ht h e t a p ef o r a
standardlabelHDRl recordthat containsthe samefile number. Whenthe recordis
found, further processing
of the labelgroupis terminated.The systemthen positions
the tapeto the file data.
SEONUM-Xon the FILE statementindicatesthat the tapehasbeenpreviouslypositioned
to the desiredfile, and no positioningis done beforeprocessing.See FILE Statement
(Multifile Tape Volumes)for more information on the usesof this keyword.

7-TrackConsiderations
CONVERTT
, R A N S L A T E ,P A R I T Y a n d l o rD E N S I T Ym u s tb e s p e c i f i e fdo r a n i n p u t
file if other than the defaultparameters
werespecifiedfor output when the file wasbuilt;
otherwise,tape runawayor datacheckoccurs.
l f a n o u t p u tf i l e h a sR E E L - N Lo n t h e F I L E s t a t e m e n t .h e r e e lm u s th a v eb e e ni n i t i a l i z e d
w i t h R E E L ' N Lb y t h e $ T l N l T ( t a p ei n i t i a l i z a t i o np)r o g r a mo; t h e r w i s et .a p er u n a w a yo r
datacheckoccurs.
l f a n o u t p u t f i l e h a sR E E L - N Lo n t h e F I L E s t a t e m e nat n dt h e r ei s a f i l e e x i s t i n go n t h e
t a p e ,t a p er u n a w a yo r d a t ac h e c kw i l l o c c u ri f T R A N S L A T E ,C O N V E R T ,p A R l T y ,
and/or DENSITYparameters
for the new file do not matchthe characteristics
of the old
f i l e . R e i n i t i a l i zteh e t a p eu s i n g$ T l N l T w i t h R E E L - N Li f t h i s o c c u r s .
SpoolingConsiderations

1-52

None

T A P E F I L E S T A T E M E N TS U M M A R Y
Req = Reguired
opt = optional
(Referto the discussion
of a particularparameterto determinewhetherit is requiredfor your program.)
N/A = Not Applicable
Defaultsareunderlined
Applicability
Parameters

9Track

7-Track

Remarks

N A M E - f i l e n a m(ei n p r o g r a m )

Req

Req

1-8 characters

Req

Req

REEL-name
NL
NS
BLP

Req*

Req

L A B E L - f i l e n a m(eo n t a p e )
'character
string'

opt

opt

DATE-mmddyy
ddmmyy

opt

opt

N o t u s e dw i t h R E E L - N S-,N L , o r - B L p .

RETAIN-nnn

opt

opt

Code= 0.999;default= 0; not usedwith
R E E L - N S- ,N L , o r - B L P .

B L K L - b l o c kl e n g t h

opt

opt

Bfock fength 18-32767

RECL-recordlength

opt

opt

Recordlength1&32767

R E C F M - FF B
V VB
D DB

opt

opt

END-LEAVE
REWIND
UNLOAD

opt

opt

D C f A U IiIS R E W I N D

DENSITY-1600
800
556
200

opt
1600

opt
800

Defaultis underlined

UNIT. T1
T2
T3
T4

ToO

*

N L , N S ,a n d B L P a r en o t u s e dw i t h L A B E L ,D A T E ,
R E T A I N ;N S a n d B L p a r ei n v a l i df o r o u t p u i . l f R E E L
is not specifiedfor output f iles.standardiabelsare
a s s u m e d*. R E E L o p t i o n a lf o r o u t o u t .
1-8 characters
N o t u s e dw i t h R E E L - N S-,N L , o r - B L p .

EE;T'
200

ASCII.YES
NO

opt

N/A

D e f a u l ti s N O ; E B C D T C
a s s u m e idf A S C I I - N O

DEFER.YES
NO

opt

opt

D e f a u l ti s N O .

CONVERT-OFF

N/A

opt

CONVERT-ONis requiredif processing
V, Vil
D e f a u l ti s O F F .

TRANSLATE.OFF

N/A

opt

D e f a u l ti s O F F .

N/A

opt

D e f a u l ti s O D D .

opt

opt

D e f a u l ti s 1

0-r

OT
PARITY-ODD

EVEN
SEONUM-X
nnnn

F I L E S t a t e m e n t ( S i n g l eV o l u m e T a p e F i l e s )

1-53

Combinationsof 7-TrackSpecifications
Convert

Translate

Parity

OFF

OFF

ODD

valid

OFF

OFF

EVEN

valid

OFF

ON

ODD

valid

OFF

ON

EVEN

valid

ON

OFF

ODD

valid

ON

OFF

EVEN

invalid

ON

ON

ODD

invalid

ON

ON

EVEN

invalid

(Multivolume
FILE Statement
TapeFiles)
Function

T h e F I L E s t a t e m e nst u p p l i etsh e s y s t e mw i t h i n f o r m a t i o na b o u tf i l e s . T h e s y s t e mu s e s
this informationto readrecordsfrom and write recordsto tape.

Placement

Y o u m u s ts u p p l ya F I L E s t a t e m e nfto r e a c hn e w t a p ef i l e t h a t y o u r p r o g r a mc r e a t e as n d
t u s tf o l l o w t h e
f o r e a c he x i s t i n gt a p ef i l e t h a t y o u r p r o g r a mu s e s .T h e F I L E s t a t e m e nm
L O A D o r C A L L s t a t e m e nat n d p r e c e d teh e R U N s t a t e m e n t .

Format

l/ FILE parameters

Contents

T h e F I L E s t a t e m e nfto r p r o c e s s i nmgu l t i v o l u m et a p ef i l e sr e q u i r e tsh a t y o u d e f i n ea n d
c o d et h e U N I T a n d R E E L p a r a m e t e rdsi f f e r e n t l yt h a ny o u w o u l df o r s i n g l ev o l u m ef i l e s .
for this:
Therearetwo reasons
W h e n p r o c e s s i n gt a p e f i l e s c o n t a i n e do n m o r e t h a n a s i n g l ev o l u m e , t h e s y s t e mr e q u i r e s
i n f o r m a t i o n a b o u t e a c h v o l u m e i n o r d e r t o p e r f o r m a l l t h e n e c e s s a r yc h e c k i n ga n d p r o tection functions.
A d d i t i o n a l i n f o r m a t i o n i s n e e d e dt o d e t e r m i n ea n d c h e c k t h e s e q u e n c ei n w h i c h t h e
volumes are processedand when thev are to be mounted on the tape drives.
F o r m u l t i v o l u m e t a p e f i l e s , t h e U N I T a n d R E E L p a r a m e t e r so f t h e F I L E s t a t e m e n tm a y
r e q u i r ea l i s t o f c o d e s . W h e n y o u c o d e a l i s t o f c o d e s .t h e f o l l o w i n g r u l e sa p p l y :
o The list must be enclosed by apostrophes.
o The items in the list must be separatedby commas.
o

I n t e r m i x i n g7 - a n d 9 - t r a c ku n i t s i s n o t a l l o w e d .

T h e c o n s i d e r a t i o n sf o r c o d i n g m u l t i v o l u m e p a r a m e t e r sa r e i n c l u d e d i n t h e f o l l o w i n g
parameter discussions. The functions of the parametersaie explained under FtLE Statement (single Volume Tape Files). Parametersnot mentioned here are used as explained
under FILE Statement (Single Volume Tape Files).
The maximum number of multivolume files allowed is explained under Scheduler Work
Area in Part2 of this manual.
R E E L : T h e n a m e so f t h e t a p e st h a t c o n t a i n o r w i l l c o n t a i n t h e m u l t i v o l u m e f i l e m u s t
f o l l o w t h e k e y w o r d R E E L . l f t h e i n p u t t a p e sa r e n o t l a b e l e do r c o n t a i n n o n s t a n d a r d
l a b e l s ,o r i f l a b e l p r o c e s s i n gi s t o b e b y p a s s e d t, h e R E E L p a r a m e t e rm u s t b e c o d e d
, h e r e n i s t h e n u m b e ro f v o l u m e si n t h e
R E E L - ' N L , n ' ,R E E L - ' N S , n ' o, r R E E L - ' B L P , n ' w
f i l e ( 9 9 v o l u m e sm a x i m u m ) . F o r o u t p u t f i l e s ,t h e n i n R E E L - ' N L , n ' i s i g n o r e d .
UNIT: The kevword UN lT must be followed by a code or codes indicating the location
o f t h e t a p e u n i t t h a t c o n t a i n so r w i l l c o n t a i n t h e f i l e . N o U N I T p a r a m e t e rm a y b e
repeated. The order of codes in the UNIT parameter must correspond to the order of
n a m e si n t h e R E E L p a r a m e t e r . W h e n t h e n u m b e r o f c o d e si n t h e U N I T p a r a m e t e ri s l e s s
t h a n t h e n u m b e r o f c o d e s i n t h e R E E L p a r a m e t e r ,t h e u n i t s a r e u s e da l t e r n a t e l y .

F I L E S t a t e m e n t( M u l t i v o l u m eT a p e F i l e s )

1-55

Pageof GC21-5162-1
lssued28 September1979
ByTNL: GN21-5674
Examples

l n t h e f o l l o w i n ge x a m p l e s , s n o * s a t a p em u l t i v o l u m ef i l e c o n s i s t i nogf
t h r e er e e l s .
@
The volumesmust be mountedasfollows:
I N V R L l o n t a p eu n i t T 1
I N V R L 2o n t a p eu n i t T 2
I N V R L 3 o n t a p eu n i t T 3
file with nonstandard
@shows a three-volume
tapelabel. The volumesmust be mounted
as follows:
F i r s tv o l u m eo n t a p eu n i t T 1
Secondvolumeon tapeunit T2
Third volumeon tape unit Tl
file with unlabeledreels. The volumesmust be mountedin
@snows a three-volume
s e q u e n coen t a p eu n i t T 1 .
standardlabeledfile usedin line
@shows the three-volume
@,
cessingbypassed.

@
@

o

@
SpoolingConsiderations

1-56

None

but with labelpro.

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued 28 September 1979
By TNL: GN21-5674

FILE Statement(MultifileTapeVolumes)
Function

The FILE statementsuppliesthe systemwith informationabouttapefiles. The system
usesthis informationto readrecordsfrom and write recordsto tape.

Placement

You must supplya FILE statementfor eachnewtape file that your programcreatesand
f o r e a c h e x i s t i n g t a p e f i l e t h a t y o u r p r o g r a m uTsheesF. l L E s t a t e m e n t m u s t f o l l o w t h e
LOAD or CALL statementand precedethe RUN statement.

Format

ll FILE parameters

Contents

Morethan one file canexist on a reelof tape. lf this is the case,eachfile hasan associated
dn
f i l e n u m b e r .T h e S E O N U Mp a r a m e t ei rn d i c a t etsh e f i l e n u m b e ra n d m u s tb e s p e c i f i e o
this
desired
file
using
positions
to
the
tape
the
the tape FILE statement.The system
All
parameter.Only the parameters
that pertainto multifile tapevolumesarediscussed.
(single
Files).
Volume
Tape
parameters
FtLE
described
in
Statement
FILE
are
other tape
T h e S E O N U Mk e y w o r df o r m u l t i f i l ev o l u m et a p ef i l e sh a st h e f o l l o w i n gp a r a m e t e r s :
SEONUM-nnnn
.X
, s s i g n ewdh e nt h e f i l e w a sw r i t t e n . D e f a u l tv a l u e
w h e r en n n n = f i l e s e q u e n cneu m b e r a
i s 1 . T h e n u m b e ri n d i c a t etsh e r e l a t i v ep o s i t i o no f t h e f i l e i n a v o l u m e
of filesand is incrementedby one from one file to the next'
i l e . A u s e rr o u t i n eo r E N D - L E A V Eh a sp r e p o s i t i o n e d
X = p r e p o s i t i o n ef d
the tapeto the desiredplacefor input or output.
tapeto be left (not rewound)
END-LEAVE,when codedon the FILE statement,causes
wascompleted.
at the placewhereprocessing
file allocafrom a singlevolume,the usercan decrease
lf several
files areto be processed
t i o n t i m e b y ( 1 ) c o d i n gE N D - L E A V Eo n t h e F I L E s t a t e m e nf to r e a c ho f t h e f i l e st h a t a r e
the files in the order in which they resideon tape.
to be accessed,
and (2) processing

Ff LE Statement (Multifile Tape Votumesl

1-57

Prepositioned
Tapes(SEONUM-Xon the FILE Statement)
The usercan prepositiona file for input or output and, in a subsequent
job or job step,
beginfile processing
at the prepositioned
point. The prepositioning
can be accomplished
severalways. For examole:
.

An RPG ll programcan processan input tapeand, at somepoint. seton the LR indicatorto forceend of job.

o The sametechniquecan be usedby objectprogramsproduced
by other compilers
(or the assembler).
that is,force (or call) end of job beforethe input file hasbeen
processed
to end of file.
END-LEAVEwould haveto be codedon the tape FILE statement.or elsethe tape
would
be rewoundat end of job.
when tapehasbeenprepositioned,
for input or output, sEoNUM-x must be codedon
t h e t a p eF I L E s t a t e m e n t .
lf a standardlabeledtapehasbeenprepositioned.
labelverificationwill not be performed
b y t h e s y s t e m .T h a t i s ,t h e f i l e l a b e l d
, a t e ,a n d v o l u m es e q u e n cien f o r m a t i o ni n t h e H D R l
labelwill not be checkednor will the recordformat, block length,recordlength,and
recordingtechnique(translate,
convert,parity) informationin the HDR2 labelbe checked.
T h e s ef i e l d sa r en o r m a l l yc o m p a r e dt o t h e F l L E . s t a t e m e natn d / o rp r o g r a mD T F . L a b e l
verificationwill be performed,however,if the tapewasprepositioned
to the start-of-a-file
(beforethe HDRl ) record.

Restrictionson the Useof Multifile Tapes
The followingrestrictionsmust be adheredto when multifiletapevolumesareused:
o A l l f i l e si n t h e v o l u m em u s tb e l a b e l e di n t h e s a m em a n n e rt,h a t i s .
allstandard
labeled
f i l e so r a l l u n l a b e l e fdi l e s .
o A l l f i l e si n t h e v o l u m em u s tb e r e c o r d e di n t h e s a m ed e n s i t y .
o All files must be recordedin the samemode (translate,convert,
and parity).
o l f t h e l a s tf i l e o n a m u l t i f i l er e e li s c o n t i n u e do n a s u b s e q u e nr et e l ,t h e
t w o r e e l sc o n stitutean aggregate.
The precedingthreerestrictionsapply to all volumesof the
aggregate.In addition,all volumesof the aggregate
must be either7- or 9-track.
o Standardlabeled7-tracktapes.if prepositioned.
shouldbe prepositioned
to a point
just beforea HDRI record. otherwisetapedatachecks
or runawaymay occur.
Note: ll standardlabeledtapes(7-track,primarily)havebeenprepositioned
to any point
other than the label,you can access
the data,without the aboveerrors,by coding
S E o N U M - x ,R E E L - N Lo n t h e F I L E s t a t e m e n t y. o u s h o u l d n o f ,h o w e v e ro, u t p u ta f i l e
on a standardlabeledtapein this mannerbecause
the file would not be accessible
by the
s y s t e m( t h e r ec a n n o tb e a m i x t u r eo f l a b e l e da n d u n l a b e l e fdi l e so n t h e v o l u m e ) .
The followingsectionsdescribethe useof standardlabeled,nonnstandard
labeled,and
u n l a b e l em
d u l t i f i l et a p ev o l u m e s .

1-58

StandardLabeledFiles
Standardlabeledmultifiletapevolumeshavethe followingformat:
VLG HLG TM DATA TM TLG TM
HLG TM DATA TM TLG TM TM
where
VLG

= volumelabelgroupVOLl labelis processed;
others,if present,are ignored.

HLG

= h e a d e lra b e lg r o u pH D R 1 . H D R 2 r e c o r d sa r ep r o c e s s e od t; h e rh e a d e r e c o r d s .
if present,are ignored.

TM

= a singletape mark

D A T A = t h e d a t af i l e
TLG

= trailerlabelgroup EOFl, EOF2 records.when processed,
indicatethe end
o f a f i l e . E O V l , E O V 2r e c o r d si n d i c a t et h e e n d o f v o l u m eo f a m u l t i '
v o l u m ef i l e . T h e f i n a lv o l u m eo f t h e f i l e w i l l h a v eE O F 1 ,E O F 2t r a i l e r
records;other trailerlabels,if present,are ignored'

Two tape marksindicatethe end of volumeif the precedingTLG consistedof EOFl,
EOF2 records.
O n et a p em a r ki n d i c a t e s e nodf v o l u m ei f t h e p r e c e d i nTg L G c o n s i s t eodf E O V 1 .
EOV2 records.
Eachfile is precededby a headerlabelgroupand a tapemark,and is followedby a
t r a i l e rl a b e lg r o u pa n d a t a p em a r k .
numberis recordedwhen the
The HDRl recordcontainsa field in which the file sequence
file is written. The numberindicatesthe relativepositionof the file in the volume,and it
incrementsby one from one file to the next.
The userselectsthe desiredinput file by specifyingon the FILE statement:
SEONUM-number
w h e r en u m b e r= t h e f i l e s e q u e n cneu m b e ri n t h e H D R l r e c o r do f t h e d e s i r e df i l e . D e f a u l t
v a l u ei s 1 .
wherethe file is to be written on the volume.
specifies
For output files,SEONUM-number
The numberspecifiedshouldbe one greaterthan the lastfile on the volume,unlessyou
occursif the SEONUMvalueis two or more
want to overlaya file. A systemmessage
greaterthan the valuein the HDRl recordof the lastfile on the volume. Oncea file has
beenwritten, any filesthat existedon the volumebeyondthe new output file areno
for input. Two tape marksarewritten after the new file, indicatingthe
longeraccessible
e n do f v o l u m e .

FILE Statement (Multifile Tape Volumes)

1-59

For output files,the tape is positionedper the SEoNUM parameter,
then the trailerlabel
o f t h e p r e c e d i nfgi l e i s r e a d . l f t h e l a b e rg r o u pi s E o V ( e n d
o f v o r u m e i)n s t e a do f E o F
(endof file), a diagnostichalt message
is issued;a file cannotbe written after a multiv o l u m ef i l e .
l f a f i l e e x i s t sw h e r et h e n e w o u t p u tf i l e i s t o b e w r i t t e n ,
t h e H D R l l a b e lo f t h e f i l e i s
r e a d ' T h e e x p i r a t i o nd a t ai s c h e c k e di;f t h e f i l e h a sn o t e x p i r e d ,
a d i a g n o s t ihca l t i s i s s u e d .
l f a s e r i eo
s f f i l e si s b e i n gb u i l t o n o n e o u t p u tt a p ei n o n ej o b s t r e a my, o u
c a nc o d e
S E O N U M - 1E, N D - L E A V Eo n t h e F I L E s t a t e m e nfto r t h e f i r s t
f i r e . c o d es E o N U M - X
a n d E N D - L E A V Eo n t h e F I L E s t a t e m e nfto r t h e s e c o n da n d
subsequen
f itl e s . W h e nt h e
j o b s t r e a mi s r u n ,t h e s y s t e ma s s i g ntsh e
s E o N U M v a l u ef o r f i l e sb u i l t a f t e rt h e f i r s t f i l e .
The valueassigned
will be one greaterthan that usedfor the previousfile.
Notes:
1. lf filesexist on the tapebeyondthe one beingwritten, they
cannot be accessedafter
t h e f i l e i sw r i t t e n .
2 . l f u n e x p i r e d( o r p e r m a n e n tf)i l e se x i s tb e y o n dt h e file being
written, they are not
detectedand are lost.
3' For input files,a systemmessage
occursif a file havingthe specifiedSEONUMvalue
cannotbe found.
4' For output files.if the tapehasbeenpositionedwithin the
boundaries
of an existing
file, a diagnosticmessage
occurs.
l f t h e t a p eh a sb e e np r e p o s i t i o n ef d
o r i n p u t ,s E o N u M - x s h o u l db e c o d e do n t h e F I L E
statement.The systemthen determines
wherethe tape is positionedas foilows:
1'

l f a t l o a dp o i n t ,t h e v o l u m ea n d f i l e h e a d e lra b e l sa r er e a da n dv e r i f i e d .
T h et a o e
then is positionedto the startof the data.

2'

lf at the startof a file. the file headerlabelsare readand verified. The
tapeis
positionedto the startof the data. The vorumeraberis
not read.

3'

lf the tapewasprepositioned
to any other point. the volumeor file headerlabels
are not checked.The tape is not positionedto any other point; it is
assumed
that
the dataareastartswherethe tape is currentlypositioned.

Note: File allocationtime can be decreased
when severalfileson one volumeareto be
p r o c e s s ebdy a j o b b y ( 1 ) c o d i n gE N D - L E A V Eo n t h e F I L E
s t a t e m e nf to r e a c hf i l e r e f e r e n c e do n t h e v o l u m ea n d ( 2 ) b y p r o c e s s i nt h
g e f i l e si n t h e o r d e ri n w h i c ht h e y r e s i d eo n
tape.

1-60

NonstandardLabeledFiles
T h e R E E L p a r a m e t e r o tnh e t a p eF I L E s t a t e m e nitn d i c a t eas n o n s t a n d a rlda b e l e df i l e
labelgroupscannotbe written but areacceptedin
when REEL-NSis used. Nonstandard
input files. A nonstandard
labelgroup is one in which the first recordis not an 80-byte
r e c o r db e g i n n i n w
g i t h V O L 1 . T h e l a b e lg r o u pi s f o l l o w e db y a t a p em a r k .
For single-file
volumes.the systempositionsthe tape pastthe tape mark that followsthe
labelgroup. This is done after the first recordon the reelhasbeenverifiedasnot being
an 8O-byteVOLI record. The labelgroup is not reador processed.Trailerlabels,if
present,arenot reador checkedwhen the file is closed.
beforethe job is run if the
Multifile nonstandard
labeledvolumesmust be prepositioned
file to be processed
is not the first file on the volume. lf the tapefile hasbeenprep o s i t i o n e di t, i s i n d i c a t e db y c o d i n gS E O N U M - Xo n t h e t a p eF I L E s t a t e m e n tT
. he
to
systemdoesnot checkthe tape;the file is allocated.lt is the user'sresponsibility
positionthe tapeproperly.

UnlabeledVolumes
U n l a b e l em
d u l t i f i l et a p ev o l u m e sh a v et h e f o l l o w i n gf o r m a t :
DATA TM DATA TM DATA TM TM
w h e r eT M = a s i n g l et a p em a r kd e n o t i n gt h e e n d o f a f i l e .
Two tape marksdenotethe end of a volumeunlessthe lastfile is a multivolumefile, in
which casethereis only one tape mark.
A s i n g l et a p em a r k m a y p r e c e d teh e f i r s t f i l e o f a n i n p u tv o l u m e .T h e f i r s t f i l e o n a n
o u t p u tv o l u m ed o e sn o t h a v ea l e a d i n gt a p em a r k .
The tapecan be positionedto any file on the reel,for inputor output, by useof
. h e n u m b e ri n d i c a t e s t h ree l a t i v ep o s i SEONUM-numbo
en
r t h e t a p eF I L E s t a t e m e n t T
t i o n o f t h e f i l e o n t h e t a p e . l f S E O N U M - Xi s u s e df o r a n o u t p u t f i l e ,t h e s y s t e me n s u r e s
to
that the tapeis positionedat the startof a file beforewriting. (Thetapeis backspaced
. ) h e nS E O N U M - Xi s u s e df o r a n u n l a b e l e idn p u tf i l e ,
t h e s t a r to f t h e f i l e i f n e c e s s a r yW
the systemdoesnot movethe tapebeforeit is read.
F o r o u t p u t f i l e st h e S E O N U Mv a l u es h o u l db e o n eg r e a t etrh a nt h e n u m b e ro f f i l e so n
t h e r e e l ,u n l e s sy o u w i s ht o o v e r l a ya f i l e .
For input or output files.specifyinga SEONUMvaluetwo or more greaterthan the numto be issuedif the lastfile on the
ber of fileson the reelwill causeeither (1) a message
f i l e o r ( 2 ) u n p r e d i c t a b lree s u l t si f t h e l a s tf i l e o n t h e t a p ei s a
t a p ei s n o t a m u l t i v o l u m e
multivolume
file.

F I L E S t a t e m e n t( M u l t i f i l e T a p e V o l u m e s ) 1 - 6 1

Allocationtime can be reducedwhen severalfileson a reelare
to be accessed
duringa job
by (1) processing
the files in the order in which they resideon the tapeand (2) coding
E N D - L E A V E o n t h e F l L E s t a t e m e n t f o r e a c hTf hi l ee n. t h e t a p e i s n o t r e w o u n d f o r e a c h
allocation.However,if sEoNUM-x is codedon one FILE
statementand a subsequent
F I L E s t a t e m e nht a sS E O N U M - n u m b e
r d e df o r t h e s a m et a p ev o l u m e t. h e v o l u m ei s
co
rewoundby the systembeforebeingpositionedto the desired
file.
y'vote.'Standardlabeledtapescan
inadvertentlybe destroyedwhen sEoNUM-X and
R E E L - N La r eu s e df o r a n o u t p u t f i l e . l f t h e t a p ei s n o t a t l o a dp o i n t ,a c h e c kf o r a
standardlabeledtape is not performed.

REEL Parametelon FILE Statement
The REEL parameter,
for standardlabeledtapes,is the nameof the volumecontaining
thefile.
REEL-name
l f a m u l t i f i l em u l t i v o l u m e
a g g r e g a ti se u s e d ,R E E L - n a m ies t h e n a m eo f t h e f i r s t v o l u m e
of the aggregate,
regardless
of which volumeactuallycontainsthe file, when a singlevolumef ile is accessed.
The parameters
usedfor multivolumefilesare:
R EE L - ' n a m le, n a m e 2 , n a m e x ,
wherenamel is the nameof the first volumeof the aggregate
(asdescribedabove),
a n d n a m e 2a n d n a m e xa r et h e v o l u m en a m e so f t h e a d d i t i o n avl o l u m e sc o n t a i n i n g
thef ile.
The namesto usein this casearethe actualvolumenamesof eachvorume.
Spooling Considerations

1-62

None

FILE Statement(DeviceIndependentFiles)
Function

T h e d e v i c ei n d e p e n d e nFtI L E s t a t e m e nat l l o w sy o u t o a s s i g nl / O d e v i c eus s e db y a
p r o g r a m .T h i ss t a t e m e nst u p p l i etsh e s y s t e mw i t h i n f o r m a t i o na b o u t l / O d e v i c e us s e di n
the program.This informationis usedto readrecordsfrom and/orwrite recordsto the
l / O d e v i c e us s e d .

Placement

Y o u m u s ts u p p l ya d e v i c ei n d e p e n d e nFtI L E s t a t e m e nf to r e a c hd e v i c ei n d e p e n d e nf itl e
t u s tf o l l o w t h e L O A D
u s e di n y o u r p r o g r a m .T h e d e v i c ei n d e p e n d e nFtI L E s t a t e m e nm
the RUNstatement'
o r C A L L s t a t e m e nat n d p r e c e d e

Format

ll FILE parameters
N o t e : l f d e v i c ei n d e p e n d e n tf i l e s a r e u s i n gc i i s ko r t a p e u n i t s f o r i n p u t o r o u t p u t , t h e n
t h e d i s k o r t a D e F I L E s t a t e m e n tf o r m a t m u s t b e u s e d .

Contents

All parametersare keyword parameters. The parametersare as follows (keywords are in
c a p i t a ll e t t e r s ) :
N A M E - fi l e n a m e( i n p r o g r a m )
Unit-code
PR I NT-code
R E C L - r e c o r dl e n q t h
T h e N A M E a n d U N I T p a r a m e t e r sa r e a l w a y s r e q u i r e do n t h e d e v i c ei n d e p e n d e n tF I L E
s t a t e m e n t . T h i s F I L E s t a t e m e n tf o r m a t i s u s e dw h e n d e v i c ei n d e p e n d e n tf i l e s a r e b e i n g
r e a df r o m o r w r i t t e n t o u n i t r e c o r dd e v i c e s .
P r o g r a m sr e q u i r i n gs p e c i fi c f i l e n a m e sf o r d e v i c ei n d e p e n d e n tf i l e sa r e :
Program

File

Name

D i s kS o r t

InPut

INPUTor INPUT1
I N P U T 2t h r o u g hI N P U T S

Copy/Dump

InPut
Output

COPYIN
COPYO
COPYP

S y s t e mH i s t o r y
Area Display

Output

$HISTORY

SpoolFile
Copy

Input
Input
Output
Output
Output
Output

R E A D E R O T ( o p t i o n a)l
B E S T O R E T ' 2( o p t i o n a l )
DISPLAYOI (optional)
P R I N T O I ( o p t i o n a l)
P U N C H O T( o p t i o n a l )
READEROT(optional)

^Thefile
on a controlstatementparameter.
by the namespecified
namecanbe replaced
-The RESTOREf ile mustbe eithertapeor disk.
F l L E S t a t e m e n t ( D e v i c e I n d e p e n d e n tF i l e s )

1'63

NAME: The NAME parameteris requiredon the deviceindependentFILE statement.
It tellsthe systemthe namethe programusesto refer to the file. The namecan be any
combinationof characters
exceptcommas,apostrophes,
or blanks. The first character
m u s tb e a l p h a b e t i ca,n dt h e n a m eu s e dm a y n o t e x c e e dS c h a r a c t e ri sn l e n g t h .
UNIT: The UNIT parameteris requiredon the deviceindependentFILE statement.lt
tellsthe systemthe unit recorddevicefrom which the file will be reador to which the file
will be written. The UNIT parametermust be one of the following:
MFCUl

Primaryhopperof the 5424 (input and output files)

MFCU2

Secondaryhopperof the il24 (input and output files)

MFCMl

Primaryhopperof the 2560 (input and output files)

MFCM2

Secondaryhopperof the 2560 (input and output files)

1442

1442 CardReadPunch(input and output files)

2501

2 5 0 1C a r dR e a d e (r i n p u tf i l e so n l y )

1403

1 4 0 3P r i n t e r( o u t p u tf i l e so n l y )

3284

3 2 8 4 P r i n t e r( o u t p u tf i l e so n l y )

3741

3741 DataStation/Programmable
Work Station (input and output files)

READER

U s et h e p a r t i t i o n ' sa s s i g n esdy s t e mi n p u t d e v i c e( i n p u tf i l e so n l y ) .
Note: You cannotusethis parameterif the systeminput deviceis
assigned
to the console.

PRINTER

Usethe partition'sassigned
systemprint device(output filesonly)

PUNCH

Usethe partition'sassigned
systempunchdevice(output filesonly)
A/ofe.'This parametercannotbe usedif the systemhasno punchdevice.

PRINT: The PRINT parameteris usedto specifywhetherinterpretingis to be doneon
punchfiles. lt is ignoredwhen the file is not beingpunchedor when the punchdevice
d o e sn o t s u p p o r tp r i n t i n g . l f P R I N T - Y E Si s s p e c i f i e dt h
, e d a t ab e i n gp u n c h e di s a l s o
p r i n t e d o n t h e c a r dW. h e n P R l N T - N O i s s p e c i f i e d , t h e d a t a i s n o t p rl if nt ht ei sdp. a r a m eter is not specifiedand the deviceis capableof printing,PRINT-YESis assumed.
RECL: The RECL parameteris usedto specifythe numberof bytesin a logicalrecord
on the 3741. lt can be any numberfrom 1 through 128. lt a deviceother than the 3741
is used,the parameteris ignored. lf this parameteris not specifiedfor the 3741,arecord
lengthof 96 is assumed(unlessoverridenby the program).
SpoolingConsiderations

1€4

None

HALT Statement
Function

at IPL or
The HALT statementis usedto overridethe svstemnohalt modeestablished
the nohalt modeestablished
by a NOHALT statement(seeNOHALT statemedtor
or NOHALT command).The systemnormallydoesnot stop at the end of job or job step
in a partition. The HALT statementcauses
the partitionin which it wasreceivedto stop
whenevera systemmessage
is issuedor when end of job or job stepoccurs,and requires
the operatorto selectthe recoveryoption. The operatormust restartthe partitionby
responding
to the systemmessage
issued.The systemremainsin halt modeuntil a
NOHALT statementis issued,IPL occurs,or end of job is reached.lt then returnsto the
IPL nohalt modeor the modeestablished
by the last HALT/NOHALT cornrnandreceived
by the system.Whena HALT OCL statementis receivedin a partition,the severitycode
for haltsis resetso all systemhaltsincludingend-of-step
and end-of-jobhaltsmust be
respondedto. SeeNOHALT Statementfor a descriptionof severitycodes.

Placement

A HALT statementcan be placedanywhereamongthe OCL statements.ln a procedure
it must precedethe RUN statement.

Format

llHALT

Contents

None (commentsmay be enteredafter the blank positionfollowing HALT).

SpoolingConsiderations

None

HALT Etaternent

1-65

IMAGEStatement
Function

To operatecorrectly,the printerrequirescharacters
matchingthoseon the printerchain
or train to be in a specialareaof main storagecalledthe chain-image
area. Whenyou
replacethe printerchainor train with one havingdifferentcharacters,
you mustatso
changethe contentsof the chain-image
area.
The IMAGE statementinstructsthe systemto replacethe contentsof the chain image
areawith the characters
indicatedby the datarecordsenteredfrom the systeminput
deviceor containedin a sourcelibrary. The effect of the IMAGE statementis temporary,
and the systemchainimageis returnedto the chain imagespecifiedduringsystemgeneration if the systemIPL procedures
is performedagain.

Placement

The IMAGE statementcan appearanywhereamongthe OCL statements.In a procedure,
it must precedethe RUN statement.

Format

/ / I M A G Ep a r a m e t e r s

Contents

T h e I M A G Es t a t e m e ntte l l st h e s y s t e mo n e o f t w o t h i n g s : ( l ) t h e n e w c h a i nc h a r a c t e r s
areto be readfrom the systeminput device,or (2) the new chaincharacters
areto be
readfrom the sourcelibrary.
T h e I M A G E p a r a m e t e rasr e :
(HEX )
f o r m a t -< C H A R >

(rrrrrnr
J

number-value
name-name
unit-code
Note: The wordsformat, number,name. andunit arenot coded as part of the parameters
for the IMAGE statement.
( C o d i n go n l y H E X , C H A R ,o r M E M i s p r e f e r a b lfeo r f o r m a t ,b u t H E X A D E C I M A L ,
C H A R A C T E Ro. r M E M O R Yc a n b e c o d e d . )

1-66

Charactersfrom the SystemInput Device
lf you wish to indicatethat new characters
areto be readfrom the systeminput device,
usethe followingparameters:
format: Usethe word CHAR to indicatethat characters
are in EBCDIc form. Usethe
w o r d H E X t o i n d i c a t et h a t t h e c h a r a c t e rasr ei n h e x a d e c i m a
f ol r m .
number: The numberparametermust be usedwith HEX and cHAR. lt must be a value
t h a t i s e q u a lt o t h e n u m b e ro f c o l u m n so r l i n e p o s i t i o n isn t h e d a t ar e c o r d so r t h e d a t a
k e y e di n f o l l o w i n gt h e I M A G Es t a t e m e ntth a t c o n t a i n st h e n e w c h a r a c t e r sT. h i sn u m b e r
must not exceed240 when the characters
are hexadecimal
or 120 whencharacters
are
E B C D I C .T h e n a m ea n d u n i t p a r a m e t e rms u s tn o t b e c o d e d . T h e r u l e sf o r p u n c h i n ga n d
keyingthe new characters
areasfollows:
o T h e c h a r a c t e rm
s u s tb e g i ni n p o s i t i o n1 .
Consecutive
cardcolumnsor line positionsmust be used;however,only the first 80
s f t h e c a r do r l i n ec a nb e u s e d . H e x a d e c i m a
c o l u m n so r l i n e p o s i t i o n o
r el q u t r easn
e v e nn u m b e ro f c o l u m n so r l i n e p o s i t i o n st ,w o p e r c h a r a c t e r .
o C h a r a c t e rcso n t i n u e do n a n o t h e rc a r do r l i n em u s tb e g i ni n p o s i t i o n1 .

Gharactersfrom the Source Library
To indicatethat new chaincharacters
are to be readfrom the sourcelibrary,the MEM
p a r a m e t em
r u s tb e s p e c i f i e dT
. h e f o l l o w i n gp a r a m e t e rms u s ta l s ob e i n c l u d e d :
Name: The nameparameteridentifiesthe sourcemembercontainingthe characters
in
t h e l i b r a r y . Y o u c a n p l a c et h e c h a r a c t e ri sn a s o u r c el i b r a r yb y u s i n gt h e l i b r a r ym a i n t e nanceprogram.The nameyou supplyin the library maintenance
control statementis the
nameusedto identify the characters
in the sourcelibrary.
Unit: The unit parametermust be usedwith the nameparameter.lt tellsthe system
w h i c hs i m u l a t i o n
a r e ac o n t a i n st h e s o u r c el i b r a r y . P o s s i b lceo d e sa r e R 1 , F 1 , R 2 , F 2 .

IMAGE Statement

1-67

Examples

T h e I M A G Es t a t e m e nitn @ t e t t st h e s y s t e mt h a t t h e n e w c h a r a c t e r(sf r o m
thesystem
i n p u td e v i c e a) r ei n h e x a d e c i m a
f ol r m ; t h e n u m b e rp a r a m e t eirn d i c a t etsh a t t h e r e a r e1 2 o
positions(60 characters)
containingthe new characters.
l n @ , t h e n e w c h a r a c t e r(sf r o m t h e s y s t e mi n p u td e v i c e a
) r ei n E B C D I C .T h e n u m b e r
p a r a m e t ei rn d i c a t etsh a t t h e r ea r e4 8 c o l u m n so r l i n e p o s i t i o n s
containing
thenew
48-character
image.
@ t . t t , t h e s y s t e mt h a t t h e n e w c h a r a c t e rasr ei n t h e s o u r c el i b r a r y . T h e n a m ep a r a m eter indicatesthat the characters
werenamedCHAIN in the sourcelibrary. The unit
p a r a m e t ei rn d i c a t etsh a t t h e s o u r c el i b r a r yc o n t a i n i n g
t h e mi so n t h es i m u l a t i o n
area
assigned
to R 1. Examplesof the entry specified in
are
ano
.
The
entry
itself
@
@
m u s tc o n t a i na n I M A G Es t a t e m e nwt i t h t h e c h a r a @
c t e ri sn e i t h e rh e x i d e c i m aol r E B C D I C .
The numberof columnscontainingthe characters
must arsobe specified.(seeLibrary
Maintenance
Programin Part4 for restrictionson the nameusedin codingMEM.)

Spooling Considerations

N o s u p p o r ti s p r o v i d e db y s p o o l i n gf o r c h a n g i n tgh e c h a i ni m a g ef o r p r i n t e o
output.
Print recordsthat arespooledareprintedwith the currentlyloadedchainimage.
lf a
specialprint chainor train is requiredfor a job stepon the print queue,it is
the operator,s
responsibility
to load the chainimagebeforethe print writer startsprintingthe output.
l f y o u w a n t t o c h a n g ey o u r c h a i ni m a g ei n a s p o o l i n ge n v i r o n m e n u
t ,s eo n eo f t h e f o l l o w i n gm e t h o d s :
S u p p l y a n I M A G E s t a t e m e n ti n a p a r t i t i o n . T h i s c h a n g e st h e c h a i n i m a g ef o r
the print
writer but not for the job being loaded in the partition. The print writer
must be
stopped with a STOP command before the chain image is changed.
B y p a s ss p o o l i n g ,a l l o w i n g t h e p a r t i t i o n t o u s e t h e p r i n t e r d i r e c t l y b y u s i n gt h e

srART sPooL andsroP spooL command
in thepartition
andsrART pRTand
STOPPRTcommand.

1-68

!NCLUDEStatement
Function

) t h e s o u r c el i b r a r yt h a t c o n T h e I N C L U D Es t a t e m e nitd e n t i f i etsh e e n t r y ( p r o c e d u r ei n
job
tainsthe OCL statements
to be mergedinto the
stream.Whenprinted.the merged
OCL statements
are identifiedby an X/ precedingthe statementidentifier. The source
memberto be includedinto the job streamcannotcontaina CALL statement.

Placement

The INCLUDEstatementcan appearanywhereamongthe OCL statements.lt must
p r e c e d e t h eR U N s t a t e m e n(ti f R U N i s u s e d )i n a p r o c e d u r e N
. e s t e dI N C L U D Es t a t e mentsare not allowed.

Format

t cahr a c t e r s ]
/ / I N C L U D Ep r o c e d u r e - n a m e , u n i t [ , s wci h

Contents

Procedure-name.'
This nameidentifiesthe procedurein the sourcelibrary. lt must be
the samenamethat wassuppliedin the library maintenance
control statementwhen the
procedurewasenteredin the sourcelibrary.

U n i t : T h e u n i t p a r a m e t e r i s a r e q u i r e d c oTdhee. c o d e i d e n t i f i e s t h e s i m u l a t i o n a r e a t h a t
containsthe procedure.Possible
codesare R 1, F 1, R2, F2.
(0. 1, and X) areoptional. Whenyou include
Switchcharacters:The switchcharacters
them, you must supply8 characters,
because
they arecomparedwith the eightexternal
indicators.The systemdoesa comparisonfor eachpositionif the switchcharacteris a 0
or 1. An X cancelsthecompareoperationfor that positiononly. The first (leftmost)
switchcharacteris comparedwith externalindicator1; then the secondswitchcharacter
is comparedwith externalindicator2; this processcontinuesuntil the 8 switchcharacters
and the eightexternalindicatorpositionsareeithercomparedor bypassed.lf an equal
conditionexists.the INCLUDEstatementis accepted.Otherwise,an informational
message
is displayedand the INCLUDEstatementis not accepted.

INCLUDE Statement

1-69

Example

Il

a
E

/ / s w r T C H1 0 1 0 1 0 1 0
// LOADABC.Fl
E, R 1 , 1 O 1 OO1 O 1
/ / I N C L U DX
/ i T N c L U DYE. R 1 , 0 1 0 1 0
10 1
E , Rl , X O X O X O 1
// INCLUDZ
// RUN

||

This INCLUDE statementis accepted,and the OCL statements
in procedureX are
mergedinto the job stream.

Z

This INCLUDE statementis not accepted,
and an informationalmessage
is
displayed.

E

This INCLUDEstatementis accepted,and the OCL statements
in procedureZ are
mergedbetweenprocedureX OCL statements
and the RUN statement.The job
streamis changedasfollows:
ll
//
ll
x/
XI
XI
//

swtTcH 10101010
LOADABC,Fl
tNCLUDEX.Ft,10101010
DATE O51O77
)
F I L E N A M E . A , U N I T - D 1 , P A C K - D I D 1) DP1r o c e d u rXe
F I L E N A M E . B , U N I T . D I , P A C KD-IDD1l )
t N c L U D EY . F 1 . 0 1 0 1 0 0 1 1
CR FL SH I
ABCO1
i*
**
T H I S I N c L U D EB Y P A S S E D
INDIcAToRS-1010101o**
// INCLUDEZ,FI,XOXOXOIO
Xl FILENAME.D.UNIT.D2,PACK-D2D2D2
)
e
X l F I L E N A M E - E , U N t T - D 2 , P A C K - D 2 D 2|D p2 r o c e d u r Z
X I F I L E N A M E - F , U N I T - D 2 .APC K - D 1 D a D 2
)
// RUN
SpoolingConsiderations

None

P a s eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
Bv TNL: GN21-5674

JOB Statement
Function

The JOB statement allows you to group related job steps together to ensure that they are
r u n s e q u e n t i a l l y .T h e s y s t e md o e s n o t i n i t i a t e t h e n e x t s t e p o f a j o b u n t i l t h e p r e v i o u s
l o b s t e p h a s b e e n c o m p l e t e ds u c c e s s f u l l y .l t i s r e q u i r e do n s y s t e m st h a t h a v e a c t i v e
s p o o l i n go r o n n o n s p o o l i n gs y s t e m sr u n n i n g i n j o b m o d e .

Placement

T h e J O B s t a t e m e n tm u s t p r e c e d et h e f i r s t L O A D o r C A L L s t a t e m e n t . l t c a n n o t b e
used in a orocedure.

Format

//jobname JOB parameters
J o b n a m e : T h i s i s a r e q u i r e de n t r y u s e d t o u n i q u e l y i d e n t i f y a j o b . l t m u s t b e g i n i n
position 3, may not exceed 8 charactersin length, and may not contain a comma. When
the last two charactersof a jobname are asterisks(**), the system replacesthem with a
s e q u e n c en u m b e r . T h e a s s i g n e dn u m b e r ( f r o m 0 1 t h r o u g h 9 9 ) i s i n c l u d e d i n a n i n f o r m a tional message.
J o b ( a n d s t e p ) n a m e ss h o u l d c o n t a i n o n l y c h a r a c t e r st h a t a r e o n t h e 3 2 7 7 D i s p l a yS t a t i o n
keyboard. ff the jobname contains charactersthat are not on the 3277 keyboard, that
j o b c a n n o t b e r e f e r e n c e db y i t s j o b n a m e b y u s i n gc o m m a n d s . T h e s en o n d i s p l a y a b l e
charactersmay also cause display problems when written lo the 3277 display. The iobname is displayed on the display screenwith system messagesand halts associatedwith
t h e j o b . l t i s a l s o t h e n a m e b y w h i c h j o b s a r e i d e n t i f i e d o n t h e s p o o l i n gq u e u e s .

Content

A l l p a r a m e t e r sa r e o p t i o n a l . T h e y a r e a s f o l l o w s ( d e f a u l t sa r e u n d e r l i n e d ) :

,-,",
,"Ill

tit

C O R E - n n (nc a nb e 1 , 2 , o r 3 d i g i t s )
SPOOL-

f Y E SI

l r u oJ

1
2
3
PARTITION. A
B

c
D

ocoPY-I Y E S I
tNo )

JOB Statement

1-71

PRIoRITY: A priority may be assigned
to a job to indicateits levelof importanceon the
readeror output queues.The priority of the job stepsfor a job on the output queues
is
t h e p r i o r i t ya s s i g n etdo t h a t j o b o n t h e r e a d e q
r u e u eu n l e s so v e r r i d d e b
ny a p R l O R l T y
p a r a m e t eorn a P R I N T E Ro r P U N C Hs t a t e m e n t p. r i o r i t y0 i n d i c a t e s p r i o r i t y j o b .
a
I
which is to be held on the readerqueueuntil released
via an operatorcontrol command.
(SeeAppendixC for a summaryof operatorcontrol commands.)
Priority 5 is the highest
priority that may be assigned.within a givenpriority, jobs arescheduled
on a first-in,
first-outbasis.lf this parameteris not specified, priority r is assumed.
CORE: This parameterspecifies
the amountof main storagerequiredto executethe
l a r g e sst t e pi n a j o b a n de s t a b l i s h easm i n i m u mp a r t i t i o ns i z ef o r t h e d u r a t i o no f t h a t j o b .
{lt doesnot assignmain storageto the partition;a SET commandmust be usedfor this
purpose.)when this parameteris not specified,the systemassumes
that the job is
scheduled
in a partitionwith adequatemain storageand usesthe presentpartitionsizeas
t h e m i n i m u mf o r t h e j o b . E i g h ti s t h e m i n i m u mv a l u et h a t m a y b e s p e c i f i e d2;3 g i s t h e
maximumvaluethat may be specified. Anythinglessthan 8K is treatedas 8K. This can
b e i n c r e a s ei d
n 2 K i n c r e m e n tusp t o a m a x i m u mo f 2 3 g K . l f t h e p a r a m e t ei rs n o t a 2 K
increment,it is roundedup to the next 2K increment.when the coRE parameteris
specified,the partition must havethe requested
amountof main storageavailablebefore
the job can be executedN o t e : l f m o r et h a n 1 2 8 f i l e sa r et o b e p r o c e s s ei d
, i n i m u mp a r t i t i o ns i z e
n a partitionm
i s1 0 K .
SPOOL: SPOOL-NOensuresthat the job will not be loadedif spoolingis activein that
partition. lf SPooL-No is specified,the systempreventsthe job from beingexecuted
when spoolingis active. lt is your responsibility
to ensurethat l/O devicesfor the job
areavailable
and spoolinghasbeenstoppedfor the partition. you may free a device
requiredby a job and stop spoolingin a partition by usinga STOpcommand. (See
AppendixC for a summaryof operatorcontrol commands.)SPOOL-NOshouldbe used
when a job requiresdedicateduseof one or more devicesbeingusedby spooling.
SPOOL-YES
specifies
a job that may be run with spoolingactive. lf this parameteris not
g i v e nS
. P O O L - Y E iSs a s s u m e d .

1-72

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

PARTITION.' This parameteris usedto specifythe partitionin which the job must be
e x e c u t e d .l f t h i s p a r a m e t ei rs n o t s p e c i f i e a
d n d i n p u t s p o o l i n gi s n o t u s e d t, h e s y s t e m
dn d
a s s u m et sh e i o b c a n b e e x e c u t e di n a n y p a r t i t i o n . l f P A R T I T I O Ni s n o t s p e c i f i e a
i n p u ts p o o l i n gi s b e i n gu s e d t, h e j o b i s s c h e d u l efdo r e x e c u t i o ni n p a r t i t i o n1 . O n c ea j o b
i s p l a c e do n t h e r e a d e q
r u e u e i,t s p a r t i t i o na s s i g n m e n
ca
t h r o u g hu s eo { i t r e
t nb e c h a n g e d
p
a
r
t
i
t
i
o
n
CHANGE
commands.
T h e m e a n i n go f e a c hp a r t i t i o nc o d ei s :
Code

Meaning

1

E x e c u t ej o b i n p a r t i t i o n1

2

E x e c u t ej o b i n p a r t i t i o n2

3

E x e c u t ej o b i n p a r t i t i o n3

A

E x e c u t ej o b i n p a r t i t i o n1 o r 2

B

E x e c u t ej o b i n p a r t i t i o n1 o r 3

?

E x e c u t ei o b i n p a r t i t i o n2 o r 3

D

E x e c u t jeo b i n p a r t i t i o n1 , 2 , o r 3

y'yote.'When keyword parametersare not specified on this statement, comments may not
b e g i v e n f o l l o w i n g t h e J O B s t a t e m e n ti d e n t i fi e r .
Q C O P Y : T h i s o p t i o n a l p a r a m e t e r( O C O P Y - N O )p r e v e n t st h e s p o o l f i l e c o p y p r o g r a m
( $ O C O P Y ) f r o m a c c e s s i n tgh e j o b o n t h e r e a d e rq u e u e . l f O C O P Y - Y E Se i t h e r i s s p e c i f i e d
or is the default, the spool file copy program can copy the job from the reader queue.

JOB Statement

1-72.1

T h i s p a g e i n t e n t i o n a l l yl e f t b l a n k .

1-72.2

The precedingJOB statementcauses
the following:
Statementreadby the spooledreader:
- Priority 1 is assigned
to the job on the readerqueueand output queues(seenote).
- Job is executedin partition 1.
- E X A M P L E l i s t h e j o b n a m eo n t h e r e a d e a
r n d o u t p u tq u e u e s .
Statementis not readby the spooledreader:
- The partitionthe job executesin is the partitioninto which the operatorloads
the job.
- lf spoolingis activefor the partitioninto which the job is loaded.priority 1 is
assigned
to the output queues(seenote).

The preceding
JOB statementcauses
the following:
o Statementreadby the spooledreader:
- Priority 5 is assigned
to the job on the readerqueueand output queues(seenote).
- J o b i s e x e c u t e di n p a r t i t i o n1 .
- EXAMPLE2is the jobnameon the readerand output queues.
- P r i o rt o t h e j o b b e i n gi n i t i a t e d , 4 S Ko f m a i ns t o r a g e
m u s tb e a v a i l a b lien p a r t i t i o n1 .
o Statementnot readby spooledreader:
- The partitionthe job executesin is the partitioninto which the operatorloads
the job.
- The job is executedif 48K of main storageis availablein the partitioninto which
the job wasloaded.
- lf spoolingis activefor the partitioninto which the job is loaded,priority 5 is
assigned
to the output queues(seenote).
ffote.' The priority on the output queuescan be differentfor a.jobstepwithin the job
i f t h e P R I O R I T Yp a r a m e t ei rs s p e c i f i e o
d n t h e P R I N T E Ra n d / o rP U N C Hs t a t e m e n t .

JOB Statement

1-73

The precedingJOB statementcauses
the following:
.

Systemwith spooling
- The job must be loadedinto partition2.
- Spoolingmay not be activein partition2.
- At least10K of main storagemust be availablein partition
2.

o Systemwithout spooling
- The job must be loadedinto partition2.
- At least10K of main storagemust be availablein partition
2.
Spooling Considerations

1-74

lf spoolingis activein a partition,the JOB statementmust be usedin that partition.
when jobs are beingreadonto the readerqueue,any errorson the JoB ocL statement
causethat job to be assigned
a priority of 5. lf the jobnameis missingor invalid,the
defaultjobname.JOB, is assigned
to that job on the readerqueue.

LOAD and LOAD * Statement
Function

The LOAD statementidentifiesthe programto be executedand indicateswhetherthe
programwill be loadedfrom the systeminput devicefor the partition,from an 6bject
l i b r a r y ,o r f r o m a f i l e o n a m a i nd a t aa r e a .

Placement

One LOAD statementis requiredfor eachprogramexecuted.On systemsbeingrun in
stepmode,the only requirementis that the LOAD statementprecedethe RUN state'
ment. The LOAD statementmustfollow the JOB statement,and precedethe RUN
statementwhen operatingin job mode. Any numberof job steps(LOAD/RUN combinations)may follow a JOB statement.For a completedescriptionof job modeand
stepmodeseePart2 of this manual.

Format

The LOAD statementhasthe followingformats:
*
/ / [ s t e p n a m eL
] OAD [,program-name1,unit1]
*.]
[,switchcharacters](a blank is mandatorybetweenLOAD and
/ / [ s t e p n a m eL
] OADprogram-name2,unit2
characters]
[,switch
The first format is usedto loadobject programsfrom the systeminput deviceor from a
file on a main dataarea. The secondformat is usedto loadobjectprogramsfrom an
o b j e c tl i b r a r y .

Contents

stepname:This optionalentry is usedto uniquelyidentify a job step. lf specified,the
in
stepnamemust beginin position3 of the statement.must not exceed8 characters
l e n g t ha. n d m u s tn o t c o n t a i na c o m m a . S t e p n a m e(sa n dj o b n a m e ss)h o u l dc o n t a i no n l y
characters
that areon the 3277 DisplayStation keyboard. lf the stepnamecontains
characters
not on the 3277 keyboard,that stepcannotbe referencedby its stepnameby
may alsocausedisplayproblemswhen
characters
usingcommands.Thesenondisplayable
written to the 3277 display. The stepnameis displayedon the displayscreenwith system
messages
associated
with the job step. lf a stepnameis not specified,the systemassigns
by the systemis madeup of the program
a stepnameto eachstep. The stepnameassigned
by the system.Stepnames
namefrom the LOAD statementand a 2-digitnumberassigned
assigned
by the systemare incrementedby one at end of job stepin which a stepnameis
*
the systemassigns
assigned.lf a LOAD statementwithout a stepnameis encountered.
a stepnameof ASTRSKnn. The numberportion of the stepnameis resetto 1 at end of
job. After 99 stepnames
havebeenassigned
within one job. the numberis resetto 1.
Whenthe print and punchqueuesaredisplayed,the stepnameidentifiesjob stepson the
queues.
Asterisk: An asteriskis specifiedwhen the userwantsthe obiectprogramloadedfrom
the partition'ssysteminput deviceor from a file on a maindataarea. The obiectprogrammust follow the RUN statementif the programis loadedfrom the partition'ssystem
input device,and a /* statementmustfollow the objectprogramto indicatethe end of
the objectprograminput. The objectprogramis temporarilycopiedinto the object
libraryon the systempackand then loadedinto main storagefor execution. LOAD "
programsareacceptedin any partition;however,while a LOAD * programwith overlays
'proLOAD
is running.no other LOAD * programscan be loaded.Whena subsequent
gramis received,
the systemissuesa diagnostic,which allowsthe usereitherto wait for
*
LOAD program.
completionof the LOAD * programor to cancelthe subsequent

LOAD and LOAD ' Statement

1-75

Program-namel.'
This entry identifiesthe file that containsthe oblectprogramto be
loaded.The program-namel
can be any combinationof characters
exceptcommas,
apostrophes,
or embeddedblanks. The first charactermust be alphabetic.The length
mustnot exceed6 characters.
unitl: This entry specifies
the main dataareathat containsthe file from which the
objectprogramis to be loaded. Possible
codesarethosefor the main dataareas.
y'y'ote.'
Althoughthe userdoesnot specifyan ocl FILE statement,theLOAD * from
f i l e f u n c t i o nr e q u i r e a
s n F 1 e n t r y i n t h e S W A . T h e s y s t e mp r o d u c eas s i m u l a t e dF I L E
statementto protectthe file from which the programis beingloaded. Therefore,the
numberof availablefile statements
that can be usedwhen a programis loadedfrom a file
i s r e d u c e db y 1 . T h e p r o g r a m - n a m epla r a m e t em
r u s ti d e n t i f yt h e f i l e w h i c hc o n t a i n st h e
programbeingloaded.
(0, 1, and X) areoptional. Whenyou include
Switchcharacters:The switchcharacters
them, you must supply8 characters
because
they are comparedwith the eightexternal
indicators.The systemcompareseachpositionif the switchcharacteris a 0 or l. An X
cancelsthe compareoperationfor that positiononly. The first (leftmost)switchcharacter
is comparedwith externalindicator1; then the secondswitchcharacteris comparedwith
externalindicator2. This processcontinuesuntil the 8 switchcharacters
and the eight
externalindicatorpositionsareeithercomparedor bypassed.lf an equalconditionexists,
the programis loaded. otherwise,an informationalmessage
is displayedand the job
streamis flushedto the next step.
The program-namel
and the unitl parameters
are positionalparameters.Therefore,if
you includethe switchcharacters
without theseparameters,
you must separate
the * and
the switchcharacters
with either 1 or 3 commas. For example:
*,xxxxxxxx
// LOAD
or
*,.,xxxxxxxx
ll LOAD
program-name2:The program-name2is the name usedto identify the programin the
objectlibrary. Program-name2
may be up to 6 characters
in length. The namemust begin
with one of the 29 alphabeticcharacters
(A-2, @,#, or $) and may be followedby up to
5characters.commas,apostrophes,
periods,and blanksmay not be usedin the name.
The systemserviceprogramsand programproductsare identifiedby the followingnames:

1-76

Program

Name

Restart
AlternateTrack Assignment
BasicAssembler
R P Gl l A u t o - R e p o r t
A l t e r n a t eT r a c k R e b u i l d
C O B O LC o m p i l e r
CommunicationControl Program
Card List
ConfigurationRecord
Copy/Dump
CardSort/Collate
Dump/Restore
F i l eD e l e t e
CCP/DisS
k ort

$$RSTR
$ALT
$ASSEM
$AUTO
SBUILD
$CBL0O
$CCP
$CL|ST
$CNFIG
$COPY
$CSORT
SDCOPY
$DELET
$DGSRT

Program

Name

D i s kS o r t
F i l eC o m p r e s s
FORTRAN
Gangpunch
Systeml{istory Area Display
D i s kI n i t i a l i z a t i o n
C h a i nC l e a n i n g
F i l ea n d V o l u m eL a b e lD i s p l a y
LibraryMaintenance
MacroProcessor
O v e r l a yL i n k a g eE d i t o r
S p o o lF i l eC o p y
C a r dR e p r o d u caen d I n t e r p r e t
R e c o v eIrn d e x
R P Gl l C o m p i l e r
Reassign
AlternateTrack
S i m u l a t i o nA r e a
T a p eI n i t i a l i z a t i o n
Tape Sort
TapeError SummaryProgram
VTOC Service

$DSORT
$FCOMP
$FORT
$GANGP
$HIST
$INIT
$KLEAN
$ L A B EL
$MAINT
$MPXDV
$OLINK

$ocoPY
$REPRO
$RINDX
$RPG
$RSALT
$SCOPY
$TINIT
$TSORT
$TVES
$WVTOC

Unit2: fhe unit2 parameteris a requiredcode. lt indicatesthe simulationareathat
c o n t a i n st h e p r o g r a m .P o s s i b lceo d e sa r e R 1 , F 1 , R 2 , F 2 .
The disk areacontainingyour objectprogramis calledan objectlibrary. You can create
an objectlibrary on any of the simulationareasby usingthe library mainrenance
program.
(SeeLibrary MaintenanceProgramin Part 4 of this manual.)
Example

I n t h e f o l l o w i n gs a m p l eL O A D s t a t e m e n t$, R P Gi s t h e n a m et h a t i d e n t i f i etsh e R P Gl l
compiler.

F 1 i s t h e c o d ei n d i c a t i n g
t h e s i m u l a t i o na r e aw h e r et h e c o m p i l e ri s l o c a t e d .
The systemwould assigna stepnameof $RPG01,because
a stepnameis not specifiedon
the LOAD statement.
The followingexampleshowsa stepnameassigned
by the user:

T h e s y s t e mw o u l du s et h e s t e p n a m e
RPGFl.

LOAD and LOAD * Statement

1-77

The followingexampleshowshow the switchcharacters
can be usedto determinewhether
or not a job stepwill be executed.Assumethat a programhasjust completedexecuting
s u c c e s s f u lal yn d h a ss e tt h e e x t e r n ailn d i c a t o rtso 1 0 1 0 1 0 1 0 .T h e o C L s t a t e m e n t s
f o l l o w i n gt h e c o m p l e t e dp r o g r a ma r e :

Il

z
E
I|

a
g

Step 1 is not executedbecause
the externalindicatorsdo not agreewith the switch
characters.An informationalmessage
with the valueof the externalindicatorsis
issued.The systemthen flushesto the next step (step2).
Step2 is executedbecause
the externalindicatorsagreewith the switchcharacters.
(TheswitchcharacterX tellsthe systemto cancelthe compareoperationwith the
relativeexternalindicator.)
Step3 is executedafter step2 is completed.

The followingexampleshowsthe ocL statements
and parameters
neededto loada
p r o g r a mf r o m a f i l e :

*
The LoAD * identifiesthe requested
function. The programis processed
asa LoAD
type program.The samerulesand restrictionsthat apply to a programloadedfrom the
s y s t e mi n p u td e v i c ea l s oa p p l yt o a p r o g r a mt h a t i s l o a d e df r o m a f i l e .
(MNO) must be the nameof the file that containsthe program.
The program-name
The programis containedin a file that is locatedon a main dataarea(D42). The program
is copiedto the objectlibraryon the systempack beforebeingloadedinto main storage
for execution.The systempackbecomesthe programpackfor all LOAD * programs
regardless
of whetherthey are loadedfrom disk or from the systeminput device.
S p o o l i n gC o n s i d e r a t i o n s

1-78

None

LOG Statennent
Function

The LOG statementis usedto performtwo functions:
o Changethe systemlog devicefor a partition.
.

Controlend-of-jobpageejectionon the log device.

SystemLog Device
Duringsystemgeneration,a systemlog deviceis established
for eachpartition. Whena
LOG statementis used,the devicespecifiedasthe systemlog deviceremainsin effect for
the partitionuntil anotherLOG statementis reador until IPL is performed.The log
deviceappliesonly to the partitionin which the LOG statementis processed.
The followinginformationisnor loggedon the printer,but itis loggedin the system
h i s t o r ya r e a( S H A ):
o Responses
to ERP (errorrecoveryprocedures)
messages
o Responses
to EJ/ESmessages
o Spoolingmessages
and responses
o Volumerecognitionfacility messages

. occ
.

OCCdiagnostics

o Any ERP message
receivedwhile a printer ERP message
is active
o Partitionidentificationon OCL statements
and control statements
for systemservice
programs.
lf loggingof the aboveinformationis required,you shouldassignthe log deviceonly to
the CRT and periodicallyprint the contentsof the systemhistoryareausingthe system
history areadisplay program ($HIST). SeeSysfemServiceProgramsin Part 4 for a descriptionof $H lST.

Logging to the SHA
All systemmessages
and OCL statements
are loggedto an areaon the systempackcalled
the SHA (systemhistoryarea).
Note: You may print the SHA or copy the SHA to a deviceindependentfile using
$ H l S T . A l s o ,y o u m a y d i s p l a yt h e S H A o n t h e d i s p l a ys c r e e nu s i n gt h e D I S P L A Y
command.SeeSysfemServiceProgramsin Part4Ior a descriptionof $HlST, or Appendix
C for a summaryof the operatorcontrol commands.

LOG Statement

1-79

Logging to the CRT
Systemmessages
that requirea response
and informationalmessages
are loggedto the
CRT independent
of the assigned
log device. The only effect of a ll LOGCONSOLE
statementis that loggingto the printer is stopped.

Logging to the 3294
lf the 3284 is assigned
asthe log deviceand is not assigned
to a partition,systemmessages,
OCL, and control statements
are loggedto the 32g4.

Logging to the l4O3
Systemmessages,
ocL, and control statements
areloggedto the 1403 if the 1403 is
assigned
asthe systemlog device,if the 1403 is nof assigned
to a partition,and if one of
the followingconditionsis met:
o Print spoolingis neitheractivenor usingthe 1403.
In this case,OCL statements
and
messages
are loggeddirectlyto the 1403.
o Print spoolingis active(interceptingprint requests).
In this case,OCL statements
anct
systemmessages
are loggedto the printerqueue.

Controlling page Ejection
The LOG statementis usedto control pageejectionthat occursbeforeES
and EJ and
after EJ' The EJECTand NOEJECTmodesremainin effect for any log
deviceuntil
anotherLOG statementis read,or until an lpL is performed.
Placement

You can usethe LOG statementwithin any of the setsof OCL statements your job
for
steps. ln a procedure,it must precedethe RUN statement.

Format

llL}Gdevicel,mode]
or
// LOG ,mode

1-80

Contents

The followingcodescan be usedas parameters.
Device

Meaning

CONSOLE

Logto the CRT and the systemhistoryarea.

1403

Log to the CRT, the 1403 printer,and the systemhistoryarea.

3284

Log to the CRT. the 3284 printer, and the systemhistory area.
The log deviceis not changed.

SpoolingConsiderations

Mode

Meaning

EJECT

Ejecta pagebeforeES and EJ and after EJ. lf no mode is specified,
E J E C Ti s a s s u m e d .

NOEJECT

Do not ejecta pagebeforeESand EJ and after EJ.

When1403 printedoutput is beingspooled,and the systemlog devicehasbeenassigned
to the 1403 printer.all systemmessages
that would normallybe loggedon the 1403are
placedin the spooledprint f ile. Whenthe spooledoutput is printed,the systemmessages
areprinted,alongwith the job steps'output. Whenspooling1403output, a pageeject
occursat the startof everyjob step'sprintedoutput, regardless
of the modespecifiedon
the LOG statement.

LOG Statement

1-81

NOHALT Statement
Function

T h e N O H A L T O C L s t a t e m e n ti s u s e d t o c a n c e lt h e h a l t m o d e e s t a b l i s h e db y a H A L T O C L
statement. lt can also be used to establisha severity code for system messages
to allow
t h e s y s t e mt o s e l e c td e f a u l t o p t i o n s f o r s y s t e m m e s s a g e sT. h e N O H A L T O C L s t a t e m e n t
d o e s n o t o v e r r i d et h e h a l t m o d e e s t a b l i s h e db y t h e H A L T c o m m a n d . c o m m a n d h a l t
m o d e i s a l w a y s p r e v a l e n t( s e ec h a r t b e l o w ) .
T h e N O H A L T O C L s t a t e m e n t c h a n g e s t h eh a l t m o d e f o r t h e p a r t i t i o n i n w h i c h i t w a s
r e c e i v e d .A N O H A L T O C L s t a t e m e n tt a k e se f f e c t i m m e d i a t e l ya n d l a s t su n t i l a H A L T
O C L s t a t e m e n ti s r e c e i v e d a
, n o t h e r N O H A L T O C L s t a t e m e n tm o d i f i e st h e s e v e r i t yc o d e ,
I P L i s p e r f o r m e d ,o r e n d o f j o b o c c u r s . ( A t I P L t h e s y s t e md e f a u l t st o n o h a l t m o d e ,
with
n o s e v e r i t yc o d e . ) W h e n t h e n o h a l t m o d e i s r e s e ta t e n d o f j o b , t h e s y s t e m r e t u r n s
to the
I P L n o h a l t m o d e o r t h e m o d e e s t a b l i s h e db y t h e l a s t H A L T o r N o H A L T c o m m a n d r e c e i v e db y t h e p a r t i t i o n . T h e f o l l o w i n g c h a r t s h o w st h e c o n d i t i o n sr e s u l t i n gw h e n b o t h
O C L a n d c o m m a n d sa r e u s e d :

NOHALT

HALT

ocL

ocL

NOHALT
command

NOHALT

HALT

HALT
uommand

HALT'

HALT

t

t"**
o f j o b m e s s a g e se,n d o f j o b
, rp m e s s a g e sa,n d s y s t e m m e s s a g e s
s" "t e
with
n o s e v e r i t yd e f a u l t s o r w i t h s e v e r i t y
c o d e s g r e a t e rt h a n t h e c u r r e n t s e v e r i t v
setting.

F o r a s u m m a r yo f O p e r a t o C
r o n t r o lC o m m a n d ss,e eA p p e n d i xC .
Placement

A N o H A L T s t a t e m e ncta n b e p l a c e da n y w h e r ea m o n gt h e o c l - s t a t e m e n t sl.f a p r o c e d u r ei t m u s tp r e c e d teh e R U N s t a t e m e n t .

Format

/ / N O H A L TS E V E R I T Y - c o d e

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

Contents

T h e N O H A L T s t a t e m e n t ,w i t h o r w i t h o u t t h e S E V E R I T Y p a r a m e t e r ,s u p p r e s s etsh e
messageat end of iob step and/or end of job.
that the
SEVERITY: This parameter is used to indicate the severity code of messages
s y s t e mi s a l l o w e d t o s e l e c td e f a u l t o p t i o n s f o r . l f t h e S E V E R I T Y p a r a m e t e ri s n o t s p e c i fied, the operator must respond to all system messages,
except informational, end of job
job
step and/or end of
messages.The code must be one of the following:
1 , 2 , 4 , 8 - T h e s y s t e ms e l e c t st h e d e f a u l t o p t i o n f o r s y s t e mm e s s a g eosf a s e v e r i t yl e s s
than or equal to the code indicated. Severity codes and defaults are assignedto most
system messagesand cannot be altered. lf the severity assignedto a system messageis
g r e a t e rt h a n t h e s e v e r i t yi n d i c a t e di n t h e N O H A L T s t a t e m e n t ,t h e s y s t e ms t o p s ,w a i t i n g
for your response. lf the severity assignedto the messageis equal to or lessthan the
severitVindicated in the NOHALT statement, the system selectsthe default option for
the system messageand processingcontinues. lf the default option selectedby the system
is a 2 or a 3, the end of job messageis suppressed.The severity code does not affect
s y s t e mm e s s a g ehsa v i n gn o d e f a u l t o p t i o n s o r r e q u i r i n go p e r a t o r i n t e r v e n t i o n . S e v e r i t y
code 1 is the least severe,severity code 8 is the most severe. Severity codes are reset to
no severity at end of job. For more information on system messagesand severity codes,
seeIBM System/3 Model l5 System Messages,GC21-5076.
y ' V o t eH
; altsdisplayedinthemessagedisplayunitarenotaffectedbytheSEVERlTY
parameter.

S p o o li n g C o n s i d e r a t i o n s

None

NOHALT Slalement

1-83

Function

The PAUSEstatementcauses
a systemmessage
(message
90 if beforea LOAD or GALL
statemenU
m e s s a g9e1 i f b e t w e e na L O A D o r C A L L a n da R U N s t a t e m e n t ) l.t
isusually
usedto givethe operatortime to preparefor the next program;for
exampre,mount a
differentdata moduleor insertspecialforms into the printer.
Commentstatements
that
givethe operatorinstructionsusuallyprecedepAUSE
statements(seecomment
Statementl.
W h e nt h e o p e r a t o ri s r e a d y t, h e p a r t i t i o ni n w h i c ht h e P A U S Es t a t e m e n t w a s
r e c e i v e ids
restartedby responding
to the message.
The systemthen continuesreadingthe ocL
statements
that follow the pAUSEstatement.
The PAUSEstatementis the onry ocL statementrogged
on the disprayscreen;therefore,
i t m a y b e u s e dt o s u p p l yi n f o r m a t i o nt o t h e o p e r a t o r .

Placement

PAUSEstatements
can be placedanywhereamongthe ocL statements.In a procedure,
a PAUSEstatementmust precedethe RUN statement.

Format

// PAUSE

Contents

s a y b e e n t e r e da f t e rt h e b l a n kf o l l o w i n gp A U S E )
N o n e( c o m m e n tm

S p o o l i n gC o n s i d e r a t i o n s

None

PRINTERStatement
Function

Duringsystemgeneration,
a systemprint deviceis established
for eachpartition. The
P R I N T E Rs t a t e m e net n a b l eyso u t o c h a n g et h e s y s t e mp r i n t d e v i c ef o r t h e p a r t i t i o ni n
which the statementis processed.The new systemprint deviceremainsin effect until
changed
b y a n o t h e rP R I N T E Rs t a t e m e not r u n t i l a n o t h e rI P L o c c u r s .

Placement

T h e P R I N T E Rs t a t e m e ncta n b e p l a c e da n y w h e r ea m o n gt h e O C L s t a t e m e n t sI.n a
procedureit must precedethe RUN statement.

Format

/ / P RI N T ER o a r a m e t e r s

Contents

The parameters
areasfollows (keywordsare in capitalletters;defaultsareunderlined):
D E V I C E f.

t4o3|

\ s z uI

L I NE S - n n n
FORMSNO-nnn
C O PI E S - n n
D E F E R .f

YESt

lrlo t

ALrcN.
{G'l

\i
ll

PRIORITY-

cLosE.{#}
ocoPY-, Y E S I

t N oI

DEVICE: The deviceparameteris optional. lf not specified,1403 is assumed.Spool
doesnot supportthe 3284.
L I N E S : T h e L I N E Sp a r a m e t ei sr o p t i o n a l . l t i s u s e dt o a l t e rt h e n u m b e ro f p r i n t l i n e s
( f o r m sl e n g t h )p e rp a g e .P o s s i b lrea n g ei s 1 2 t o 1 1 2 . T h e n u m b e ro f l i n e ss p e c i f i e d
r e m a i n si n e f f e c tf o r t h a t p a r t i t i o nu n t i l a n o t h e rP R I N T E Rs t a t e m e nwt i t h L I N E Sp a r a m eter is enteredor until the next lPL. This parameteroverridesthe forms lengthspecified
duringsystemgeneration;
however,a program'sforms lengthoverridesthe LINES
parameter.lf a program'sforms lengthis used,it is in effect for the durationof that job
steponly. At the end of the job step,forms lengthis restoredto the previousvalue.

PRINTER Statement

1-85

FoRMSNO: This optionalparameter,
which appliesonly to the job stepin which the
PRINTERstatementwasused,may be usedto inform the operatorwhich forms are
to be
mountedon the printer. This parametercan be any combinationof 1 to 3 characters,
exceptcommas,apostrophes,
or blanks. when this param€teris used,the systemhalts
with a message
to the operatorindicatingthe formstype to be used. when printing
spooledprintedoutput, the print writer issues
a message
wheneverthe forms type for the
currentprint stepis differentfrom that of the previousprint step. The response
takento
this message
informsthe print writer if separatorpagesshouldbe printedbetweenjobs
and job steps. see the IBM system/3 Model | 5 User'sGuide to spooling, GC21-7632,for
informationon separatorpages.lf the forms type operandis givenin the START pRT
command,the print writer will print only thosejob stepswhoseforms type matchesthat
givenin the START command. You can startthe print writer with a differentforms
type
by enteringthe sroP PRT command,followedby the START pRT commandwith a
forms type operand.Startingthe print writer without the forms type operandcauses
the
p r i n t w r i t e rt o p r i n t j o b s t e p si n t h e o r d e rt h e y a p p e a or n t h e p r i n t q u e u e .
coPlES: This optionalparameter.
which appliesonly to the job stepin which the
P R I N T E Rs t a t e m e nwt a su s e d a
, l l o w st h e u s e rt o o b t a i n 1 - g g c o p i e so f a j o b s t e p ' s
spooledprintedoutput. lf this parameteris not specified,only one copy is printed.
Whenmorethan one copy is requested.
the print writer continuesto producethe number
of requested
copiesbeforecontinuingto the next stepon the print queue. All copies
p r o d u c e db y t h e p r i n t w r i t e ra l l o wf o r f o r m sa l i g n m e nitf A L I G N - Y E Si s s p e c i f i e dT
. his
parameteris ignoredwhen print spoolingis inactiveor not supportedfor the specified
device.
D E F E R : T h e D E F E Rp a r a m e t ei rs o p t i o n a l , l t i s i g n o r e dw h e np r i n t s p o o l i n gi s i n a c t i v e
or not supported
f o r t h e s p e c i f i e d e v i c e .D E F E R - N Oa l l o w st h e s p o o l i n gu s e rt o b e g i n
printinga job step'sprintedoutput beforethe job stephascompletedexecutionif
the
j o b s t e pi s t h e n e x t s t e pt o b e p r i n t e df r o m t h e p r i n t q u e u e .w h e n
D E F E R - y E Si s s p e c i f i e d ,p r i n t i n gd o e sn o t b e g i nu n t i l t h e j o b s t e ph a sc o m p l e t e de x e c u t i o n .T h e D E F E R
parameterappliesonly to the job stepin which the PRINTERstatementwasreceived.
lf
t h e p a r a m e t ei rs n o t s p e c i f i e dt h
, e s y s t e ma s s u m eDs E F E R - y E S .
A L I G N : T h e A L I G N p a r a m e t ei rs o p t i o n a l .l t a i d st h e o p e r a t o ri n f o r m sa l i g n m e nfto r
spooledprintedoutput. This parameteris ignoredwhen print spoolingis inactiveor not
supportedfor the specifieddevice.WhenALIGN-YESis specified,the printerstopsafter
p r i n t i n gt h e f i r s t l i n et o a l l o wf o r m sa l i g n m e n t A
. m e s s a gi e
sd i s p l a y eo
dn t h e C R Ta f t e r
the first line is printed. The operator'sresponse
to this message
indicatesthat forms are
a l i g n e d( c o n t i n u ep r i n t i n g )o r t h a t t h e l i n es h o u l db e p r i n t e da g a i n( t r y a l i g n m e nat g a i n ) .
l f m o r et h a no n ec o p y i s r e q u e s t e(dC O p l E Sp a r a m e t e ra)n d A L I G N - y E Si s s p e c i f i e dt h, e
p r i n t e rh a l t sf o r f o r m sa l i g n m e npt r i o rt o p r i n t i n ge a c hc o p y . l f A L I G N - N o i s s p e c i f i e d .
the printerdoesnot stop. The ALIGN parameterappliesonly to the job stepin which
the PR INTER statementwasreceived.lf the parameteris not specified.the system
a s s u m eAsL I G N - N O .
Note: lf loggingwasassigned
to the 1403,forms alignmentis doneon the first ocL
statementloggedto the 1403for that job step. For this reason,loggingto the 1403
s h o u l db e s u p p r e s s ewdh e nA L I G N - y E Si s u s e d .

1€6

P R I O R I T Y : T h e P R I O R I T Yp a r a m e t ei sr o p t i o n a l .A p r i o r i t yc a n b e a s s i g n etdo a j o b
s t e pt o i n d i c a t ei t s o r d e ro f p r i n t i n go n t h e p r i n t q u e u e .P r i o r i t y0 i n d i c a t eas p r i o r i t y1
j o b s t e pt h a t i s t o b e h e l do n t h e p r i n t q u e u eu n t i l r e l e a s evdi a a n o p e r a t o cr o n t r o l
c o m m a n d .( S e eA p p e n d i xC f o r a s u m m a r yo f o p e r a t o cr o n t r o lc o m m a n d s . P
) r i o r i t y5 i s
the highestpriority that can be assigned.lf this parameteris not specified,the priority
of the iob at the time of executionis assigned
to the job stepson the print queue. This
parameteris ignoredwhen print spoolingis inactiveor not supportedfor the specified
d e v i c e .T h e P R I O R I T Yp a r a m e t earp p l i e so n l y t o t h e j o b s t e pi n w h i c ht h e P R I N T E R
statementwasused.
CLOSE: Thisoptionalparameteris usedto groupmultipleprint stepsof a job underone
s t e p n a m el.f C L O S E - N O
i s s p e c i f i e dn,o p r i n t s t e p sa r ec l o s e da t e n d o f s t e p ,o n l y a t e n d
of job. lf CLOSE-YESis specified,a print stepis closedat end of step. lf the parameter
is not specified.CLOSE-YESis assumed.The CLOSEparameteris ignoredwhen print
s p o o l i n gi s n o t a c t i v e .
s r i n t s t e ps p e c i f i e C
l f a p r e v i o up
d L O S E - N Oa, P R I N T E Rs t a t e m e nwt i t h a n A L I G N ,
C O P I E SD
, E F E R ,F O R M S N OP, R I O R I T Y ,o r O C O P Yp a r a m e t ei rs i g n o r e da n dc a u s easn
informationalmessage
to be issued.
QCOPY: This optionalparameter(OCOPY-NO)is usedto preventthe spoolfile copy
p r o g r a mf r o m c o p y i n ga j o b s t e pt h a t i s o n t h e p r i n t q u e u e .O C O P Y - Y E a
Sl l o w st h e
spoolfile copy programto copy the job step. lf the parameteris not specified.
O C O P Y - Y E iSs a s s u m e d .
T h e O C O P Yp a r a m e t earp p l i e so n l y t o t h e i o b s t e pi n w h i c ht h e P R I N Ts t a t e m e ni ts
included.
SpoolingConsiderations

You can changeyour systemprint devicein a spooledjob stream;however,if the new
deviceis the 3284, printedoutput for the systemprint device(for example,from the
o v e r l a yl i n k a g ee d i t o ro r l i b r a r ym a i n t e n a n cper o g r a m i)s n o t p l a c e do n t h e p r i n t q u e u e .
To resumespoolingof this printedoutput, you mustchangethe systemprint deviceback
to the 1403.
W h e na P R I N T E Rs t a t e m e nits e n c o u n t e r eadn d p r i n t e ro u t p u tf o r t h e j o b s t e pi s b e i n g
s p o o l e dt.h e e f f e c to f t h e C O P I E SD
, E F E R .A L I G N a n d / o rF O R M S N Op a r a m e t e ri s
d e l a y e du n t i l t h e p r i n t w r i t e ri s r e a d yt o p r i n t t h e o u t p u t .

PRINTER Statement

1-87

Function

The PUNCHstatementenablesyou to definethe systempunchdevicefor the partition
in which the statementwasreceived.
The new systempunchdeviceremainsin effect until changedby anotherPUNCHstatem e n to r u n t i l a n o t h e rI P L o c c u r s .
Duringsystemgenerationof a defaultsystempunchdeviceis established
for each
partition.

Placement

The PUNCHstatementcan be placedanywhereamongthe ocL statements.In a procedure,it must precedethe RUN statement.

Format

i/ PUNCHkeywordparameters

Contents

The keywordparameters
are asfollows:
D E VI C E - d e v i c e
CARDNO-nnn
COPIES-nn
D F F F 'R -J E
I
lNo I
oenpY- .{ YES I

)No (

DEVICE: This parameteris optionaland can be any of the following:

1-88

MFCUI

Primaryhopperot the 5424

MFCU2

Secondaryhopperof the 5424

1442

1442 Card ReadPunch

MFCMI

P r i m a r yh o p p e ro f t h e 2 5 6 0

MFCM2

Secondaryhopperof the 2560

3741

3741 DataStation/Programmable
Work Station
(not supportedfor punchspooling)

CARDNO: This parameteris optionaland may be usedto inform the operatorwhich
cardtype to usefor output punching.Whenthe punchedoutput is spooled,the card
r ay
t y p e u s e df o r p u n c h i n gc a n b e i d e n t i f i e di n t h e P U N C Hs t a t e m e n tT
. h i sp a r a m e t em
be any combinationof 1 to 3 characters,
exceptcommas,apostrophes,
or blanks. The
C A R D N Op a r a m e t earp p l i e so n l y t o t h e j o b s t e pi n w h i c ht h e P U N C Hs t a t e m e nwt a su s e d .
Whenthe CARDNO parameteris used,the systemhaltsand issuesa message
on the CRT
indicatingthe cardtype to be usedfor the job or job step.
Whenpunchingspooledoutput on a 1442 Card ReadPunchor 2560 MFCM,blankcards
may be insertedbetweendecksto causeall cardsof the deck iust punchedto be fed into
the stacker.On the MFCU,the lastcard is stackedwithout the extra blankcards.
COPIES: This optionalparameterallowsthe userto obtainfrom 1 to 99 copiesof job
step'sspooledpunchoutput. lf this parameteris not specified,only one copy is punched.
Whenmore than one copy is requested,
the END OF PCHSTEPmessage
must be respondedto beforethe punchwriter will start punchingthe next copy. Oncestarted,the
punchwriter punchesthe entirenumberof requested
copiesbeforecontinuingto the next
j o b s t e po n t h e p u n c hq u e u e .T h e C O P I E Sp a r a m e t ei rs i g n o r e dw h e np u n c hs p o o l i n gi s
inactiveor not supportedfor the specifieddevice.The COPIESparameterappliesonly
to the job stepin which the PUNCHstatementwasused.
D E F E R : T h e D E F E Rp a r a m e t ei rs o p t i o n a l . l t i s i g n o r e dw h e np u n c hs p o o l i n gi s
i n a c t i v eo r n o t s u p p o r t e d
f o r t h e s p e c i f i e d e v i c e .D E F E R - N Oa l l o w st h e s p o o l i n gu s e r
to beginpunchinga iob step'spunchedoutput beforethe job stephascompletedexecution (if the job step is the next stepto be punchedfrom the punchqueue). When
D E F E R - Y E Si s s p e c i f i e dp,u n c h i n gw i l l n o t b e g i nu n t i l t h e i o b s t e ph a sc o m p l e t e d
execut i o n . T h e D E F E Rp a r a m e t earp p l i e so n l y t o t h e i o b s t e pi n w h i c ht h e P U N C Hs t a t e m e n t
w a sr e c e i v e d l.f t h e p a r a m e t ei rs n o t s p e c i f i e dt h
. e s y s t e ma s s u m eDs E F E R - Y E S .
QCOPY: This optionalparameter(OCOPY-NO)is usedto preventthe spoolfile copy
programfrom copyinga job stepthat is on the punchqueue. OCOPY-YES
allowsthe
spoolf ile copy programto copy the job step. lf the parameteris not specified,
OCOPY-YESis assumed.
The QCOPYparameterappliesonly to the iob stepin which the PUNCHstatementis
included.
P R I O R I T Y : T h e P R I O R I T Yp a r a m e t ei rs o p t i o n a l .A p r i o r i t yc a n b e a s s i g n etdo a j o b
s t e pt o i n d i c a t ei t s o r d e ro f p u n c h i n go n t h e p u n c hq u e u e .P r i o r i t y0 i n d i c a t eas p r i o r i t y
1 job stepthat is to be held on the punchqueueuntil released
via an operatorcontrol
command. (SeeAppendixC for a summaryof operatorcontrol commands.)Priority 5
is the highestpriority that can be assigned.lf this parameteris not specified,the priority
of the job at the time of executionis assigned
to the job stepson the punchqueue. This
parameteris ignoredwhen the punchspoolingis inactiveor not supportedfor the specif i e d d e v i c e .T h e P R I O R I T Yp a r a m e t earp p l i e so n l y t o t h e j o b s t e pi n w h i c ht h e P U N C H
statementwasusecl.

PUNCH Statement

1-89

Example

l n t h i se x a m p l ep, r i o rt o p u n c h i n gt.h e s y s t e mh a l t sa n d d i s p l a y o
s n t h e d i s p l a ys c r e e n ,
the partition'scARDNo parameter(s0) informingthe operatorthat cardtype b0 is to
be placedin the secondaryhopperof the MFCtJ.
D u r i n gp u n c h i n gn. o c h e c kf o r b l a n kc a r d si s m a d e . l f t h e s y s t e mp u n c hd e v i c ei s
also
the partition'ssysteminput deviceand neitherdeviceis beingusedby spooling,a halt
is
issuedto inform the operatorthat the systempunchdeviceshouldbe readiedfor
punching.
Spooling Considerations

You can changeyour systempunchdevicein a spooledjob stream;however,if the new
systempunchdeviceis not the spooledpunchdevice,punchedoutput from the overlay
linkageeditor and the library maintenance
program,for example,is not placedon the
punchqueue. To resumespoolingof this punchedoutput, you must change
the system
punchdeviceto the devicedesignated
asthe spooledpunchdeviceduringsysremgeneration.
The punchwriter issuesa message
wheneverthe cardtype (cARDNo) tor the current
punchstep is differentfrom that of the previouspunchstep.
when a PUNCHstatementis encountered
and punchoutput for the job stepis being
s p o o f e dt,h e e f f e c to f t h e C O P I E SD
, E F E R a n d l o rC A R D N Op a r a m e t e ri s d e l a y e du n t i l
the punchwriter is readyto punchthe output.

| -90

READERStatement
Function

is calledthe systeminput device.A default
The deviceusedto readOCL statements
for eachpartitionduringsystemgeneration.You can
systeminput deviceis established
usea READER statementif you want to changeyour systeminput device.

Placement

The READER statementmust not come btween the LOAD and RUN or CALL and
RUN. lf you usethe READER statementin a procedure,the systeminput deviceis
changedwhen the statementis processed,
but, OCL statements
are not readfrom the new
systeminput deviceuntil the procedureis completelyexecuted.lf you usethe READER
statementto changethe systeminput device,the deviceyou specifyis usedto read
sourceprograms,
and OCL statements,Therefore,changingthe
control statements,
systeminput deviceaffectsthe placementof sourceprogramsand control statements
as
well as OCL statements.
The READERstatementmust be readfrom the currentsysteminput deviceor a procedure.

Format

// READERcode (systeminput device)

Contents

Codesfor the systeminput devicecan be asfollows:

SpoolingConsiderations

Code

Meaning

CONSOLE

CRT/keyboard(canbe sharedby partitions)

MFCUl

Primaryhopperof the 5424

MFCU2

Secondaryhopperof the 5424

MFCMI

Primaryhopperof the 2560

MFCM2

Secondaryhopperof the 2560

1442

1442 Card ReadPunch

2501

2501 Card Reader

3741

Work Station
3741 DataStation/Programmable

You may changeyour systeminput devicein a spooledjob stream;however,if the new
for
systeminput deviceis differentfrom the spooledinput device,jobs arenot scheduled
jobsfor executionfrom the
executionfrom the readerqueue. To resumescheduling
readerqueue,you must changethe new systeminput devicebackto the systeminput
devicethat is acceptingspooledinput.

READER Statement

1-91

Function

The RUN statementindicatesthe end of the ocL statements
for a job step. trf1gyths
systemreadsthe RUN statement,it executesthe programspecifiedon the LOAD statement or callsthe procedurespecifiedon the CALL statement.

Placement

A RUN statementis neededfor eachof the programsyou want the systemto run. In
the
job stream.it must be the laststatementwithin eachof
the setsof OCL statements
for
your job steps. lt can alsobe the last OCL statementin a procedure.(For
more informa.
tion about procedures,seeProceduresin part 2.)

Format

// RUN

Contents

None (commentsmay be enteredafter the blankfollowing RUN)

Spooling Considerations

None

1-92

SWITCHStatement
Function

The SWITCHstatementallowsyou to modify the externalindicatorsfor the partitionin
to eachpartition.
which the statementwasreceived.Eightexternalindicatorsareassigned
your
programs
you
from an
Externalindicatorsallow
to influencethe executionof
partition,
aresetoff during lPL.
externalsource.The eightexternalindicators,for each
p
a
r
t
i
t
i
o
n
,
i t r e m a i n so n u n t i l o n eo f t h e
l f a S W I T C Hs t a t e m e nste t sa n i n d i c a t o o
r n in a
f o l l o w i n go c c u r s :
.

AnotherswlTCH statementsetsit off.

o A JOB statementis receivedin the partition.
o A /. statementis receivedin the partition,in job mode.
o A n I P L i s p e r f o r m e da g a i n .
Placement

The SWITCHstatementcan be placedanywhereamongthe OCL statements.Only one
SWITCHstatementis allowedbetweenthe LOAD or CALL and RUN statements.

Format

// SWITCHindicator-settings

Contents

parameteris a codethat consistsof I characters,
Indicator-settings:
The indicator-settings
one for eachof the eightexternalindicators.The first, or leftmost,charactergivesthe
settingof externalindicator1; the secondcharactergivesthe settingof externalindicator
2 ; a n ds o o n .
The codemust alwayscontain8 characters.For eachexternalindicator,one of the
followingcharacters
must be used:
Character

Meaning
Set the externalindicatoroff.
Setthe externalindicatoron.
Leavethe externalindicatoras it is.

SWITCH Statement

1-93

Example

T h e c o d e1 X 0 11 O X Xw o u l dc a u s et h e f o l l o w i n gr e s u l t s :
External
Indicator

Spooling Considerations

't-94

Result

1

Set on

2

Unaffected

3

Set off

4

Set on

5

Set on

6

Setoff

7

Unaffected

8

Unaffected

None

/& Statement
Function

/& statements
areusedas a precautionary
measure.Placedat the end of your OCL for a
job step,a /& statementsignalsthe systemthat OCL statements
for a new job dtep
arecoming. lt preventsOCL for the next job stepfrom beingreadas a part of the precedingsetof statements
or data. Any attemptto readmoredatafrom that devicewill
be blocked. This statementterminatesa stepmodeflush.

Placement

/& statements
arenot required. lt is recommended.
however,that you usethem asthe
laststatementin eachof the setsof OCL statements
for your programs.They are not
allowedin a procedure.

Format

/&

Contents

None (Commentsmay be enteredstartingin column 3; however,this statementrequires
specialconsideration
when usedwith the copy/dumpprogram($COPY). For more
information regardingthesespecialconsiderations,refer to Card lnput Considerations,
under Copy/Dump Programl.

SpoolingConsiderations

None

/& Statement

1-95

T h i ss t a t e m e nits a j o b s t r e a md e l i m i t e trh a t h a st h e f o l l o w i n g
t h r e ef u n c t i o n s :
A /. actsasa delimiterbetweenjobs. rt causesend of job
and preventsthe readingof
more OCL for the job.
With spoolingactive,two consecutive
/. statements
indicatethe end of the spooledinput
job stream.
With spoolinginactive,this statementcan be usedto end job
modeand returnto step
mode. lt causes
end of job in the partition in which the statementwasreceived.
Placement

How this statementis useddetermineswhereit is placedin job
a
stream(seeexamples).
It is not allowedin a procedure.

Format
Contents

None (commentsmay beginin position3.)

SpoolingConsiderations

Two consecutive
/. statementsmust be usedto indicatethe end of the spooledinput job
slream.
A /. statementmay be usedto derimitjobs in a job stream.
when a job beingpracedin
the readerqueueis not delimitedby a /. statement,the input
spoolingroutinegenerates
a /' statementasthe laststatementfor the job in the gueue.
This statementmay contain
extraneous
characters
followingthe /. whenthe systemhistoryareais displayedor
printed,or whenthe statementis loggedon the log
devicefor the partition.
some systemserviceprograms($coPY for example)do not recognize
a /. statementwith
commentsor extraneouscharacters
asan end of file indicatorunlessthe statementis read
from the systeminput device.Also, because
/. statementsin the readerqueuemay have
extraneous
characters
followingthe /. delimiter.theseprogramsshouldnor attempt
to
readdatafrom the readerqueueunlessthe spooledreader
is alsothe systeminput device
for the partition in which that programis executing.

1-96

The followingexamplesshowhow the /. statementcan be used.
l.

Whenusedasa delimiterbetweenjobs:
/ / J O B 1J O B
/ / S T E P AL O A D P R O G A , R l
// RUN
Data
/&
/ / S T E P BL O A D P R O G B , R l
// RUN
Data
/&
/.

This indicatesthe end of JOBI and preventsthe readingof more OCL for
J O B l . l f a n y j o b s t e p si n J O B l h a d b e e nc a n c e l e dt h, e / . i n d i c a t etsh e e n d o f
the job. lf this statementwerenot in a job stream.the followinginvalidJOB
statement,the LOAD statement,and all other statements
up to the next /. or
validJOB statementwould havebeenreadas part of the OCL for JOBl.
//JAB2JOB
/ / S T E P AL O A D P R O G C , R l
// RUN

2.

Whenusedto indicateend of spooleddata:
//JOBl JOB
/ / S T E P AL O A D P R O G A , R I

I

// RUN
Data

t&
/ / S T E P BL O A D P R O G B , R l

I

// RUN
Data

//JOB2 JOB
/ / S T E P AL O A D P R O G C , R l
// RUN
Data
l&
/ / S T E P BL O A D P R O G D , R l
(
I

// RUN
Data
/*
I
I
','
I Indicatesend of spooledinput
t.

I

/. Statement

1-97

3'

when usedto end job modeand returnto step
mode (nonspoored
systemsonry):
/ / J O B I J O B S P O O L - N O , P A R T I T I O N . l , CE
O.R
I2
/ / S T E P AL O A D P R O G A . R l
(
I

// RUN
Data

/&
/ / S T E P BL O A D P R O G B , R l

I

// RUN
Data
/.
Endsjob mode. Beginstepmode.
// LOADPROGC,Rl
// RUN

*(Comment) Statements
Function

Commentstatements
arecommonlyusedto explainthe jobs or givethe operatorinstructions. A commentstatementcan alsobe usedto causea secondrecordto be written to
the SHA followingthe comment. This record,calleda time stamp,containsthe system
dateand the time of day (if timer supportwasgenerated).Commentstatements
are
printedalongwith the other OCL statements.

Placement

You can include,amongOCL statements,
specialstatements
that containonly comments.
C o m m e n st t a t e m e n tm
s u s tc o n t a i na n a s t e r i s k( * ) i n c o l u m n1 . l f y o u i n c l u d et h e w o r d
T I M E w i t h a n " ( * T I M E ) ,t h e s y s t e mw r i t e st h e c o m m e n ts t a t e m e npt l u sa t i m e s t a m pi n
the systemhistoryarea.
Commentstatements
can be placedanywhereamongthe OCL statementsin eithera job
streamor a procedure.Commentstatements
are neverdisplayedon the CRT but are
printedif LOG is assigned
to a printer (1403 or 3284\ tor the partitionin which the
commentstatementwasusedand the printer is not allocatedto a partition.

Format

*

Contents

The commentcan be any combinationof wordsand characters.The requirements
are
t h a t t h e a s t e r i s k( * ) b e i n c o l u m n1 , a n d i f s p e c i f i e dT, I M E m u s ts t a r ti n c o l u m n2 .

c o m m e n to, r * T I M E c o m m e n t

The followingexampleshowsthe format of the *TIME statementand the time-stamp
recordas it appearsin the SHA.

o 22
@
o
o

* T I M E C O M M E NFTR O MP A R T I T I O N2
04/26/78 00.00.54

This statementwasgenerated
by the user.
This statementwasinsertedinto the SHA by the system.

SpoolingConsiderations

None

*(Comment) Statements

1-99

The /* statementis not a true ocL statement
but is usedto indicatethe end of a data
file.
Placement

one /* shouldbe usedasthe rastcardof an input
datafire or programdeck. with the
exceptionof card utilities,two consecutive
/* statements
wilr causean error message.

Format
Contents

None (Commentsmay be enteredstartingin
column 3; however,this statementrequires
specialconsideration
when usedwith the copy/dumpprogram($COpy).
For more infor.
mation regardingthesespecialconsiderations,refer
to Card lnput considerations,under
Copy/Dump Program.l

Spooling Considerations

None

1-100

Part2. System Concepts and Facilities

P a r t 2 . S v s t e m C o n c e p t sa n d F a c i l i t i e s

2-1

2-2

ProgramFacilities

Systemcontrol and serviceprogramsenablethe userto
servicethe programlibraries,datafiles,applicationprog r a m s . a n d i n p u t / o u t p u t u n iFt so.l l o w i n g a r e s o m e tohf e
l
5
p
r
o
g
r
a
m
m
i
n
g
s
u
p
p
o
r
t
i
n
c
l
u
d
e
s
s
y
s
t
e
m
System/3Model
(PP).
programsincludedin this group:
(SCP)
products
program
programming
and
control
Thesefacilitiesallow a userto prepareand maintaindisks
o Library
Allows the userto produce,main'
for the
and tapes,and performbasicfunctionsnecessary
tain, and servicethe sourceand
Maintenance
operationof a system.
objectprogramlibraries
programsand
SCPconsistsof disk systemmanagement
o Copy/Dump
Supportsf ile-to'fileand volume-tosystemcontrol and serviceprogramsthat are fundamental
volumecopies
of the system. Disk
to the operationand maintenance
providesits supportthroughthe
systemmanagement
o F i l ea n d V o l u m e
D i s p l a y si n f o r m a t i o na b o u tt h e
following:
contentsof a disk
LabelDisPlaY
o Initial Program
Startsoperationof the systemby
o File Delete
Deletesdatafilesfrom a disk
loadingthe supervisorinto storage.
Loader

SYSTEM/3MODEL 15 PROGRAMMINGSUPPORT

.

Supervisor

o Scheduler

Controlsoverallsystemoperations
and providesgeneralfunction
requiredby the schedulerand all
programs.
processing

to satisfy
The followingprogramproductsare available
specificapplicationrequirements:

Initiatesthe executionof eachnew
programand establishes
the system
f a c i l i t i e sw h i c ha r et o b e e v o k e d
while that programis running.

o SubsetANS COBOL

o RPG ll

o F O R T R A Nl V
o BasicAssembler

o Spool

unit depenReducesprocessing
denceon the relativelyslow speeds
of unit recordinput/outputdevices,
and reducescontentionfor the
devices.

o Disk Sort
o TapeSort
o CCP/DiskSort

o Data
Management

Providesroutinesto interface
betweena userprogramand the
requireddatafiles. lnterfacesare
providedfor fileson disk,tape,
cards.or diskette,and for the
p r i n t e r ,C R T , B S C A ,o r S I O C ;a l s o ,
method
access
a device-independent
is supported.

o Card Utilities

ProgramFacilities

2-3

PROGRAM CONCEPTS
Any set of user instructions for processing
data must go
through severalphasesbefore it
can be ,rlo Lv the system
to actually processdata. User_written
instructions form a
source program; the source program
is processedby a
languagetranslator to form an
object module; the object
module is formatted by the overlay
linkage editor into a
load module; the load module
can be executed by the
system. The following discussion
describesthese steps
in greater detail.

Job stream for compiling a sourceprogram punched
in
cards.

SOURCE
DECK

Source Programs
A source program is a set of user instructions
that can be
compiled and used for processingdata.
To write a source
program, a user must analyze
the input data, decide what
must be done to it, and determine
the format of the
output.

// FtLE *
// FILE
// LOAD -

After this analysis,the user writes
instructions according
to the conventions of a programming
language(such as
RPG ll) to processthe data. These
instructions taken
together are called a source program
and the user can punch
it into cards, write it on a diskette,
store it on disk prior
to compilation or assembly,or enter
it into the sysrem
directly from the console/keyboard.

Object Modules
An object module is a source program
converted into
instructions that can be link-edited.
To obtain an object
module, a source program is processed
by a compiler (such
a st h e R P G l l c o m p i l e r ) o r a n a s s e m b l e r .
The resulting
object module contains the necessary
machine instructions
required to perform the desired processing
of data. From
the compiler or assembler,the object
module can be stored
on disk, punched into cards, or written
on a diskette.
The following examplesshow typical
OCL used to compile
source programs.

/y'ote: Depending on
t h e c o m p i l e r u s e d ,m o r e
than two FILE statements
may be required.

Job stream for compiling a source program
located on
rtick in a source library.

// COMPILE

// FttE
// FILE -

// LOAD

+

Note: Depending on the
c o m p i l e r u s e d ,m o r e
than two FILE statements
may be required.

Load Modules
A load moduleconsistsof at leastone objectmodulethat
hasbeenchangedby the overlaylinkageeditor into a
modulethat can be loadedfor execution.
followingthe assem'
is necessary
Linkageeditor processing
bly or compilationof any program.The output of a
or compiler),calledan
language
translator(assembler
run
cannot
be
as
a programuntil it is
module,
object
link-editedinto a load module. Objectmodulesand load
modulescan resideon cards,on diskette,or in an obiect
l i b r a r yo n d i s k .
Obiect
Module

Source
Program

Load
Module

nr

The overlaylinkageeditor providesthe followingfunctions
translators:
for the language

Overlay Linkage Editor
to the language
The overlaylinkageeditor providesservices
translators.The followingsectionprovidesan overviewof
for detailedinformationon the overlay
theseservices;
linkageeditor and its uses,seeIBM System/3Overlay
LinkageEditor ReferenceManual, GC21-7561.
by a useror
The overlaylinkageeditor can be requested
translatorsuchas FORTRAN,
directlyby a language
C O B O L ,R P Gl l , a n d B a s i cA s s e m b l e r .
showhow to load the overThe followingOCL statements
l a y l i n k a g ee d i t o r :
ll
II
II
//

LOAD$OLINK.unit
F I L E N A M E - $ S O U R C E ., . .
F I L EN A M E _ $ W O R K , . . .
RUN

--_l

o Punchesthe objectmoduleinto cards,writesit to a
diskette,and/orcatalogsit into an objectlibraryon disk.
Thesemodulesarealsoreferredto as R modules,
objectprograms.They are
routines,or nonexecutable
that still needto be link'
programsand/orsubroutines
editedinto loadmodules.
o Link-editsthe objectmodule(s)into a loadmodule;
punchesthis loadmoduleinto cards,writesit on
diskette,and/orcatalogsit into an objectlibraryon
disk. Thesemodulesarealsoreferredto asO modules
or objectprograms.They areprogramsand/orsub'
routinesthat can be loadedfor execution.

(Thesetwo F ILE statements,whichare
optional,arestandard
F I LE statementsused
bV the compilers.)

P r o g r a mF a c i l i t i e s

2'5

W h e n t h e o v e r l a y l i n k a g ee d i t o r l i n k - e d i t s
one or more
object modules, it attempts to fit
the resulting toad module
into the user-specifiedprogram
size or the current program
partition size. lf this cannot
b e d o n e , t h e o v e r l a yl i n k a g e
editor assignssome modules to
overlay segments. Main
storagefor an object program
with overraysis divided into
four areas: root area, user overlay
area, system area, and
co-residentarea. Not all programs
need all four areas.
The root area of an overlay program
contains the parts of
the program that are never overlaid.
The root area atways
contains the mainline module, overlay
fetch routine, fetch
table, and transfer vectors. The remaining
parts of the root
area depend on the program being
linked.

T h e u s e r o v e r l a y a r e ac o n t a i n su s e r
m o d u l e st h a t c a l l
system l/O modules. Each overlay (known
as a segment)
loaded into the user overlay area
can contain modules of
different category varues. category
varuesdetermine what
m o d u l e sr e s i d ei n t h e v a r i o u sa r e a s .
lf the COBOL segmentation feature has been used,
the COBOL segments
appear as overlays in the user overlay
area. The presence
of coBoL segmentsforces any non-coBoL
modures that
normally would have been assigned
to the user area to the
root area (category 0).
A system overlay segment contains
system modules with
the same category value. Each system
overlay segment is
independent of other system overlay
segments. System
modules are assignedto overlay ,.gr.ni,
solely by category
v a l u e . A s y s t e mm o d u l e c a n c a l l
o n l y a n o t h e rm o d u l e w i t h
either the same category or a category
0 module. The
co-residentarea is actually a part
of the system overlay
area.

The following example shows overlay areas.

Supervisor
GLOBAL
COMMON
- Mainline
Module
- Categor0
y M o d u l e s( u s e r )
- O t h e rM o d u l e sI n c l u d e d( i f s p a c e
a v ai l ab l e)
- O v e r l a yF e t c hR o u t i n e F
, e t c hT a b l e ,
and TransferVectors

)

i

-*'"'o'
- u,,, O
ou
v e r l a yA r e a

U s e rl / O D e p e n d e nM
t odules

|

su".,.ni;,ms- - -

| - ru*.'rmOverlayArea
SvstemModules
U s e rl / O I n d e p e n d e nMt o d u l e s I

\ -

Co-residentArea

)

in a program
The maximumnumberof overlaysegments
is 254. A storagemap providedby the overlaylinkage
editor indicatesoverlayareaaddresses
and the segments
eachoverlayareacan contain.
arean exampleof a language
The followingOCL statements
the overlaylinkageeditor:
translatorrequesting
$RPGu
, n i t ( u n i t c a nb e R l , F l , R 2 ,
or F2l
C O M P I L E S O UR C E - P R O G l , Ul T
N- u n i t ,
O
O B J E C T - u n i t , A T T RR
-M
FILE
N A M E . $ S O U R C E. ,..
FILE
N A M E . $ W O R K ,. ..
RUN

Memory Besident Overlays
Memoryresidentoverlaysis a techniquedesignedto
of largeoverlayprogramsby
increase
the performance
to remainin main storage
allowingcertainoverlaysegments
after the initial segmentfetch. The two typesof memory
residentoverlayprogramsare MOVE and REMAP,which
differ asfollows:

ll LOAD
//
II
I/
//

o WhenATTR-MOVE (MOVE technique)is specifiedin
the OPTIONSstatementof the overlaylinkageeditor,
the userprogramretainsthe segmentin the resident
areabut executesthe segmentin the conventional
overlayfetch area.
o W h e nA T T R - M R O( R E M A Pt e c h n i q u ei)s s p e c i f i e idn
the OPTIONSstatementof the overlaylinkageeditor,
the programexecutesthe segmentsin the residentarea
itself.

ProgramFacilities

2-7

The ATTR parameteris to be used
only with toadmodules;
the M RO and MOV programattributes
will not be attached
to R modules(nonexecutable
objectprograms).
For more information, seelgM System/3
OvertayLinkage
Editor ReferenceManual, GC21-7561.
To be used,the memoryresidentoverlay
featuremust be
selectedas an option duringsystemgeneration.
However,
load modulesmay be link_edited
with this attributeon
any system.
The overlayfetch routinegenerated
for the MOVE tech_
niqueis identicalto the fetch routinegenerated
for
conventiOnal
overlayprograms.
The CATEGORy statementcontrols
which overlaysegmentsarecandidates
for memoryresidentovertays.Any
overlaysegmentcontaininga category
125 modureis not
a candidatefor memoryresidence.
With the two memory residentoverlay
techniques(MOVE
and REMAP),largeprogramscan reside primary
in
srorage
throughoutexecutionif the partition is
largeenoughand
if the programcan be link-editedwithin
thJ maxamum
programsize. Thesetechniques
may improveperformance
for overlayprogramsthat requirea large
numberof overlay
fetches.
The REMAPtechniquerequiresthat the
overlaysegments
be link-editedto 2K boundaries.The
MOVE technique
doesnot havethis restriction.For large
overlaysegments,
REMAPgenerallyexecutesfasterthan
MOVE.
Throughputdegradation
for memoryresidentoverlay
programswith RLDs (relocation
dictionaryrecords)is not
assevereas for conventionaloverlayprograms
with RLDs,
because
eachresidentoverlaysegmentis relocated
only
the first time it is fetchedfrom disk.

P R O G R A MA N D P A R T I T I O NS T Z E S
Programsizeis the amountof main storage(excluding
externalbuffer requirements)
requiredfor a programto
execute.Partitionsizeis the amountof
main srorage
available
for executinga program. programand partition
sizesarerelateditemsbecause
the partitionsizemust be
targeenoughto accommodate
the program.Whenthe
programsize(plusexternalbuffer
requirements)
is larger
than the partition,eitherthe partitionsize
can be increased
or the programcan be structuredwith overlays.
The partitionsizesthat bestmeetthe needs
of an installation dependupon suchfactorsasthe total
amountof
storageavailable,
the sizeand characteristics
of the user
programs,their balanceamongjob
streams,and the operat_
i n ge n v i r o n m e n t .
Partitionsizesarespecifiedin 2K increments;
the minimum
sizein which to executea programis gK.
Thereis no
upperlimit, exceptasdeterminedby the
system.The
maximumprogramsizeis 4g-56K. A program
ro execute
underCCPcan rangefrom 4K to 32K.
The maxrmum
programsizeis dependenton the
systemconfiguration
chosenduringsystemgeneration.Generally,
the more
systemgenerationoptionsselected.
the smallerthe maximum programsize. For example,the maximum
configuration that alsoincludesCCp allowsonly 4gK programs;
whereasthe minimumsystemconfiguration.
without CCp,
supports56K programsize. Also,canceling
spoolcan
potentiallyincrease
the maximumallowedprogramsize
by one 2K increment.The increased
sizeallowsmore
programsto run without overlaysand,
therefore,may
reduceexecutiontime.
Sincepartitionsizesarespecifiedin 2K increments,
care
must be takenwhen a programis changed. program
A
size
exceeding
a 2K boundaryby as little as I byte requires
the
partitionsizeto increase
another2K. Seethe following
example:

ProgramSize

28

Partition Size

Originalprogram

8,100 bytes

8K

Changedprogram

8 , 1 9 3b y t e s

10K

P a g eo f G C 2 1- 5 1 6 2 - 1
lssued 28 SePtember 1979
By TNL: GN21-5674

T h e p a r t i t i o ns i z ei s i n i t i a l l ys e td u r i n gs y s t e mg e n e r a t i o n ;
laterit may be resetwith a SET command.The program
sizecan be specifiedby the usereitherwhen writing a
program(viaprogramming
language
specifications)
or when
l i n k - e d i t i ntgh e p r o g r a m( v i at h e C O R Ep a r a m e t eorn t h e
O P T I O N Ss t a t e m e n t ) .
The DISPLAYSTATUScommandprovidessysteminform a t i o no n t h e C R T . l n c l u d e di n t h i s i n f o r m a t i o na r et h e
p a r t i t i o ns i z e s .T h e d i s p l a ya l s op r o v i d e tsh e m a x i m u m
programsizethat can be executedon that particular
system.

E X T E R N A LB U F F E R S
An externalbuffer is an arealocatedoutsidethe user
programbut within the userpartition. An externalbuffer
containsthe disk buffersfor the userprogram.Whena
externalbuffersduringcompilation,
userprogramrequests
the disk buffersaremovedout of the userprogramarea
and locatedafter the lastuserprogrambyte. Thesedisk
buffersare now locatedbetweenthe end of the program
of data in these
and the end of the partition. Processing
buffersis done in movemode. This removalof disk buffers
from the root areasof a programallowsmoreexecutable
codeto be includedin the root area. This can havethe
effectof increasing
the maximumprogramsize.

GreaterThan 48K Programs
DISPLAYSTATUSon the systemdisplayscreenspecifies
t h e m a x i m u mp r o g r a ms i z ea v a i l a b l(eM A X P R O GS I Z E=
X X K ) . P o s s i b lvea l u e sa r e4 8 K , 5 0 K , 5 2 K , 5 4 K , o r 5 6 K
depending
on the optionschosenduringsystemgeneration.
The usercan directthe overlaylinkageeditor to generate
a l o a dm o d u l ew i t h a s p e c i f i e m
d a x i m u ml i m i t ;t h i s
i n f o r m a t i o n( o b j e c ct o r es i z e )i s s p e c i fe da sf o l l o w s :
RPG
FORTRAN
COBOL
$OLINK

Externalbuffersaresupportedby System/3COBOL,
F O R T R A N ,R P Gl l . a n d B a s i cA s s e m b l e rE
. x t e r n abl u f f e r s
asfollows:
arerequested

o coBoL

R P Gc o n t r o lc a r d( H )
C O R Es t a t e m e n t
aragraph
O B J E C T - C O M P U T EpR
O P T I O N Sc o n t r o ls t a t e m e n t

T h e v a l u es p e c i f i e sdh o u l dn e v e rb e l a r g e tr h a nt h e m a x i p r o g r a ms i z e( 4 8 K - 5 6 K ) .l f t h e d e s i r e d
mumallowable
e x e c u t i o ns i z ei s n o t s p e c i f i e dt h, e o v e r l a yl i n k a g ee d i t o r
a s s u m et sh e c u r r e n tp a r t i t i o ns i z e( u s e df o r c o m p i l a t i o n /
a s s e m b l yo)r 4 8 K , w h i c h e v eirs l e s s .
t d d r e sosf X ' 4 0 0 0 's h o u l db e s p e c i f i e idn t h e
A l i n k - e d ia
C O M P I L Es t a t e m e n(tL I N K A D D )f o r a l l p r o g r a mtso b e
sefault
e x e c u t e di n a p a r t i t i o n( t h i si s t h e c o m p i l e r ' d
value). lf the programis to run asa CCPtask,X'8000'
s h o u l db e s p e c i fe d . ( M a x i m u mp r o g r a ms i z ef o r C C P
t a s k si s 3 2 K . )

EXTBUF and
Two parameters,
on the
N O E X T B U F a, r es u p p o r t e d
PROCESS
statement.EXTBUF provides
e x t e r i r abl u f f e r sf o r a l l d i s kf i l e s ;
N O E X T B U Fp r o v i d e sb u f f e r sw i t h i n t h e
p r o g r a m .N O E X T B U Fi s t h e d e f a u l t .
i nsu s i n gt h e
F o r f u r t h e rc o n s i d e r a t i o n
S A M E A R E Ac l a u s ew i t h E X T B U F ,s e e
IBM System/3SubsetAl/S COBOL
Reference Man ual, GC28-6452.

o F O R T R A N Two parameters.
EXTBUF and
on the
a
r
e
NOEXTBUF, supported
*PROCESS
E
X
T
B U Fp r o statement.
f
o
r
d
i r e c td i s k
b
u
f
f
e
r
s
a
l
l
v i d e se x t e r n a l
p
r
o
v
i
d
e
s
b
u
f f e r sw i t h i n
f i l e s ;N O E X T B U F
p
r
o
g
r
a
m
.
i
s
t
h
edefault.
N
O
E
X
T
B
U
F
the
i nsu s i n g
F o r f u r t h e rc o n s i d e r a t i o n
E X T B U Fa n dS H R B U F Fs, e eI B M
System/3FORTRAN lV Reference
Manual,SC28-6874.
O R P GI I

A n E i s s o e c i f i e idn c o l u m n4 8 o f t h e
to provideexternal
HeaderSpecification
b u f f e r sf o r a l l d i s kf i l e s ;n o t s p e c i f y i n g
an E in column48 providesbufferswithin
the program.The defaultis no external
buffers.

P r o g r a mF a c i l i t i e s

2-9

P a g eo f G C 2 1 - S 1 6 2 - 1
lssued 28 September 1979
By TNL: cN2t -b674

.

Basic
Assembler

T h e p a r a m e t e rX
s ,B U F - na n d N O X B U F .
a r es u p p o r t e d
o n t h e O p T I O N Ss t a t e _
m e n t ;n i s a o n e "t o f i v e _ d i gdi te c i m a l
n u m b e rs p e c i f y i n tgh e s i z eo f t h e
external
b u f f e rr e q u i r e d .N O X B U Fi s t h e
default.

External buffers are intended for
very largeprograms that
previously required a severe
reduction in the disk buffer
s i z e st o e n a b l ep r o g r a m st o f i t
within a partition. Specifying external buffers for these programs
..n irnfrou. purformance becauserargerbuffers
can be utirized. smarl
programs,however, may
experienceperformance degrada_
tion-due to the extra processtng
required for external
buffers. The maximum size for
external buffers is 64K.
Therefore, as an example, a 56K program
plu, OqK ot
e x t e r n a lb u f f e r s w o u l d r e q u i r e p a r t i t i o n
a
s i z eo f 1 2 0 K .

2-10

File Facilities
FILE DEFINITION
A file is a collection of related records to be treated as a
u n i t a n d c o n t a i n e do n c a r d s ,d i s k , d i s k e t t e ,t a p e , p r i n t e r ,
B S C A .o r S I O C .
T h i s c h a p t e rd e s c r i b e sf i l e o r g a n i z a t i o na n d p r o c e s s i n gi n
g e n e r a l .T h e s es u b i e c t sa r e d i s c u s s e di n g r e a t e rd e t a i l i n
the IBM System/3 Disk Concepts and Planning Guide,
GC21-7571, and IBM System/3 MalTnetic Tape Program
Planning Manual, GC21-5040. For more information on
f i l e p r o c e s s i n gw i t h r e s p e c t o p r o g r a m m i r r gl a n g u a g e ss,e e
IBM System/3 RPG ll Reference Manual, SC21-7504,
IBM System/3 ANS COBOL Reference Manual, GC28-6452,
and tBM System/3 FORTRAN lV Reference Manual,
sc28-6874.

R e c o r d sa r e a s s i g n e ds p e c i f i cl o c a t i o n s ,i n d e p e n d e n to f t h e
o r d e r t h e y a r e p u t i n t o t h e f i l e ' A u s e rd e f i n e d c o n t r o l
f i e l d o n t h e r e c o r d d e t e r m i n e st h e r e c o r d ' ss p e c i f i cl o c a t i o n
in the file. Therefore, recordscan actually be scattered
t h r o u g h o u t t h e f i l e , d e p e n d i n go n t h e c o n t r o l f i e l d . U n u s e d
r e c o r d l o c a t i o n sc o n t a i n b l a n k s .

File Processing
F i l e sc a n b e p r o c e s s e db y t h r e e b a s r ct n e t h o d s : c o n s e c u t i v e ,
s e q u e n t r a la, n d r a n d o m .
The consecutivemethod processesrecords in the order in
w h i c h t h e y p h y s i c a l l ya p p e a ri n a f i l e ' T h e c o n s e c u t r v e
m e t h o d c a n b e u s e df o r s e q u e n t i a l i,n d e x e d ,a n d d i r e c t
f i l e s . T h e c o n t e n t s o f s p a c e sl e f t f o r m i s s i n gr e c o r d si n
d i r e c t f i l e s a r e r e a d a s b l a n k r e c o r d s . R e c o r d sa r e r e a d
u n t i l e i t h e r t h e e n d o f t h e f i l e i s r e a c h e do r t h e p r o g r a m
t e r m i n a t e st h e r e a d i n go f r e c o r d s .

File Organization
T h r e e t y p e s o f f i l e o r g a n i z a t i o n sa r e d e f i n e d b a s e do n t h e
a r r a n g e m e n ot f t h e r e c o r d sw i t h i n r af i l e : s e q u e n t i a l ,
i n d e x e d ,a n d d i r e c t .
Asequential file is a file in which the position of a record
is determined by the order in which records are put in the
f i l e . F o r e x a m p l e .t h e t e n t h r e c o r d p u t i n t h e f i l e o c c u p i e s
t h e t e n t h r e c o r d p o s i t i o n . F i l e s o n c a r d s ,d i s k e t t e ,a n d
t a p e a r e a l w a y ss e q u e n t i a fl i l e s ;d i s k f i l e s m a y b e s e q u e n t i a l
f i Ie s .
An indexed file is a disk file in which the location of a
record is stored in a separatebut adjacent portion of the
f i l e c a l l e da n i n d e x . T h e i n d e x h a s a r e c o r d k e y a n d r e c o r d
l o c a t i o n f o r e v e r y r e c o r d c o n t a i n e r li n t h e f i l e ' A n i n d e x
e n a b l e sa p r o g r a m t o p r o c e s so n l y r e q u i r e dr e c o r d s ;i t i s
not necessaryto accessall the records of the file.
/ V o f e . ' I n d e x e dp r o c e s s i n gi s n o t a l l o w e d o n t h e s i m u l a t i o n
areasof the 3340 and 3344.
l isk f ile in which records
A d i r e c t f i t e i s a t y p e o f s e q u e n t i ad
a r e a s s i g n e ds p e c i f i cr e c o r d p o s i t i o n sb y t h e u s e r . D i r e c t
gny record ln the file
f i l e o r g a n i z a t i o ne n a b l e sa c c e s s i n a
w i t h o u t e x a m i n i n go t h e r r e c o r d so r s e a r c h i n ga n i n d e x .

Sequential processingapplies only to indexed f iles' When
a n i n d e x e df i l e i s p r o c e s s e ds e q u e n t i a l l yt, h e r e c o r d k e y s
a r e o r o c e s s e do n e a f t e r a n o t h e r i n a s c e n d i n go r d e r . l f t h e
recorclsare not in order in the file, they can be processed
i n o r d e r b y m e a n so f t h e k e y s i n t h e f i l e i n d e x . T h e r e a r e
t w o w a v s t o s e q u e n t i a l l yp r o c e s sa n i n d e x e df i l e : b y k e y
a n d w i t h i n l i m i t s . S e q u e n t i a l - b y - k epy r o c e s s eas l l r e c o r d s
i n t h e o r d e r o f t h e i r k e y f i e l d s . P r o c e s s i n cgo n t i n u e su n t i l
a l l r e c o r d sh a v e b e e n r e a d o r t h e p r o g r a m t e r m i n a t e st h e
p r o c e s s i n g .S e q u e n t i a l - w i t h i n - l i m i tasl l o w s a s e c t i o no f t h e
f i l e ( g r o u p o f r e c o r d s )t o b e p r o c e s s e d .E a c h s e c t i o n i s
i d e n t i fi e d b v l o w e r l i m i t ( s t a r t i n g )a n d u p p e r l i m i t ( e n d i n g )
record keys.
f f o f e : C O B O L s u p p o r t sl o w e r l i m i t p r o c e s i n g o n l y ' t h e
u p p e r l i m i t m u s t b e p r o v i d e dw i t h i n t h e C U B O L p r o g r a m '
Random processingallows disk records to be processedin
a n o r d e r e d o r u n o r d e r e dm a n n e r ;a p a r t i c u l a rr e c o r d c a n
b e p r o c e s s e di n d e p e n d e n t l yo f i t s r e l a t i o nt o o t h e r r e c o r d s '
Sequentiaa
l n d d i r e c t f i l e sc a n b e p r o c e s s e dw i t h a r e l a t i v e
r e c o r d n u m b e r t o i d e n t i f y t h e r e c o r d . T h e r e l a t i v er e c o r d
n u m b e r i n d i c a t e st h e p o s i t i o n o f t h e r e c o r d w i t h i n t h e f i l e
i n r e l a t i o nt o t h e b e g i n n i n go f t h e f i l e . l t i s n o t a d i s k
a d < J r e sbs u, t a p o s i t i v e ,w h o l e n u m b e r t h a t i s c o n v e r t e db y
d i s k d a t a m a n a g e m e n t o t h e d i s k a d d r e s so f t h e r e c o r d '

F r fe F a c r l r i l c s

z.l

I

The relative record numbers can
be contained in an
A D D R O U T f i l e ( r e c o r da d d r e s sf i l e )
c r e a t e db y t h e D i s k
S o r t p r o g r a m . A D D R O U T f i l e sa r e
c o m p r i s e do f b i n a r y
3-byte relative record numbers that
indicate the relative
position of records in the file
to be processed. To process
indexed f iles randomly, the user
must use the record keys
in the file index to identify the records.

c a n n o t b e u s e df o r
any other file until the file delete program
has deleted the
f i l e . l f t h e u s eo f a f i l e i s n o t s p e c i f i e d
when created,
the file is classifiedas temporary. A temporary
file can be
c h a n g e dt o a p e r m a n e n tf i l e o n l y i f t h e f i l e
name ischanged
a n d i t i s c o p i e d a s a p e r m a n e n tf i l e .

File Creation

The output file is scratchedat end of job
step (just as if
R E T A I N - S h a s b e e n s p e c i f i e df o r t h e o u t p u t
FILE state_
ment) when all of the following conditions
exist:

D a t a i s p l a c e di n a f i l e a c c o r d i n gt o u s e r
s p e c i fi c a t i o n s .
W h e n d i s k o r t a p e f i l e sa r e c r e a t e d , F I L E
a
s t a t e m e n tf o r
e a c hf i l e m u s t b e i n c l u d e d i n t h e O C L
for the program.

o A p a c k c o n t a i n i n ga n i n p u t f i r e
i s n o t o n r i n ea t t h e s t a r t
o f t h e j o b ( d e f e r r e dm o u n t ) .

W h e n c r e a t i n ga d i s k f i l e . t h e F I L E s t a t e m e n t
s u p p l i e st h e
n a m e o f t h e f i l e , t h e r e t e n t i o no f t h e
file, the file size,
t h e a r e a ( s i m u l a t i o no r m a i n d a t a a r e a )
to containthe f ile,
a n d ( o p t i o n a l l y )t h e l o c a t i o n w i t h i n
the area.
T h e n a m e g i v e nt o a f i l e i s t h e n a m e p r o g r a m
a
will usein
r e f e r e n c i n gt h a t f i l e . S o m e p r o g r a m s
r e q u i r es p e c i f i cf i l e
n a m e st o b e u s e d ,s u c h a s $ W O R K f o r
compilerwork files.
( F I L E s t a t e m e n td e s c r i p t i o n s p a r t
in
I contain a list of
t h e r e s e r v e df i l e n a m e s . ) S e v e r a vl e r s i o n s
of a file can be
created on the same disk and be given
the same name, but
the date must always be unique. Each
version can be
r e f e r e n c e db y i t s l o c a t i o n ,s i z e ,o r
uniquedate.
The retention of a file is classifiedas
scratch, temporary,
or permanent. A scratch file may be used
only in one job
step and cannot be retrieved after that job
step has ended.
The first time the Model 1S allocatesnew
spaceon a
simulation area that has scratch f iles created
by another
System/3 model, all scratch files are removed.
A message
is issuedbefore removal, allowing the job
step to be
t e r mi n a t e do r c o n t i n u e o .
A t e m p o r a r y f i l e i s u s u a l l yu s e d m o r e t h a n
once;however,
t h e s p a c ec o n t a i n i n gt h e f i l e c a n b e r e u s e d
under one of
the following conditions:
o A F I L E s t a t e m e n ts p e c i f y i n g
s c r a t c hi s l a t e r s u p p l i e df o r
the temporary file. This removesthe file
from the VTOC
( v o l u m et a b l e o f c o n t e n t s l .
Another file with the sameLABEL name
i s l o a d e di n t o
t h e e x a c t a r e ao c c u p i e db y t h e t e m p o r a r y
file; this only
changesthe data. Space and location parameters
are
r e q ui r e d .
The file delete program is used to delete
the file.

2-12

T h e s p a c ec o n t a i n i n ga p e r m a n e n tf i r e

o The output file is to be written
over the input file
(loadto old).
.

R E T A I N - S i s u s e d o n t h e F I L E s t a t e m e n tf o r
the input
f ile.

A n e x i s t i n gt e m p o r a r y f i l e s h o u l d b e r e l o a d e d( l o a d
to old)
with filesof like attributes. lf an existing
i n d e x e df i l e i s
r e l o a d e dw i t h a s e q u e n t i a fl i l e , t h e n e w
d a t a o v e r l a y so n l y
the data portion of the file; the index portion
of the file
r e m a i n si n t a c t b u t u n u s a b l e .
T h e a m o u n t o f d i s k s p a c ef o r a f i l e d e p e n d s
o n t h e s i z eo f
the records,the number of records (both current
and to be
a d d e di n t h e f u t u r e ) , a n d t h e f i l e o r g a n i z a t i o n .
The size of the file can be specified by either
the number
of tracks needed or the approximate number
of records for
the file. When the number of records is given,
the system
calculatesthe required disk space by converting
number
of records to number of tracks.
The total spaceallocated is rounded up to full
tracks,
allowing adequatespace to accommodate at least
the num_
b e r o f r e c o r d si n d i c a t e d . T h i s m e a n st h e f i l e
could hold
m o r e r e c o r d st h a n s p e c i f i e d ,a l l o w i n g a d d i t i o n a l
r e c o r d st o
be added to the file. Therefore, if the copy/dump program
( $ C O P Y ) i s u s e dt o c o p y t h e f i l e
t o a n o t h e rd i s k . m o r e
recordsmay have to be specified than were
specified when
the file was created.

File Location

Automatic File Allocation

After the size of a file has been determined, disk spaceto
c o n t a i n t h e f i l e c a n b e a l l o c a t e d . A m a i n d a t a a r e ac a n
c o n t a i n u p t o 1 0 0 0 f i l e s ; a s i m u l a t i o na r e ac a n c o n t a i n u p
to 50 files. A location may be specified on the FILE statem e n t i n d i c a t i n gt h e b e g i n n i n go f t h e f i l e : f o r a s i m u l a t i o n

When the location of a new file is not specified on the
FILE statement. the location is determined by disk system
management. The processis known as automatic file

a r e a ,i t i s s p e c i f i e dv i a a t r a c k n u m b e r ; f o r a m a i n d a t a a r e a ,
i t i s s p e c i f i e dv i a c y l i n d e r / h e a d . A l l o c a t i o n o f s p a c ef o r a
f i l e o n e i t h e r a m a i n d a t a a r e ao r a s i m u l a t i o na r e a b e g i n s
at the specified location and extends toward the high
cylinderend of the area.

When allocating f ile space,disk system managementcalculatesthe length of the file and, for a simulation area,
checks the volume label to determine which tracks are availa b l e f o r a l l o c a t i o n . ( T h e v o l u m e l a b e lc o n t a i n st h e s t a t u s

lVote; When using the COPYPACK function of $COPY
and $DCOPY to copy an entire 3344 pack. files located on
c y l i n d e r s 1 6 7 - 1 8 6 o f a 3 3 4 4 m a i n d a t a a r e aw i l l b e c o p i e d
to another 3344 main data area or tape, but they will not
be copied to a 3340 main data area.
The system requires a location to be specified on the FILE
s t a t e m e n tw h e n c r e a t i n ga f i l e w i t h a n i d e n t i c a ll a b e l a n d
the same size as a file that already exists in the area, when
r e l o a d i n go v e r a n e x i s t i n gf i l e , o r w h e n l o a d i n ga n o f f l i n e
m u l t i v o l u m e f i l e t o d i s k st h a t c o n t a i n o t h e r f i l e s . W h e n a
file is referenced,the location is used for a more specific
i d e n t i f i c a t i o nc h e c k a n d f o r i d e n t i f y i n g o n e o f s e v e r a fl i l e s
having the same label and same size.
A device independent FILE statement for card. diskette,
and printer files allows l/O devicesto be assignedwhen a
program is executed. Thus, a program need not be rewritten
w h e n a d i f f e r e n t d e v i c ei s t o b e u s e d . ( F o r e x a m p l e ,i n p u t
o r i g i n a l l yr e a d f r o m t h e M F C U l c a n b e r e a d f r o m t h e 3 7 4 1
w i t h o u t a n y c h a n g ei n t h e f i l e d e s c r i p t i o ns p e c i f i c a t i o n si n

allocation.

of each track and indicateswhich tracks are availablefor
use.) File space is first allocated for permanent files. then
t e m p o r a r y f i l e s . a n d f i n a l l y s c r a t c hf i l e s . i f m u l t i p l e f i l e s
are being allocated.
Disk system managementplacesthe f ile on the smallest
contiguous string of availabletracks that can contain the
file, leavingas few empty spacesas possible. For example,
i f t h e f i l e i s 1 0 t r a c k sl o n g a n d t h e r e i s o n e s t r i n go f 1 2
availabletracks and another of 1 5 tracks, the file is placed
in the string of 12 tracks becausethe 1 2'track string is
closer to the length of the file.
, hile searchingasimulation
l f d i s k s y s t e mm a n a g e m e n t w
the same number of available
having
area, finds two strings
placed
highest numbered available
at
the
file
is
tracks, the
f i r s t f i l e p l a c e do n a d i s k .
f
i
l
e
i
s
t
h
e
i
f
t
h
e
location. Also,
for
file beginning at the
the
space
the system allocates
allocatesspace beginThe
system
track.
highest numbered
a
l
l
o
w
a
smany available
t
o
l
o
c
a
t
i
o
n
ningat the highest
(the libraries
possible
library
oblect
next
to
the
tracks as
to enable
numbered
tracks)
lowest
the
located
at
are usually
the object library to expand if necessary.

t h e R P G l l p r o g r a m . ) T h e F I L E s t a t e m e n ts u p p l i e st h e
system with information about l/O devicesused in the
program. This information is used to read recordsfrom
and/or write records to the specified l/O device. A device
i n d e p e n d e n tF I L E s t a t e m e n tm u s t b e s u p p l i e df o r e a c h
d e v i c ei n d e p e n d e n tf i l e u s e d i n a p r o g r a m . l f d e v i c ei n d e '
p e n d e n tf i l e s u s e d i s k o r t a p e u n i t s f o r i n p u t o r o u t p u t ,
t h e n t h e d i s k o r t a p e F I L E s t a t e m e n ti s u s e d .
A system serviceprogram ($FCOMP) is used to remove gaps
between files. The program can reorganizethe files on a
s p e c i f i e dm a i n d a t a a r e do r c o p y { a d d ) a n e n t i r e m a i n d a t a
a r e af i l e b v f i l e t o a n o t h e r m a i n d a t a a r e a . L O C A T I O N
parametersmay have to be changed in OCL statements
after $FCOMP is used. (See File Compress Program$FCOMP in Part4 for more information.)

Fife Facilities

2:13

lf the areafound for a new file containsmore
tracksthan
required,disk systemmanagement
determines
the type of
file to the left (lowernumberedtrack)
of the available
tracks. lf the file to the left is of the same
retainrype,
the new file is left-adjusted;
if the file to the left is not
s i m i l a rt,h e n e w f i l e i s r i g h t - a d j u s t eadss h o w n
in the
f o l l o w i n ge x a m p l e :

Part A

Part B

Permanent
File

New
Permanent A v a i l a b l e Temporary
Fi l e
Tracks
Fi l e

Temporary A v a i l a b l e
Fi l e
Tracks

New
PermanentTemporary
Fi l e
File

Part A: The file is left-adjustedsince
both files are
permanent.
Part B: The file is right-adjustedsince
one file is temporary
and the other is permanent.
When disk system management is allocating
spaceon a main
data area, the searchfor space beginsat
cylinder 1 and
extends toward the high cylinder end
of the disk. When a
file is classifiedas temporary or permanent,
all disk space
is searchedto find the available
spacethat best fits the file.
The file is adjusted toward the cyrinder
r end of the avairable space. For a scratch file being placed
on a 3340 main
data area, the entire main data area is searched
for the best
fit; the file is adjustcd toward the cylinder
166 end of the
availablespace. For a scratch file being placed
on a 3344
main data area, the disk space between cylinders
167_1g6
is searchedfor the best fit. lf sufficient
spaceexists, the
file is adjusted toward the cyrinder 1g6
end of the avairabre
s p a c e . l f s p a c ec a n n o t b e f o u n d w i t h i n c y l i n d e r s
167_1g6,
the entire main data area is searchedfor
the best fit; the
f i l e i s a d j u s t e dt o w a r d t h e c y r i n d e r 1 g 6 e n d
of the avairabre
space.

2-14

Althoughit is easierto let disk systemmanagement
allocate
file space,the followingaresomeadvantages
in the user
determiningfire ailocation.More efficientfire rocations
may be determinedby a userthan by disk system
management. Disksystemmanagement
may leavea stringof
available
tracksbetweenfiles that is unusablebecause
the
s t r i n gi s n o t l o n ge n o u g ht o c o n t a i na n o t h e rf i l e .
T h eu s e r
candeterminethe locationof all filesby usingthe file
and
v o l u m el a b e ld i s p l a yp r o g r a m .
Automaticfile allocationconsiders
effectiveuseof file
space,but not the usageof the files. lt doesnot consider
f i l e p l a n n i n gf o r m u l t i p l ei n p u tf i l e si n a p r o g r a m j o b _ t o or
job transitions.Whena userplansfile
locations,filesused
togethercan be placednearone anotheron disk;
thus,
processing
time may be improved.
A function known asauto-allocate
providesautomatic
allocationof spacefor work files. This function can
be
usedby systemprogramssuchas librarymaintenance
and
disk sort. Usingthe auto-allocate
function of the disk sort
programgenerallyincreases
the time neededto run a sort
job; auto-allocate
doesnot alwaysprovidethe work file
arrangement
neededfor a fast sort run, Whena useris
c o n c e r n ew
d i t h m i n i m i z i n gs o r t r u n t i m e .a w o r k f i l e
should
be specifiedby meansof a FILE statement,rather
than
allowingthe systemto automaticallyallocatework
space.
An advantage
of usingauto-allocate
with disk sort is, if
sufficientcontiguousspaceis not available,
the system
will find work spacethat may be locatedin different
noncontiguous
spaces
of the samevolumeor on different
volumes.

F I L ES E R V I C E S

o T h e f i l e d e l e t e p r o g r a m ( $ D E L E T ) c a n b e u s e dt o :
- R e m o v ea l l f i l e s f r o m t h e V T O C a n d o p t i o n a l l y

The followingsystemserviceprogramsareprovidedfor
s e r v i c i nfgi l e s :
o T h e f i l e a n dv o l u m el a b e ld i s p l a yp r o g r a m( $ L A B E L ) ,
hastwo uses:
- P r i n tt h e e n t i r ev o l u m et a b l eo f c o n t e n t s( V T O C )f o r
a n a r e a( m a i nd a t ao r s i m u l a t i o n )
- P r i n tt h e V T O C i n f o r m a t i o nf o r o n l y c e r t a i nd a t a
files
In both cases,
the programalsoprintsthe nameof the
area.
The printed VTOC informationis a readable,
up-to-date
recordof the contentsof the area. This information
may havea numberof uses,suchas:
- Checkthe contentsof an areato ensurethat it containsno libraries,permanet'lt
datafiles,or temporary
d a t af i l e sb e f o r er e i n i t i a l i z i n g
- L o c a t es p a c et h a t i s a v a i l a b lfeo r l i b r a r i e os r n e w f i l e s
- O b t a i ns p e c i f i cf i l e i n f o r m a t i o ns, u c ha st h e f i l e
n a m e ,d e s i g n a t i o(np e r m a n e notr t e m p o r a r y )o, r t h e
spacereserved
for the file
- Determine
t h e a m o u n to f s p a c ea v a i l a b lien a p a r t i c u l a rf i l e
- Providefile locationfor useof the $COPYrecovery
function
The control statements
for the programdependon the
programuse. For more informationseeFile and Volume
Label DisplayProgram-$LABEL in Part 4 of this
manual.
o The copy/dumpprogram($COPY)performsonly one
of the followingfunctionsper execution:
- C o p ya n e n t i r ev o l u m e
- Copy a datafile
- C o p ya n d p r i n t a d a t af i l e
- C o p ya d a t af i l e , b u t p r i n t o n l y a p a r t o f t h e f i l e
- P r i n ta n e n t i r ed a t af i l e
- P r i n to n l y a p a r t o f a d a t af i l e
- Print and copy a part of a datafile
- B u i l da d i r e c tf i l e f r o m a n y f i l e t y p e ,e x c e p t
m a y n o t b e s p e c i f i e fdo r a n i n d e x e d
REORG-YES
file
- B u i l da n i n d e x e df i l e f r o m a s e o u e n t i af ill e
- Recovera file
- Copy a file with the output recordlengthdifferent
than the input length
The control statements
useddependon the desired
results. For more information, seeCopy/Dump
Program-$COPYin Part 4 of this manual.

-

-

r e m o v et h e i r a s s o c i a t e d a t a f r o m t h e a r e a .
R e m o v ea s p e c i fi c f i l e b y n a m e f r o m t h e I T O C a n d
o p t i o n a l l y r e m o v et h e i r a s s o c i a t e d a t a f r o m t h e a r e a .
R e m o v ef i l e r e f e r e n c e si n t h e V T O C o n l y . T h i s f r e e s
the spacethey occupy for use by new files but does
n o t r e m o v et h e d a t a f r o m t h e a r e a .
F r e e s p a c et h a t h a s b e e n a l l o c a t e db u t , d u e t o
a b n o r m a l c i r c u m s t a n c e si .s n o t a s s o c i a t e dw i t h a f i l e
or library.

.

T h e r e c o v e ri n d e x p r o g r a m ( $ R I N D X ) r e c o v e r si n d e x e d
f i l e s b y p r o v i d i n gt h e f o l l o w i n g f u n c t i o n s :
- R e c o v e rr e c o r d sa d d e d t o i n d e x e df i l e s l o s t b e c a u s e
o f a b n o r m a lt e r m i n a t i o n
- U p d a t e t h e f o r m a t - 1 l a b e l i n t h e s c h e d u l e rw o r k a r e a
w i t h n e w e n d - o f - d a t aa n d e n d - o f - i n d e xp o i n t e r s
- Call the system key sort program and update the
VTOC at end of job

.

T h e f i l e c o m p r e s sp r o g r a m ( $ F C O M P ) h a s t w o p r i m a r y
f u n c t io n s :
- P l a c ea l l f i l e s ( e x c e p t$ S P O O L ) i n a m a i n d a t a a r e a
t o g e t h e ra t t h e c y l i n d e r o n e e n d o f t h e d i s k
- C o p y e a c hf i l e i n a m a i n d a t a a r e at o a n o t h e r d i s k

S C H E D U L E RW O R K A R E A
T h e s c h e d u l e rw o r k a r e a ( S W A ) i s a w o r k s p a c el o c a t e d
o n t h e s y s t e m p a c k . O n e u s e i s t o t e m p o r a r i l y s a v ef i l e
l a b e l ( F 1 ) i n f o r m a t i o n d u r i n g t h e p r o c e s s i n go f a p r o g r a m .
T h e l i b r a r y m a i n t e n a n c ep r o g r a m i s u s e d t o c r e a t ea
s c h e d u l e rw o r k a r e af o r e a c h p a r t i t i o n . S p a c ef o r t h i s a r e a
i s a s s i g n e di m m e d i a t e l y p r e c e d i n gt h e o b j e c t l i b r a r y .
T h e s p a c ef o r f i l e l a b e l i n f o r m a t i o n i s 4 8 s e c t o r s ,a n d i t c a n
c o n t a i n a m a x i m u m o f 1 9 2 e n t r i e s ,e a c h 6 4 b y t e s i n l e n g t h .
A m a x i m u m o f 1 9 2 e n t r i e s( f i l e s .v o l u m e so f a m u l t i v o l u m e
f i l e , o r a c o m b i n a t i o n ) m a y b e s p e c i f i e df o r o n e p r o g r a m .
I n s o m ec a s e sh
, o w e v e r ,t h e m a x i m u m w i l l b e l e s st h a n
1 9 2 . W h e n a l l f i l e s a r e i n d e x e d m u l t i v o l u m e f i l e s .t h e
m a x i m u m i s 9 6 f i l e s . A 1 0 K p a r t i t i o n m u s t b e a v a i l a b l et o
p r o c e s s1 9 2 e n t r i e s ;a p a r t i t i o n o f 8 K c a n p r o c e s su p t o
128 entries.

File Facilities 2-15

T h e a u t o - a l l o c a ft ue n c t i o nm a y r e q u i r e
a n F 1 e n t r yr n t h e
SWAeventhoughit is not specified
by the user. For
example,the DiskSort program
hasan auto_allocate
functionwhereinthe system,not
the user,locateswork
spacefor the sort. Also.someof
the systemservice
programsusethe auto_allocate
routines.

For example, when the
$COpy program is used to copy
a
m u l t i v o l u m e i n d e x e df i l e o n f i v e
u o l r - u , t o a n o t h e rf i v e
v o l u m e s ,1 0 e n t r i e sa r e r e q u i r e d
for the input f ile and
1 0 e n t r i e sa r e r e q u i r e df o r t h e
output file. Thus,oy
summing these requirements, it
can be determined whether
t h e m a x i m u m a l l o w a b l en u m b e r
o f S W A e n t r i e s( 1 9 2 )
has been exceeded.

G e n e r a l l yo,n ef o r m a t _ 1l a b e li s
r e q u i r e df o r e a c hf i l e . O n e
F1 labelrepresents
one FILE statementf"r. Oirt, rape,
or
d e v i c ei n d e p e n d e ndta t am a n a g e m e n( D
t IDM). Formulti_
v o l u m ef i l e s ,t h e r ei s o n e F l l a b e l
f o r e a c hp A C K o r R E E L
n a m e . I n a d d i t i o no, n e F 7 l a b e li s
u s e df o r e a c hv o l u m e
o f a n i n d e x e dm u l t i v o l u m ef i l e t o
c o n t a i nH I K E y
information.

FILE SHARING
F i l e s h a r i n ga l l o w s a d i s k f i l e t o
b e s h a r e db y t w o o r m o r e
programs executing at the
same time. programs can read
from, update, or add to the file.

The followingchartcan be usedto
determinethe number
of SWAentriesrequiredfor eachprogram
execution.A
directfile requiresthe samenumber
of entriesasa sequen_
t i a lf i l e .

Type of File

Number
of
Applicabte
Volumes Devices

Number
of SWA
Entries

Sequential

1

D i s k ,T a p e ,
DIDM2

S e q u e n t i a( M
l Vfl

3

D i s k .T a p e ,
DIDM2

3

Indexed(created
a ss i n g l ev o l u m e )

1

Disk

1

lndexed
(created
a sM V F )

I

Disk

2

Indexed
(createdas MVF)

3

Disk

b

Disk
Disk

Upto4
1r

1

F i l e s h a r i n ga l l o w s :
.

o A program in a partition
to accessa record added by
another program in a partition whire
both are executing.
(For more information,
seeSharing Access To Added
Records chart under Fite Share in
Multiprogramming
Consi derati ons an d R estric ti ons.l
r

Auto-allocate;
$DSORT
$MAINT

'Not

Upto4
1

i n c l u d i n g f i l e s s p e c i f i e df o r t h e f i l e - t o { i b r a r y
or
.' l i b r a r y - t o - fi l e f u n c t i o n s .
Device independent data management.

Programsexecuting in batch mode
in different parti_
t i o n s t o i n p u t f r o m , u p d a t e ,a n d
a d d t o t h e s a m ef i l e

A CCP-definedfile to be processed
by a batch program
without requiring CCp to suspendprocessing
or
shutdown

Sharing a file reducesthe need to have
more than one
copy of a file online, and it reduces
file contention between
p r o g r a m s . F i l e s h a r i n gi s a t
the block level(one block of
records) rather than at the file level.
Thus, two or more
programscan be processingrecords
from the same file,
but simultaneousaccessesto the same
block are queued.

P a g eo f G C 2 1 - 5 1 6 2 - 1

1979
28 SePtember
lssued
BYTNL: GN21-5674
CompatibleAccessMethodsfor File Sharing

DTF (Definethe File)

by the different types
Different file types can be accessed
of disk data management.For example,an indexedfile
by consecutiveinput data management.
can be accessed
access
The followingchart showsthe datamanagement
the differentfile types.
methodsallowedto access

by
A DTF (definethe file) is a file control block generated
program,
in
vary
can
the compiler. lt residesin the object
(depending
file
organizathe
on
sizefrom 30 to 150 bytes
method),and is usedby datamanagement
tion and access
to communicatewith the userprogram.At leastone DTF
existsfor eachfile, includingprinter.tape,disk, card,3741,
files.
console,or deviceindependent

File Typet
Consecutive Direct

Access
Method

lndexed

Consecutive

YES

YE52

YE52

Direct

YES

YES

YES

lndexed

NO

NO

YES

r
I n d i c a t e st h e t y p e o f f i l e o r g a n i z a t i o nu s e d t o c r e a t e t h e f i l e .
'
Except consecutive add.

Figure2-1 showsthe compatibledisk datamanagement
methodsallowedwith f ile sharing.The access
access
accessing
methodson the left indicatethe datamanagement
the file.
CAUTION:
to
or directdata management
lf you useconsecutive
updatean indexedfile, you shouldexercisecareto prevent
destroyingthe key field portion of the record.
methodis indicatedbV 2,3,
access
The datamanagement
or 4 charactercodesasfollows:
o The first position-C, D, or l-correspondsto the file
organi zation-consecutive.direct,and i ndexed.
.

The 2nd, 3rd, and 4th positionscan containthese
characters:R and S correspondto file access-random.
within
sequentially
sequential.L refersto processing
limits, O, A, U, G referto function-output. add,
update,and get.

As part of openingfilesfor programexecution,the system's
allocationand open routinesstoreVTOC informationabout
t h e f i l e i n t h e D T F . T h i s i n f o r m a t i o ni n c l u d e fsi l e n a m e ,
devicecode,file attributes,pointersto input/outputblocks,
commandcode,and l/O completioncode.
F o r f i l e s h a r i n g( d i s kf i l e so n l y ) ,t h e D T F a l s oc o n t a i n sa
p o i n t e rt o t h e f i l e s h a r eD T F ( S D T F ) .

SDTF (ShareDefinethe Filel
Whena disk f ile is beingshared,an additionalcontrol block,
c a l l e dt h e S D T F ( f i l es h a r eD T F ) , i s u s e d ' l t r e s i d eisn
mainstorageoutsidethe programpartitionin a common
areacalledthe file sharearea.Thereis one SDTF for each
p h y s i c a lo. p e n ,s h a r e dd i s kf i l e ; t h e S D T F i s c r e a t e dw h e n
that file is openedthe first time, and it is removedwhen
the file is closedfor the lasttime.
The SDTF containsinformationthat reflectsthe statusof
r o m e n t .W i t h i nt h e S D T F a r e
t h e f i l e a t a n y p a r t i c u l am
of disk dataextents,a counterthat
file attributes,addresses
indicatesthe numberof timesthe file wasopened,and a
p o i n t e rt o f i l e s h a r eq u e u ee l e m e n t (sF S O E ) .D a t am a n a g e ment usesthe SDTF to obtainand updatethe statusand
p o i n t e r so f s h a r e df i l e s .
The SDTF variesin sizedependingon the type of disk file
it describes.The basicSDTF sizeconsistsof a block of 64
are:
bvtes. SDTF requirements
Number
of
SDTFs

Example:
1.

2.

input (CG).
A file is openasconsecutive
An attemptis madeto openthe samefile with
i n d e x e dr a n d o mi n p u t ,u p d a t e a, n da d d ( I R U A ) . T h e
file is allowedto openif it wascreatedasan indexed
file.

Number
of
Blocks

Number
of
BYtes

S i n g l ev o l u m ef i l e
Sequentialor direct
I ndexed

64
128

File Facilities

2-17

Pageof GC21 -5162-l
lssued 28 September l97g
8y TNL: GN21-5674

Number
of
SDTFs
M u l t i v o l u m ef i l e
Sequentialor direct
1 volume
2 volumes
3 volumes
4 volumes
I ndexed
1 volume
2 volumes
3 volumes
4 volumes

Number
of
Blocks

Number
of
Bytes

1
2
3
4

8

stz

1
2
3
4

3
A
9
2

192
384
576
768

2
4
6

1

128
256
384

FSOE(File ShareOueueElement)
An FSOEis usedto recordwhat portionsof the
f ile are
currentlylocked(enqueued)
and to indicateif contention
for thoselockedportionsexists.
The FSOEportion of the file shareareais a work
areaused
duringdisk file processing.An FSOEis created
for each
reference(for example,GET or pUT) to a physical,
shared
disk file that is openedfor updateor add.
Therecan be
morethan one FSOEfor eachSDTF.

File ShareArea
F i l es h a r i n gr e q u i r e as n a r e aa t t h e h i g he n d
o f m a i nstorage
to containthe SDTFs,FSOEs,and a common
area. The
userspecifies
the sizeof the entireareaduringsysremgeneration. This sizecan later be changedwith
the SET com_
m a n di n i n c r e m e n tosf 2 K ( a l lp a r t i t i o n sm u s t
b e a t e n do {
job beforethe SET commandcan
be used).
T h e f i l e s h a r ea r e ai s s p e c i f i e a
d sa m u l t i p l eo f 2 K ; 2 K i s
r e q u i r e da sa m i n i m u m .T h e s y s t e md i v i d e s
t i r i sa r e af o r
storageof the sDTFs and FSoEsin a predetermined
ratio.
For example,in a 4K file sharearea,there
is spacefor 52
S D T F sa n d3 b F S O E s .
l f t h e u s e rd e c i d e s( t h r o u g ha n a n a l y s ios f
h i sa p p l i c a t i o n s )
that the file shareareawould be betterutilized
with a
differentratio of SDTFsand FSOEs,the
$CNFtG (config_
urationrecord)programcan be usedto assign
a different
p r o p o r t i o n .( S e et h e F S H A R Es t a t e m e n t
in the$CNFIG
systemserviceprogram.)

2-18

Doubly-DefinedFiles
In a singleuserprogram.you can defineone physical
disk
file with two differentnamesand file descriptions.
Such
a doubly-defined
f ile requirescertainuserconventionsin
orderto avoidfile contentionproblems.
File contentionoccurswhen the samerecordsin
a f ile are
beingaccessed
for updateby differentusersat the same
time. Contentionfor a doubly-defined
file occurswhen the
usersimultaneously
processes
the samerecords.
Datamanagement
routinesensurethat sharedupdatefiles
areprotectedduringthe update. As the file is beingprocessed,the recordto be updatedis readinto main storage.
The disk block that containsthe record.and any other
recordsin the block, is then protectedfrom any other updateaccess.Requests
for informationin that block are
locked;that is, the requestwaitsuntil the updatedrecord
is written backto disk.at which time the originarrequest
is unlocked,and the new requestcan be processed.
(Note: For System/3,the lock/unlockmechanism
is called
enqueue/dequeu
e.)
During random processi
n g. th is rewrite/unlock/dequeue
occursaftereachupdateof the record. Duringsequential
processing,
this rewrite/unlock/dequeue
doesnot occur
until the entireblock of recordshasbeenprocessed.
ln
eithercase(andespecially
when processing
sequentially),
programsthat usedoubly-defined
filesare susceptible
to
Iockouts.
For furtherexplanation,considerthe following
example.
Assumethat an indexedfile hasbeendefinedin one pro_
gramwith two differentdefinitions:
File Name

AccessMethod

FILEAl
FILEA2

Directupdate(DU)
Indexedrandomupdateand add
(IRUA)

lf the userhasretrieveda recordfrom the file
usingthe
F I L E A 2 ( I R U A ) d e f i n i t i o na. n d t h e na t t e m p t s
to retrieve
that record(or one that is in the sameblock) using
the
F I L E A l ( D U ) d e f i n i t i o nt,h e l a t t e ra c c e sw
s ill betocked
out until the recordis written backto disk for the FILEA2
definition.

P a g eo f G C 2 1 - 5 1 6 2 - l
lssued 28 September 1979
By TNL: GN21-5674

l f t h e s e q u e n coef e v e n t si s s u c ht h a t t h e r e w r i t et o F I L E A 2
doesnot occuruntil the successful
completionof the read
r e q u e stto F l L E A l , t h e n t h e p r o g r a mw i l l s t a yi n t h i s w a i t ing state;the CANCEL operatorcontrol commandmust be
enteredto free the partition.

Considerations
and Restrictions
T o a v o i df i l e c o n t e n t i o np r o b l e m sw h e nu s i n gd o u b l y definedfiles,write the changedrecordsto disk after each
upclate.
Whenthe systemis executinga programwith a file that
c a nb e s h a r e dt,h e p a r a m e t eSr H A R E - y E Sc a n b e i n c l u d e d
o n t h e F I L E s t a t e m e n tS
. HARE-YES
a l l o w sf i l e s h a r i n g
betweenprogramsexecutingat the sametime if the access
m e t h o d su s e da r ec o m p a t i b l e( s e eF i g u r e2 - 1 ) . S H A R E - N O
d i s a l l o wfsi l e s h a r i n g .l f t h i s p a r a m e t ei rs n o t g i v e na n d
R E T A I N - Sw a sn o t s p e c i f i e dS, H A R E - y E Si s a s s u m e d .
(Scratchfilesare not shared.)
Severalrestrictionsapply to file sharing.For programs
specifyingdoublebufferingfor a file to be shared,the
d o u b l eb u f f e r i n gr e q u e sits i g n o r e ds; i n g l eb u f f e r i n gi s u s e d .
O f f l i n em u l t i v o l u m ef i l e sc a n n o tb e s h a r e d .
A m a x i m u mo f f o u r o n l i n em u l t i v o l u m ecsa n b e s h a r e d .
Randomand sequentialaccess
methodsaresupported
underbatch;only randomaccessis supportedunderCCp.
T h e d e f a u l to n m u l t i v o l u m eO C L i s S H A R E - y E S .
Whena particularfile is referenced
more than oncewithin
a j o b s t e p ,S H A R E - N Oc a n n o tb e s p e c iife d .
D i s kf i l e s h a r i n gi s a l s os u p p o r t e d
b y d e v i c ei n d e p e n d e n t
d a t am a n a g e m e nd ti s kf i l e s .
A displayof the systemstatus(via DlSpLAy STATUS
c o m m a n d i)n c l u d e tsh e s i z eo f t h e f i l e s h a r ea r e a .
For additionalinformationon f ile sharing, seeMultiprogramming Considerations and Restrictions.

File Facilities

2-18.1

Attempt To OpenAs

o

co

N

CA

o

o

o

N

N

N

N

N

:

Consecutive
Output

N

N

N

N

N

N

N

N

N

N

N

N

N

Uonsecutive
Add

N

N

N

DG

N

N

N

IRA

N

ts
ISL
ISU
ISUL

tsA
ISUA

N

N
N

N

N

N

N

N

N

N

I

N

N

N

N

D i rect
Output

yr

yt

Direct
Update

N

l

r
N

N

N

N

N

N

N

yt
N

N

N

N

YI

Yr

N

N

N

N

N

y2

y2

N

N

N

N

y2

yz

N

N

N

N

yz yz

N

N

N

N

N

YI

yr

I

N

N

N

N

N

N
N

N
N

N

Consecutive
Get

N

)
IA

N

Consecutive
Update

I

N
N

IRUA

2
N

N

N

D

N

N

IRU

I

N

DU

N

at)

N

N

N

D

N

DO

N

)
(r,

N

N

N

I

N

N

N

(/t

I

N

N

s

N

CG

N

G

N

N

N

g

N

N

N

(E

N

N

IR

o
€
tt

TI

(J

CU

to

cqJ

N

(J

N

Y I Y

I

Y1. YI

I

YI
Yl

N

N

N

N

I

N

N

N

Yr

N

N

N

N

N

N

N yr

Yl

N

N

N yr

I
YI

Direct
Get
In d e x e d
Output
Indexed
RandomInput
IndexedRandom
Input Update
IndexedRandom Input
Updateand Add
IndexedRandom
Input Add
Indexed
Add
In d e x e d
S e q u e n t i a lI n p u t
I n d e x e dS e q u e n t i a l
Inputwith Limits
I n d e x e dS e q u e n t i a l
Input Update

I n d e x e dS e q u e n t i aI n
l our
_9pdate with Limits

yr

Yr

Yr

N

N

I n d e x e dS e q u e n t i a l
Input Add

Yl

N

N

I n d e x e dS e q u e n t i aI n
l our
U p d a t ea n d A d d

t '"*"

*;tial
Addsmay be usedone time asthe f irst addaccess
to the fire. rf any addshavepreviousry
beenperformedand key sort
no: occurred,only randomaccess
methodsmay be usedto add to the file.
,L"t
rTrandomadd hastakenprace,the addedrecordsare
not accessed.
Notes:
1 ' A b o v e a c c e s sm e t h o d s i n d i c a t et h e d a t a m a n a g e m e n t
a c c e s s i n tgh e f i l e , n o t t h e f i l e t y p e .
2' Additional information about the availability
of added records is included underMultiprogramming
considerations and
Restrictions in part 2 of this manual.
3 . l f y o u a r e u s i n gt h e p s e u d ot a p e a c c e s sm e t h o d ( P T A M ) ,
n o f i l e s h a r i n gi s a l l o w e d b e t w e e np a r t i t i o n s . ( p T A M
is the
a c c e s sm e t h o d u s e df o r F O R T R A N s e q u e n t i a l
f iles.)
Figure2-1. CompatibleDisk AccessMethodsfor
5704_SC2
FileSharing

z- t6-z

GeneralResultsWhenthe 2 or 3 Option is Selected
for a Message
For most messages
whereoption 2 or 3 is selected,
the job
or job stepis cancelledwith no further actionbeingtaken.
Exceptionsarenoted in the message
list containedin the
IBM System/3 Model | 5 SystemMessages,GC21-5076.
The reasonfor the message
indicatesthe correctiveaction
that must be taken beforethe job or job stepcan be resubmitted. In somecases,it may be necessary
to contacta
servicerepresentative
to correctthe problem.
l f a 2 o r 3 o p t i o ni s t a k e nt o a m e s s a gdeu r i n ga $ M A I N T
r u n ,t h e l i b r a r yo r l i b r a r ye n t r i e si n v o l v e di n t h e f u n c t i o n
might be destroyed.

Considerations When Selecting the 3 (or D) Option
When the 3 option is selectedto a system messageand the
p a r t i t i o n i s i n j o b m o d e , a l l r e m a i n i n gs t e p si n t h e j o b a r e
c a n c e l l e d .O n s y s t e m st h a t h a v e i n p u t s p o o l i n g ,j o b p r o c e s s i n gi n t h e p a r t i t i o n w i l l r e s u m ew i t h t h e n e x t j o b : .
t h e i n p u t q u e u e . O n s y s t e m st h a t d o n o t s u p p o r t i n p u t
spooling, the job stream will be read but not processed
u n t i l a J O B o r / . s t a t e m e n ti s r e a d . l f o u t p u t s p o o l i n gi s
supported on the system, spooled output created by the
job will be saved.
When the 3 option is selectedto a system messageand
the partition is in step mode, only the current job step
w i l l b e c a n c e l l e d . T h e j o b s t r e a mw i l l b e r e a d b u t n o t
p r o c e s s e du n t i l a J O B , L O A D , C A L L , / . , o r / & s t a t e m e n t
isencountered.

Considerations When Selecting the 2 Option
Whenthe 2 option is selectedto an OCL diagnosticissued
beforethe LOAD statementis read,the 2 option is treated
asa 0 option.
Whenthe 2 option is selectedto a systemmessage
and the
p a r t i t i o ni s i n i o b m o d e ,a l l r e m a i n i n sgt e p si n t h e j o b a r e
a l s oc a n c e l l e dO
. n s y s t e mtsh a t h a v ei n p u t s p o o l i n gj ,o b
p r o c e s s i ni ng t h e p a r t i t i o nw i l l r e s u m ew i t h t h e n e x t j o b
o n t h e i n p u t q u e u e .O n s y s t e m tsh a t d o n o t s u p p o r ti n p u t
spooling,the job streamwill be readbut not processed
u n t i l a J O B o r / . s t a t e m e nits r e a d . l f o u t p u ts p o o l i n gi s
supportedon the system,spooledoutput createdby the
job will be saved.

When a messageoccurs during the execution of a job step
a n d t h e 3 o p t i o n i s s e l e c t e d t. h e s t a t t , so f t h e d i s k f i l e s
being used by the program depends on the operations
b e i n gp e r f o r m e d . T h e p o s s i b l ed i s p o s i t i o no f t h e d i s k
f i l e sa r e :
.

N e w f i l e s b e i n gc r e a t e dw i l l n o t b e r e t a i n e d .

.

O l d f i l e s b e i n g d e l e t e dw i l l b e r e t a i n e d .

o O l d f i l e s b e i n g a d d e d t o w i l l n o t r e f l e c tt h e a d d i t i o n s
u n l e s so p e n e d a s S H A R E ' Y E S . l f t h e f i l e i s s h a r e d ,
t h e a d d i t i o n sw i l l b e r e f l e c t e di n t h e V T O C .
.

Whenthe 2 option is selectedto a systemmessage
and the
partitionis in step mode,only the currentjob stepwill
be cancelled.The job streamwill be readbut not processed
until a JOB, LOAD, CALL. /., or l& statementis
read.

O l d f i l e s b e i n g u p d a t e d w i l l r e f l e c t t h e u p d a t e st o t h e
point at which the messageoccurred. (Updated records
r e s i d i n gi n m a i n s t o r a g eb u f f e r s a t t h i s t i m e w i l l n o t
be reflected in the data file.)

o S h a r e df i l e s w i l l r e f l e c t a l l a c t i v i t y u p t o t h e p o i n t w h e n
t h e m e s s a g eo c c u r r e d ,s i m i l a r t o t h e 2 o p t i o n .

Whena message
occursduringthe executionof a job step
and the 2 option wasselected,
the disk files will reflect
all activityup to the point when the message
occurred
and the 2 option wasselected.However,if the message
o c c u r sd u r i n ga $ M A I N T r u n , t h e s e l e c t i o o
nf t h e 2 o p t i o n
w i l l n o t c a u s et h e l i b r a r yo r l i b r a r ye n t r i e si n v o l v e di n t h e
functionto be retained.
Note: fhe 2 option cannotbe takenwhen messages
are
i s s u e d u r i n gR P Gl l l a s tr e c o r d( L R ) t i m e .

FileFacilities 2-19

W O R KF I L E S
A work file is spacerequiredby the language
translators
( R P Gl l , C O B O L ,F O R T R A N ,
C C p / D i s kS o r t ,a n d B a s i c
Assemblerland severalsystemprograms(macroprocessor
and overlaylinkageeditor). A work file may
be usedin
processing
largeindexeddisk files (seeLargeIndex Files
i n t h i s s e c t i o n ) .A w o r k f i l e c a n b e s p e c i f i e d
v i aa F I L E
statementor can be obtainedby auto-allocate.
The Model 15 language
translatorsrequirework filesfor
compilation. lf an objectprogramis required,
work files
for the overlaylinkageeditor arealsorequired.
The
followingestimates
of work file spacerequirements
can
be usedfor planningpurposes;
they may not be valid in
all circumstances.
The numberof tracksfor eachwork areadepends
on the
areaof the disk used. A simulationareahas
24 sectors
(6,144bytes)per track; the main
dataareahas4g sectors
(12,228bytes)per track. Either
areacan be usedfor all
components.

Main StorageRequirements

Component

Work File
Names

R P GI I
Compiler

Minimum
Main Storage
Requirements2
Compile

Execute

$SOURCE
$WORK

10K

2K

COBOL
Compiler

$SOURCE
$WORK
$WORKX

12Kl

8K

FORTRAN
Compiler

$SOURCE
$WORK

r0K

8K

CCP/DiskSort

$SOURCE
$WORK

12K

12K

Basic
Assembler

$SOURCE
$WORK
$WORK2

10K

2K

Macro
Processor

$SOURCE

nla

12K

Overlay
$SOURCE
L i n k a g eE d i t o r $ W O R K

n/a

r0K

l14K
if braille output is required.
-Minimum
partition that can be usedis gK.

2-20

R P GI I

COBOL

T h e R P Gl l c o m p i l e r( P r o g r a m
N u m b e rS 7 0 4 - R G 2 )
requirestwo work files. The sizeof thesefilesdepends
on the numberof sourcestatements(excludingcomments)
and the type of statements
in the program. For the following table, a compnessed
sourcestatementlength of S0 bytes
is assumed.

COBOL(ProgramNumber57O4-CB2\
requiresdisk space
for eachof its threework files. The amountof space
requireddependson the numberof statements
in the
sourceprogram. The followingchart showsrequirements
for eachof the threework files.
Numberof Tracksfor
$ S O U R C E$, W O R K ,
or $WORKX

Number of Tracksfor

$souRcE/$woRK
Number of Source
Statements

50
100
150
200
300
400
500
700
1000
1500
2000

Simulation
Area

3
3
4
4
5
6
6
8
11
1
1

Main Data
Area

4
8

2
2
2
2
3
3
3
4
6
7
9

To generate
an objectprogram,the requirements
for the
overlaylinkageeditor must alsobe met. The sizeof
$SOURCEand $WORK must be largeenoughto accommodateboth the RPG ll compilerand the overlaylinkage
editor.

Number of Source
Statements

50
100
150
200
300
400
500
1000
2000

Simulation
Area
1
2
3
4
6
8
10
20
40

Main Data
Area

1
1
2
2
3
4
5
10
20

In addition,to generate
an objectprogram,the requirementsfor the overlaylinkageeditor must be met.

FORTRAN
FORTRAN (ProgramNumber57O4-FO2\requiresdisk
w o r k s p a c ef o r $ W O R Kd u r i n gc o m p i l a t i o n T
. h i ss p a c e
variesaccordingto the sizeand complexityof the program
and,generally,10 tracksfor a simulationareaor 5 tracks
for a main data areaaresufficient.
$SOURCEis not usedby the compiler.but it is allocated
so that the overlaylinkageeditor will havethe space
for the overlaylinkageeditor
available.(The requirements
m u s tb e m e t . ) l f l i n k i n gi s n o t r e q u i r e da, t l e a s t1 t r a c k
must be specifiedfor $SOURCE.

File Facilities

2'21

CCP/DiskSort
CCP/DisS
k ort(Program
N u m b e rS 7 0 4 _ S M 7r e) q u i r e s
d i s kw o r k s p a c ef o r $ W O R Kd u r i n gp r o g r a mg e n e r a t i o n .
$WORK is usedto storethe objectprogram,and its size
is thereforerelativeto the sizeof the objectprogram_not
to that of the sourceprogram. Eachobjectrecord
requires
64 bytes,and four entriesarestoredper sector.
Because
eachsimulationareatrack can containg6 records,
2 tracks
a r eu s u a l l ys u f fi c i e n tf o r m o s ts o r tg e n e r a t i o n s .
$ S O U R C Ei s n o t u s e db y t h e g e n e r a t o b
r ,u t i t i s a l l o c a t e d
s o t h a t t h e o v e r l a yl i n k a g ee d i t o rw i l l h a v et h e s p a c e
a v a i l a b l e(.T h e$ W O R Ka n d S S O U R C E
f i l e sm u s tr e s i d e
o n a s i m u l a t i o na r e af o r C C p / D i s kS o r t . )

To generatean objectmodule,the requirements
for the
o v e r l a yl i n k a g ee d i t o rm u s ta l s ob e m e t . l f m a c r o sa r e
used,the macroprocessoris executedbeforethe Basic
Assembler.
but the requirements
arestill asshownin the
preceding
estimates.
$WORK is usedto storethe objectprogram,and its size
is thereforerelativeto the sizeof the objectprogram_nor
to that of the sourceprogram. Eachobjectrecordrequires
64 bytes,and four entriesarestoredper sector. Because
eachsimulationareatrack can containg6 recordsand
e a c hm a i nd a t aa r e at r a c kc a nc o n t a i n1 g 2 r e c o r d s , 2t r a c k s
a r eu s u a l l ys u f f i c i e nfto r m o s ta s s e m b l i e s .

I n a l l c a s e st ,h e o v e r l a yl i n k a g ee d i t o rr e q u i r e m e n ft o
sr
$ S O U R C Ea n d$ W O R Km u s tb e m e t .

BasicAssembler
The BasicAssembler(programNumberS704_AS2)
requires
work spacefor assemblyasshownbelow. (For more
information, refer to System/3 gasicAssemblerReference
Manual,SC21-7S09.)Number of SourceStatements
includessourcestatements
generated
(expanded)by the
macroprocessor.

Numberof Tracks
for $SOURCE

Numberof Tracks
for $WORK2

Numberof
Source
Statements

100
200
300
400
500
600
700
800
900
I 000

2-22

2
4
5
7
8
10
11

1
2
3
4
4
5

r3

7
8
I

15
16

o

2
4
6
7
9
t1
12
't4
16
18

1
2
3
4
5
6
6
7
8
9

{see below)

OverlayLinkageEditor

LargeIndex Files

T h e o v e r l a yl i n k a g ee d i t o r( g O L l N K p r o g r a mc) a n b e
g r g ei n d e x e dd i s k
W o r kf i l e sa r ea l s ou s e di n p r o c e s s i nl a
i n v o k e da u t o m a t i c a l lbyy t h e c o m p i l e r so r b y t h e a s s e m b l e r . f i l e s . W i t h a l a r g ei n d e x e df i l e ,t h e a m o u n to f t i m e n e e d e d
It requireswork spaceasshownbelow. The sizeof the
to sort the keysat end of job stepmay be excessive;
this
work areasdependson the amountof storageavailable
a m o u n to f t i m e i s m o s ts i g n i f i c a nwt h e na d d i n ga l a r g e
(partitionsize)ratherthan on the numberof statements.
numberof recordsto the file, performingan unordered
l o a d ,o r e x e c u t i n g
a n dw i t h
$ C O P Yw i t h R E O R G - N O
O M I T o r D E L E T Es p e c i f i e dT. h i ss o r t t i m e c a n b e
Numberof Tracksfor
r e d u c e di f a w o r k f i l e i s u s e d .T h e o p t i o n a w
l orkfile
$SOURCE/$WORK
caneitherbe allocatedby the useror be automatically
allocatedby the system.
Simulation Main Data
PartitionSize
Area
Area
The userallocatesthe work spaceby supplyinga
. r,thesystem
10K
4
$ l N D E X 4 5o r a $ l N D E X 4 0F I L E s t a t e m e n tO
2
attempts
to
allocate
the
work
soace
if
either
12K
of
the follow4
2
i
n
g
c
o
n
d
i
t
i
o
n
s
16K
e
x
i
s
t
s
:
5
3
20K
6
3
24K
N e i t h e ar $ l N D E X 4 5n o r a $ l N D E X 4 0F I L E s t a t e m e n t
6
3
28K
i ss u p p l i e d .
7
4
32K
8
4
36K
8
T h es p a c er e q u e s t evdi a a $ I N D E X 4 So r a $ | N D E X 4 0
4
40K
I
F I L E s t a t e m e nits n o t l a r g ee n o u g h .
5
44K
10
5
48K
10
5
To automatically allocate the work space,the system
>48K
10
5
always checks for suff icient space on the main data area
A s a n e x a m p l ei n t h e u s eo f t h i s i n f o r m a t i o na. s s u m teh a t
a 200-statement
RPG ll programis to be compiledin a
3 2 K p a r t i t i o n .W o r k f i l e sa r et o b e o n a s i m u l a t i o n
area.
R P Gl l r e q u i r e4s t r a c k sa, n dt h e o v e r l a yl i n k a g ee d i t o r
requires8 tracks. Therefore,12 tracksshouldbe specified
f o r $ S O U R C Ea, n d 1 2 t r a c k ss h o u l db e s p e c i f i e fdo r
$WORK.

o f D 1 f i r s t ; i f s u f f i c i e n ts p a c ei s n o t a v a i l a b l eo n D 1 , t h e
system then checks the main data area on D2; if the space
o n D 2 i s i n s u f f i c i e n t .t h e s e a r c hc o n t i n u e so n t h e a v a i l a b l e
m a i n d a t a a r e a su n t i l e i t h e r s u f f i c i e n ts p a c ei s f o u n d o r a
messageis issuedto indicate that the system cannot autom a t i c a l l y a l l o c a t et h e w o r k s p a c e .
T h e r e s t r i c t i o no n t h e m a x i m u m n u m b e r o f f i l e s a l l o w e d
b y t h e s y s t e m a p p l i e st o a l l f i l e s a u t o m a t i c a l l ya l l o c a t e d
by the system as well as the files allocated by the user.
Therefore, in order to use the work file, you must not have
p r e v i o u s l ys p e c i f i e dt h e m a x i m u m n u m b e r o f f i l e sa l l o w e d .
lf you wish to provide the work spacewith a $lNDEX45
o r a $ l N D E X 4 0 F I L E s t a t e m e n t ,t h e f o l l o w i n g i n f o r m a t i o n w i l l a i d y o u i n d e t e r m i n i n gt h e r e q u i r e ds i z e .

FileFacilities 2-23

T h e w o r k f i l e , c a l l e d$ I N D E X 4 b o r
$ l N D E X 4 0 i s u s e dt o
sort the added keys and then merge the
added keys into
t h e i n d e x a n d m u s t b e l a r g ee n o u g ht o
contain all of the
keys added to the f ile. lf the program adds
records to more
t h a n o n e i n d e x e df i l e , t h e w o r k f i l e m u s t
b e l a r g ee n o u g h
to contain all the keys for the file whose
added keys occupy
the greatestkey index area. The work file
should be as
c l o s ea s p o s s i b l et o t h e b e g i n n i n go f t h e
f i l e w h o s ek e y s
a r e b e i n gs o r t e d o r o n a d i f f e r e n t d i s k
drive. This arrange_
m e n t m i n i m i z e st h e d i s k s e e kt i m e .
The work file must be named
$lNDEX45 or $tNDEX40 and
be located on a main data area. To determine
the number
of tracks required for the work file, use
the followino
formula:

j9-Number of adds = 4g = Tracks for
;*
{ K e Yl e n g t h + 4 )
main data
area
After dividing256 by key length+ 4, the remainder
should
b e d r o p p e d . A f t e r t h e o t h e r d i v i s i o n s ,r o u n d
the quotient
t o t h e n e x t h i g h e s tw h o l e n u m b e r .
T h e w o r k f i l e c a n b e u s e dw i t h m u l t i v o l u m e
files. However,
it cannot be located on an area that contains
one of the
o f f l i n e v o l u m e so f a m u l t i v o l u m e f i l e . T h e
datamodule
c o n t a i n i n gt h e w o r k f i l e m u s t r e m a i n o n l i n e
while the
p r o g r a mi s r u n . T h e w o r k f i l e m u s t
be RETAIN_S. lf
R E T A I N - T o r R E T A I N - p i s s p e c i f i e d ,t h e
s y s t e mf o r c e s
it to RETAIN-S.
F o r s m a l l i n d e x e df i l e s o f 1 0 t r a c k s o r l e s s
wherethe sort
t i m e i s n e g l i g i b l e a, w o r k f i l e d o e s n o t i m p r o v e p e r f o r m a n c e
and shouldnot be used.
F o r t h i s p e r f o r m a n c eo p t i o n , n o c h a n g e
to the source
program is needed. Also, programs
need not be recomp i l e d t o u s et h i s o p t i o n ; o n l y o n e
a d d i t i o n a lF I L E O C L
statement is needed.
T h e s y s t e ma l l o c a t e sd i s k s p a c ef o r t h e
$lNDEX45 or
$ l N D E X 4 0 w o r k f i l e p r i o r t o a l l o c a t i n gs p a c ef o r a n y
o t h e r f i l e ( s ) u s e d b y t h e p r o g r a m . T h e r e f o r e ,i t y o u
specify
a l o c a t i o nf o r a n y f i l e ( s ) u s e d b y t h e p r o g r a m ,
Vou should
a l s os p e c i f y a l o c a t i o n f o r t h e $ I N D E X 4 S o r
$lNDEX40
w o r k f i l e . T h i s p r o c e d u r ep r e v e n t st h e s y s t e mf r o m
attemptin0 to assignthe same disk spaceto two
different
fi les.
F o r a d d i t i o n a lc o n s i d e r a t i o n so n w h e n t o s p e c i f y
$lNDEX45
or $lNDEX40, seeFile Share under Multiprogramming
Consi dera il on s an d R estricti on s.

MULTIVOLUME DISK FILES
W h e n a f i l e i s t o o l a r g ef o r o n e m a i n d a t a a r e a ,
it can be
c o n t i n u e do n o n e o r m o r e s u b s e q u e nm
t ain daraareas:
s u c h f i l e s a r e c a l l e dm u l t i v o l u m e f i l e s . ( A v o l u m e
is one
m a i n d a t a a r e a . ) M u l t i v o l u m e f i l e sa r e n o t s u p p o r t e d
on
s i m u l a t i o na r e a s . M u l t i v o l u m e f i l e s c a n b e o n l i n e
or offline.
A f i l e i s o n l i n e i f a l l v o l u m e sa r e m o u n t e d w h e n
the program
b e g i n s .A n o n l i n e f i l e h a sa n e q u a l n u m b e r o f
UNIT and
P A C K p a r a m e t e r sa; n o f f l i n e f i l e h a s f e w e r
UNIT param_
e t e r s( s h a r e ss a m eu n i t ) . O f f l i n e m u l t i v o l u m e
f i l e sc a n
o n l y b e u s e do n d r i v e s 1 ( w h e n a n l p L i s p e r f o r m e d
from
3344 drive3) and 2.
The way in which a disk multivolumefile is created
depends
on the file type. For a sequentiao
l r i n d e x e df i l e . t h e
records are stored in consecutivelocations, in
the order
t h e y a r e r e a d . O n e m a i n d a t a a r e ai s f i l l e d a t a
time. For
s e q u e n t i a fl i l e s ,e a c h v o l u m e m u s t b e f i l l e d b e f o r e
the next
v o l u m e i s a l l o c a t e da n d l o a d e d . F o r i n d e x e d f i l e s ,
each
v o l u m e n e e d n o t b e f i l l e d . E a c h i n d e x e dv o l u m e
is loaded
u n t i l a k e y f i e l d i s r e a c h e dt h a t i s h i g h e r t h a n t h e
HIKEy
f o r t h a t v o l u m e ;t h e n t h e n e x t v o l u m e i s a l l o c a t e d
and
l o a d e d . I n d e x e df i l e s m u s t b e l o a d e di n k e y f i e l d
sequence.
A m e s s a g eo c c u r si f a v o l u m e i s f i l l e d a n d t h e r e i s
no record
with a key field equalto the HIKEy for that vorume.
F o r e x a m p l e ,s u p p o s et h e H I K E y f o r a v o l u m e
is 166,and
a r e c o r dw i t h t h e k e y f i e l d 1 6 2 i s l o a d e d . l t i s l e s s
than the
H I K E Y , s o i t i s l o a d e do n t h e v o l u m e . N e x t ,
a r e c o r dw i t h
the key field 170 is loaded. Record 170 is loaded
on the
next volume, and an error messageoccurs. The
reasonfor
the error messageis that a key field record equal
to 166
was not loaded before loading records to a new
volume.
This error messagecan be bypassed. A record can
De
l o a d e do n t h e n e x t v o l u m e , a n d a t s o m e f u t u r e
time a key
f i e l d r e c o r d l e s st h a n o r e q u a l t o t h e H I K E y
can be inserted.
A random add is required to add a record higher
than the
h i g h e s tk e y o n t h e v o l u m e b u t l o w e r t h a n o r e q u a l
to the
HIKEY.
I n d e x e da n d s e q u e n t i a fl i l e s m a y b e e i t h e r o n l i n e
or offline.
Removabledata modules can be used when sequential
or
indexed f iles are created. A data module is mounted,
the
system indicates when it is full or the high key is reached,
and then the next data module is mounted. When
two
d r i v e sa r e a v a i l a b l e t, w o d a t a m o d u l e sc a n b e m o u n t e d .
When the first one is completed, it can be replaced with
a
third while the program processesthe second data module.
I n e i t h e r c a s e ,n o m o r e t h a n 1 9 2 v o l u m e s ( g 6 f o r i n d e x e d
f i l e s )c a n b e u s e d p e r p r o g r a m .

Pageof GC21-5162-1
1979
lssued28 September
BvTNL: GN21-5674
S o a c ec a n b e a l l o c a t e do n a l l v o l u m e so f a m u l t i v o l u m e f i l e
i f t h e v o l u m e sa r e o n l i n e a t t h e t i m e o f t h e a l l o c a t i o n .
Spacecan also be allocated for an offline file, other than
the initial volume, but the volumes must be empty or space
known to be available. Both fixed and removable data
m o d u l e sc a n b e u s e dw i t h a n y o n l i n e m u l t i v o l u m e f i l e .
S p a c ef o r a v o l u m e o f a m u l t i v o l u m e f i l e i s r e s e r v e da f t e r
o n e o r m o r e r e c o r d sa r e p l a c e di n t h a t v o l u m e .
Directfiles must be online. The maximum number of
volumes, therefore, is two on a two-drive 3340 system, or
four on a four-drive 3340 svstem.
P r o c e s s i n og f f l i n e m u l t i v o l u m e f i l e s d e p e n d so n t h e a c c e s s
method a program uses. lf records are read from a sequent i a l o r i n d e x e df i l e , a d a t a m o d u l e i s m o u n t e d ; w h e n a l l t h e
records have been read from the data module, the next data
m o d u l e i s m o u n t e d . W i t h t w o d r i v e s ,t w o d a t a m o d u l e s
are mounted; when all the records have been read from the
first data module, that data module may be replacedwith
t h e t h i r d w h i l e t h e p r o g r a mr e a d sf r o m t h e s e c o n dd a t a
m o d u l e . W h e n o n l i n e ,a n y c o m b i n a t i o no f f i x e d a n d
r e m o v a b l ed a t a m o d u l e s i s a c c e p t a b l eb, u t a l l m u s t b e
mounted and must remainmounted. Only four volumes
w i l l b e u s e dd u r i n g o n l i n e r a n d o m p r o c e s s i n g( d i r e c t o r
indexed random accesses)regardlessof the number specified in the OCL.

T h e s e q u e n c en u m b e r i n d i c a t e st h e r e l a t i v ep o s i t i o n o f t h e
f i l e o n t h e t a p e v o l u m e a n d i s i n c r e m e n t e db y o n e f r o m
one file to the next.

Null Fileson Tape
A n u l l f i l e i s a f i l e o n d i s kt h a t h a sn o d a t ar e c o r d si n i t ;
f o r e x a m p l ea, n u l l f i l e m a y o c c u ri f a u s e r ' se r r o ro r e x c e p tion file hasno recordson somedaysbut doeshavesome
recordson other days. lf the userhasa procedurethat
alwaysbacksup that f ile to tape,it is importantto know
w h a t h a p p e n tso n u l l f i l e so n a m u l t i fi l e t a p ev o l u m e .

Unlabeled Tapes
A m u l t i f i l et a p ev o l u m ec a nc o n t a i na l l u n l a b e l e fdi l e s .
Whena file iscopiedto tape,it is followedby two tape
m a r k s( T M ) :
FILE1TM TM
l f a s e c o n df i l e i s a d d e dt o t h i s t a p ea n d a S E O N U M - 2
p a r a m e t eirs s p e c i f i e da,n d i f t h a t f i l e c o n t a i n sd a t a .i t w i l l
r e s u l ti n :
FILE1TM FILE2TM TM

MULTIVOLUME TAPE FILES
A tape f ile may also be too large for one tape and can be
c o n t i n u e do n o n e o r m o r e t a p e s . S u c h f i l e s a r e c a l l e d
m u l t i v o l u m et a p e f i l e s . ( A v o l u m e i s o n e t a p e . )
W h e n e n d o f v o l u m e i s r e a c h e do n a m u l t i v o l u m e t a p e f i l e ,
t h a t v o l u m e r e w i n d st o l o a d p o i n t a n d u n l o a d s . l f t h e d r i v e
t h a t i s t o c o n t a i n t h e n e x t v o l u m e ( w h e t h e rt h e s a m ed r i v e
o r a n o t h e rd r i v e ) i s n o t i n a r e a d y c o n d i t i o n , a n e r r o r
messageis issued.
Processingcontinues when the drive that is to contain the
n e x t v o l u m e i s m a d e r e a d y . W h e n u s i n g a l t e r n a t i n gd r i v e s ,
if the next volume is mounted and the drive is readywhen
e n d o f v o l u m e i s r e a c h e d ,p r o c e s s i n gc o n t i n u e sw i t h o u t
stopping.

B u t i f t h e s e c o n df i l e ( F l L E 2 )c o n t a i n sn o d a t a ,t h e r e s u l t
is:
FILE1TM TM TM
A n d i f a t h i r d f i l e ( F l L E 3 ) i s a d d e dt o t h i s t a p e ,S E O N U M - 2
must be specifiedand the resultis:
FILE1TM FILE3TM TM
I n t h i s e x a m p l ei,f t h e t h i r d f i l e i s a d d e d a, n dS E O N U M - 3
i ss p e c i f i e d
i n s t e a do f S E O N U M - 2a, h a l t w i l l b e i s s u e du n l e s sE N D - L E A V Eh a d b e e ns p e c i f i efdo r t h e s e c o n df i l e .
I n a n y e v e n tw
, i t h u n l a b e l e tda p e sa, n u l l f i l e i s n o t s a v e d .

MULTIFILE TAPE VOLUMES
J u s t a s a d i s k n o r m a l l y c o n t a i n sm o r e t h a n o n e f i l e , m o r e
than one file can exist on a reelof tape. lf this is the case,
each file has an associatedfile number. The system uses
t h e S E O N U M p a r a m e t e ro n t h e t a p e F I L E O C L s t a t e m e n t
t o i n d i c a t et h e f i l e n u m b e r a n d p o s i t i o n t h e t a p e t o t h e
d e s i r e df i l e .
File Facilities

2-25

P a g eo f G C 2 1- 5 16 2 - 1
lssued 28 September 1979
By TNL: GN21-5674

Labeled Tapes
With labeledtapes,however,null filescan be saveo
on tape
a n d l a t e rr e s t o r e d
t o d i s k . l f o n ef i l e c o n t a i n i n d
g a t ai s
w r i t t e nt o t a p e ,i t l o o k sl i k e t h i s :
VOL HDR TM FILE1TM TL TM TM
w h e r eV O L r e p r e s e n t h
s e v o l u m el a b e l ,H D R r e p r e s e n t s
t h e h e a d e lra b e l sT. L r e p r e s e n t h
s e t r a i l e rl a b e l sa. n dT M
represents
a tape mark.
l f a s e c o n df i l e i s a d d e dt o t h i st a p ea n d a S E O N U M _ 2
p a r a m e t ei rs s p e c i f i e da,n d i f t h a t f i l e
c o n t a i n sd a t a .i t w i l l
r e s u l ti n :
VOL HDR TM FILE1TM TL TM HDR TM
FILE2 TM TL TM TM
B u t i f t h e s e c o n df i l e c o n t a i n sn o d a t a ,t h e r e s u l ti n s t e a d
is:
VOL HDR TM FILE1TM TL TM HDR TM
TM
TL TM TM
A n d i f a t h i r d f i l e i s a d d e dt o t h i s t a p e( S E O N U M _ 3 ) ,
the
r e s u l ti s :
VOL HDR TM FILE1 TM TL TM HDR
TM TM
TL TM HDR TM FILE3 TM TL TM TM
l f t h e t h i r d f i l e ( F l L E 3 ) i s a d d e da n dS E O N U M
2 i ss p e c i f i e d i n s t e a do f S E O N U M - 3t,h e nt h e r e s u l ti s
a sf o l l o w s :
VOL HDR TM FILE1TM TL TM HDR
TM
FILE3 TM TL TM TM
Note that in any caseif a file is addedto a multifile
tape,
it is assumed
to be the lastfile on the tapeand all subse_
quent fileson the tapeare not accessible.

2-26

P R O G R A M M I N G C O N S ID E R A T I O N S
l f t h e r o o t s e g m e n to f a p r o g r a m i s t o o l a r g e ,t h e s y s t e m
m a y i s s u ea n e r r o r m e s s a g ew h i l e a t t e m p t i n g t o o p e n
a disk
f i l e . T h i s m e s s a g ei n d i c a t e st h a t c e r t a i nf i e l d s a r e l o c a t e d
a t a m a i n s t o r a g ea d d r e s sa b o v e l o g i c a l4 0 K ( i n a b a t c h
partition)or above24K (tor a CCp task).
N o r m a l l y ,t h i s
messageoccurs only if the program has large l/O
areas.
F o l l o w i n g a r e s o m e a c t i o n st h a t m a y b e t r i e d i n
attempting
t o c i r c u m v e n tt h i s m e s s a o e :
o S p e c i f yS H A R E - N O f o r f i l e s u s e d i n
a batch partation.
.

R e d u c et h e b l o c k s i z eo f f i l e s i n t h e p r o g r a m .

.

R e m o v ed o u b l e b u f f e r s p e c i f i c a t i o n s .

o

R e d u c et h e s i z eo f t h e c o r e i n d e x .

o

B e c o m p i l et h e p r o g r a ms p e c i f y i n ga s m a l l e re x e c u t i o n
size(for example.40K for a batch program;Z4Kfor
a
CCPprogram).

For additional information , see Disk Device Support
rn the
System/3 Model lS System Control programming Macros
Reference Man ual, GC21 -7609.
U s i n gP r o g r a mN u m b e r S 7 O 4 - 5 C 2a, n y o p e n f i l e i s c l o s e d
w h e n e n d o f j o b o c c u r so r a 2 o r 3 o p t i o n i s t a k e n t o
a
m e s s a g e .U s i n g P r o g r a mN u m b e r 5 7 0 4 _ S C . lo p e n f i l e s
,
are
c l o s e da t e n d o f j o b o r w h e n a 2 o p t i o n i s t a k e n t o a
m e s s a g eo; p e n f i l e s a r e n o t c l o s e dw h e n a 3 o p t i o n i s
taken
to a message.
C O B O L , F O R T R A N , a n d a s s e m b l eur s e r sc a n c o n t r o l f i l e
o p e n a n d c l o s e ; R P G l l u s e r sc a n n o t c o n t r o l o p e n a n o
c l o s e . A s a r e s u l t ,e a c h p r o g r a m o r s u b p r o g r a mm u s t
e x p l i c i t l y c l o s ea n y f i l e t h a t i s o p e n e d .

Page
of GC21-5162-l
1979
lssued
28 September
By TNL: GN2'l-5674

LibraryFacilities
L I B R A R YD E F I N I T I O N
A libraryis a spaceon disk usedfor storingprogramsand
procedures.Therearetwo typesof libraries:sourceand
object. Sourcelibrariescontainsourceprogramsand proceduresof OCL statements;
objectlibrariescontainexecutable
objectprograms(loadmodules)and nonexecutable
object
programs(routines).Librariesareonly locatedon simulation areas,not on maindataareas.
programis usedto:
The System/3library maintenance
Createlibraries

The followingillustrationshowsthe relativelocationof a
sourcelibrarywith respectto the userareaand object
library:

SourceLibrarv Directory
S o u r c eL i b r a r yc o n t a i n i n g :
o Sourceprogram
statements
o Procedures

Entersourceprograms.
and object
OCL statements,
programsinto I ibraries
Oblect Library Directory

M a i n t a i nl i b r a r i e s
Object Library

Createf ilescontaininglibraryentries
programcreatesa separate
direcThe librarymaintenance
Every
library
entry
has
corresponda
tory for eachlibrary.
ing entry in its librarydirectory. The directoryentry containssuchinformationasthe nameand locationof the
libraryentry. The programalsocreatesa systemdirectory
that containsinformationabout the sizeand available
space
in librariesand their directories.

aretwo logicallydifferand procedures
Sourcestatements
ent typesof entries.Whentheseentriesarecopiedinto
sourcelibraries.they aregivendifferentsourcelibrary
designations.
Sourceprogramsaregivenan S librarydesigprocedures
are givena P librarydesignation.The
nation;
s h o w st h e l o g i c ael n t r i e sw i t h i n t h e
f o l l o w i n gi l l u s t r a t i o n
s o u r c el i b r a r y :

S O U R C EL I B R A R Y
SourceLibrary
A sourcelibraryis a disk spacefor storingsourceprograms.
specifications,
and procedures.Sourceprogramsaresetsof
userinstructions,
the mostcommonof which are RPG ll
specifications.
sourceprogramsand disk sort sequence
Procedures
usedto load
aregroupsof OCL statements
programsand may be followedby input datafor the programs.(Procedures
for systemserviceprogramscan,for
example,containcontrol statements.)

S L i b r a r yE n t r i e s
ano
P L i b r a r yE n t r i e s

The S libraryentriesaresourceprograms.Procedures
cannotbe executedfrom this library.
which can be executed.
The P libraryentriesare procedures

File Facilities

2-26.1

T h i s p a g ei n t e n t i o n a l l y l e f t b l a n k .

2-26.2

Physical Characteristics

OB.JECT
LIBRARY

A sourcelibraryhasthe followingphysicalcharacteristics:

An objectlibrary is a disk areausedfor storingobject
programsand routines.Objectprograms(alsoknown as
l o a dm o d u l e so r e x e c u t a b lper o g r a m sa)r ep r o g r a mas n d
s u b r o u t i n et sh a t c a n b e l o a d e df o r e x e c u t i o n .R o u t i n e s
(or nonexecutable
programs)are programsand subroutines
that needto be link-editedbeforethey can be loadedfor
e x e c u t i o n .R o u t i n e a
s r eu s e db y c o m p i l e r a
snd(except
f o r F O R T R A N )m u s tb e o n t h e s a m es i m u l a t i o n
a r e aa s
t h e c o m p i l e ru s i n gi t .

o S i z e : T h e m i n i m u ms i z eo f a s o u r c el i b r a r yi s o n et r a c k ,
o Directory: The directoryactsasa tableof contents
and
containsthe nameand locationof eachsourcelibrary
entry. The first two sectorsof the first track arealways
assigned
to the directory,with additionalsectorsused
as needed.
o Organization
of Entries: Entries(sourcestatements
and
procedures)
within the sourcelibraryneednot be stored
in consecutive
sectors.An entry can be storedin widely
separated
sectors.Within eachsectoris a pointerto the
sectorthat containsthe next part of the entry.

T h e f o l l o w i n gi l l u s t r a t i o snh o w st h e r e l a t i v el o c a t i o no f
the objectlibrarywith respectto the sourcelibraryand
u s e ra r e a :

The boundaryof the sourcelibrarycannotbe expanded;
t h e r e f o r ea, n e n t r y m u s tf i t w i t h i n t h e a v a i l a b llei b r a r y
space.The systemprovidesmaximumspacewithin the
prescribed
limits of the sourcelibrary by compressing
entries.That is, all duplicatecharacters
are removeo
from the entries. Later,if the entriesare printedor
punched,written to diskette,or copiedto a f ile,the
duplicatecharacters
are reinserted.

S o u r c eL i b r a r y ( o p t i o n a l )
Object Library Directory
Object Library containing:
1 . E x e c u t a b l eo b j e c t
programs

o Location: A sourcelibrarycan only be locatedon a
simulation
a r e an
. o t o n a m a i nd a t aa r e a .T h e r ei s o n l y
one sourcelibraryper simulationarea;however,source
librariesmay resideon severalsimulationareas.
rVofe.'Whenthe sizeof the sourcelibrary is changedor
the sourcelibrary is reorganized,
all temporaryentries
aredeleted.

2 . R o u t i n e s( n o n e x e c u t a b l e
object programs)

Upper Boundary

UserArea
A.-a.

r-.<-V

Library Facilities

2-27

The objectlibrarycontainstwo logicallydifferenttypes
of entries: objectprogramsand routines.Whentnese
entriesarecopiedinto the objectlibrary,they aregiven
differentobjectlibrarydesignations.
Objectprogramsare
g i v e na n O l i b r a r yd e s i g n a t i o n
r o; u t i n e sa r eg i v e na n R
l i b r a r yd e s i g n a t i o nT. h e f o l l o w i n gi l l u s t r a t i o n
s h o w st h e
logicallibraryentrieswithin the objectlibrary.
Object Library

Library Entries

PermanentEntries

and

R L i b r a r yE n t r i e s
Library Entries

TemporaryEntries

and

R L i b r a r yE n t r i e s

The O libraryentriesareexecutableprograms.They are
loadedby the LOAD starement.
The r9 libraryentriesarenonexecutable
routinesusedby
thecompiler.

Physical Characteristics
An objectlibraryhasthe followingphysicalcharacteristics:
o Size: The sizeof the object librarydepends
on whether
or not the library is on a systempack (a simulationarea
containingthe systemprograms).An objectlibrarycan
be createdon any simulationarea,but one librarycontainingthe systemprogramsmust be online. The
m i n i m u ms i z eo f a n o b j e c tl i b r a r yi s 3 t r a c k s .
The disk areafor an objectlibraryconsistingof system
programsmustalsobe largeenoughto containa scheduler
work areafor disk systemmanagement
and a system
historyarea. The numberof tracksfor the scheduler
work areaand the systemhistoryareaarenot included
in the numberof tracksspecifiedfor the library;the
library maintenance
programcalculates
and assigns
the
additionafspace. (SeeSchedulerWork Area under
File Facilities.l

2-28

a Directory' The directoryactsasa tableof conrents
and
c o n t a i n st h e n a m ea n d l o c a t i o no f t h e o b j e c tl i b r a r y
e n t r i e s .l f t h e o b j e c tl i b r a r yi s o n a s y s t e mp a c k ,t h r e e
of the requested
tracksarereserved
for the directory.
lf not, only the first track is reserved
for the directory.
T h e u s e rm a y o v e r r i d et h e s ed i r e c t o r ys i z e sb y s p e c i f y i n g
t h e D I R S I Z Ep a r a m e t ecrn t h e A L L O C A T Es t a t e m e n t
o f t h e l i b r a r ym a i n t e n a n cper o g r a m .
o U p p e rB o u n d a r y :W h e nc o p y i n gt e m p o r a r ye n t r i e s
i n t o t h e o b j e c ti i b r a r y ,t h e u p p e rb o u n d a r yo f t h e l i b r a r y
a u t o m a t i c a l leyx p a n d sa sa d d i t i o n atlr a c k sa r en e e d e di f
t h e s p a c ef o l l o w i n gt h e o b j e c tl i b r a r yi s a v a i l a b l eT. h e
upperboundaryof the library is extendedto the end of
thesimulation
a r e ao r t o t h e f i r s tt e m p o r a r yo r p e r m a nent file. At the successful
completionof the copy,
the upperboundaryis returnedto the track boundarv
at the end of the lasttemporaryentry.
lf the copy wasnot completedsuccessfully,
the upper
b o u n d a r ym a y r e m a i ne x t e n d e d W
. h e na p e r m a n e n r
e n t r y i s p l a c e di n t h e l i b r a r yo r t h e l i b r a r yi s r e o r g a n i z e d ,
a l l t e m p o r a r ye n t r i e sa r ed e l e t e da n dt h e u p p e rb o u n d a r y
r e t u r n st o i t s o r i g i n al o c a t i o n .P e r m a n e netn r n e s
c a n n o te x c e e dt h e o r i g i n a ul p p e rb o u n d a r y .
To makeefficientuseof this feature,the areanexr to
the upperboundaryof the objectlibraryshouldbe kept
free of datafiles. Whendisk systemmanagement
auto_
maticallyallocates
f ile space,the areanext to the object
libraryis probablyfree because
the filesare placedas
c l o s et o t h e h i g he n d o f t h e s i m u l a t i o n
a r e aa sp o s s i b l e .
U s e r s h o u l da l s oa l l o c a t ef i l e st o w a r dt h e h i g he n d o f
thesimulation
a r e a .T h i sl e a v e rso o m f o r o b j e c tl i b r a r y
exoansion.
o Organization
of Entries: Entriesarestoredin the object
libraryserially;that is, a 20-sectorprogramoccupies20
consecutive
sectors.Temporaryentriesfollow all
p e r m a n e net n t r i e si n t h e o b j e c tl i b r a r y .

Maintaining an Object Library
Gapscan occur in the objectlibrarywhenentriesare
deleted.The associated
directoryentriespoint to these
gaps.Whenthe library maintenance
programplacesa new
p e r m a n e netn t r y i n t h e l i b r a r y ,i t s e a r c h et h
sedirectory
for a gapthat hasthe samenumberof sectors,or the fewest
sectorsoverthe numberrequiredby the new entry. lf the
e n t r y i s s m a l l etrh a nt h e g a p ,t h e l a s tp a r t o f t h e g a pi s n o t
p o i n t e dt o b y a d i r e c t o r ye n t r y . S i n c et h i s g a ph a sn o
d i r e c t o r ye n t r y .i t c a n n o tb e u s e du n t i l t h e l i b r a r vi s
reorgan
ized.
The library maintenance
programshouldbe usedto reorg a n i z et h e l i b r a r yw h e na g r e a tn u m b e ro f a d d i t i o n sa n o
deletionshavebeendone (creatingan excessive
numberof
u n a v a i l a b sl ee c t o r s )o,r w h e nt h e r ei s n o a p p a r e nrto o m .
I n r e o r g a n i z i negn t r i e st,h e l i b r a r ym a i n t e n a n cper o g r a m
deletestemporaryentriesand shiftsentriesso that gapsdo
not appearbetweenthem. This reorganization
makesmore
sectorsavailable
for use.
B y p r i n t i n gt h e s y s t e md i r e c t o r yt.h e l i b r a r ym a i n t e n a n c e
programcan be usedto determinehow many sectorsare
available.

LIBRARYLOCATIONS
Librariescan be locatedby the jystemanywhereon a simulationarea. However,the locationof a sourcelibrarvwith
respectto an objectlibrary is alwaysthe same:
UserArea
D a t af i l e s

S o u r c eL i b r a r y
o Procedures
o Source
statements

System
History
Area

Checkpoint/
restart
Area

T r a c k s0 - 7
Object Library
o Object

UserArea
D a t aF i l e s

programs
o

Routines
Extendable
Upper
Boundary

lf spaceis allocated for only a source or object library, the
l i b r a r y m a i n t e n a n c ep r o g r a m p l a c e st h e l i b r a r y i n t h e f i r s t
a v a i l a b l ed i s k a r e a l a r g ee n o u g h t o c o n t a i n t h e l i b r a r y . W h e n
a l l o c a t i n gs p a c ef o r a s o u r c el i b r a r y o n a s i m u l a t i o na r e a
c o n t a i n i n ga n o b j e c t l i b r a r y , a n a r e al a r g ee n o u g h f o r t h e
s o u r c el i b r a r y m u s t i m m e d i a t e l yf o l l o w t h e o b j e c t l i b r a r y .

T h e l i b r a r y m a i n t e n a n c ep r o g r a m m o v e st h e o b j e c t l i b r a r y
to allow spacefor the source library to precede it. lf an
o b l e c t l i b r a r y i s b e i n g a l l o c a t e do n a s i m u l a t i o na r e aw i t h a
s o u r c el i b r a r y , s p a c ef o r t h e o b j e c t l i b r a r y m u s t i m m e d i a t e l y
f o l l o w t h e s o u r c el i b r a r v .

Librarv Facilities

2-29

STORINGPROGRAMS
T h r e e m e t h o d sa r e a v a i l a b l ef o r s t o r i n g p r o g r a m s
into
libraries:the library main. ranceprogram,
a s p e c i fi c a t i o n
o n t h e R P G l i C o n t r o lC a , a n d t h e
,
C O M P I L EO C L
staternen t.

Library Maintenance program: Depending
on user specifi_
c a t i o n s ,t h e l i b r a r y m a i n r e n a n c ep r o g r a m
can storepro_
g r a m sb y c o p y i n g e n t r i e sf r o m o n e
l o c a t i o nt o a n o t h e r
( g i v i n gn e w n a m e s )w i t h i n a l i b r a r y ;
c o p y i n g e n t r i e sf r o m
o n e l i b r a r y t o a n o t h e r g r v t n gn e w n a m e si f
r e q u i r e o ;c o p y _
i n g e n t r i e sf r o m t h e s y s t e m r n p u t d e v i c e
t o a l i b r a r v ;o r
c o p y i n g e n t r i e sf r o m a f i l e t o a l i b r a r v .
( S e eP a r t 4 f o r a d d i t i o n a l i n f o r m a t i o n
on the librarv
m a t n t e n a n c ep r o g r a m . )

RPG ll Control Card: RpG ll can indicate
the type of
object program output after the system compiles
a source
program. The compiled program can
be stored in an object
l i b r a r y , p u n c h e d i n t o c a r d s ,o r w r i t t e n t o a d i s k e t t e .
A
p r o g r a mw r i t t e n a s a t e m p o r a r y e n t r y
in the objectlibrary
is deleted by the next program written permanently
in the
object library or by the next program of the
same name
written asa temporary entry in the object librarv.
The
o b j e c t p r o g r a mi s w r i t t e n i n t h e o b j e c t r i b r a r y
that contains
t h e c o m p i l e r , u n l e s sa C O M p I L E s t a t e m e n ti n d i c a t e s
otherwise.
C o l u m n 1 0 o n t h e R p G l l C o n t r o l C a r d i s u s e dt o
specify
t h e o b j e c t o u t p u t . C o l u m n s 7 b - 9 0 a r e u s e dt o
nametne
o b j e c t p r o g r a m . W h e n a n a m e i s n o t a s s i g n e dR
, pGOBJ
i s a s s u m e d . F o r d e t a i l e di n f o r m a t i o n o n t h e s e
s p e c i if c a tlons, see the IBM System/3 RpG ll Reference Manual.

sc21-7504.

CAMPILEOCL Statemenf.-The COMPILEOCL srarement
t e l l st h e s v s t e mt o :
C o m p i l e a s o u r c ep r o g r a m f r o m a s o u r c el i b r a r y
ano
s t o r et h e o b j e c t p r o g r a m i n a n o b j e c t l i b r a r y ,
or
C o m p i l e a s o u r c ep r o g r a m f r o m t h e s y s t e mi n p u t
device
a n d s t o r et h e o b j e c t p r o g r a m i n a n o b j e c t l i b r a r v

For the format of this statement,seeCOMpILEstatement
i n P a r t1 o f t h i s m a n u a l .

2-30

SampleStatements

Thissamplejob streamtellsthe systemthat the source
p r o g r a mn a m e dS A L E Si s l o c a t e do n F 1 . T h e O B J E C T _ R l
keywordparametertellsthe systemto placethe object
p r o g r a mo n R 1 .

Thissamplejob streamcompilesa sourceprogramfrom the
s y s t e mi n p u td e v i c ea n d s t o r e si t i n a n o b j e c tl i b r a r yo n R 1 .
lf the OBJECTparameterwasnot coded,the program
would be compiledand placedinto the sameobjectlibrary
a st h e c o m p i l e (r F 1 ) .

Library Facilities

2-31

P a g eo f G C 2 1- 5 1 6 2 - 1
lssued 28 September 1g79
By TNL: cN2t-5674

PROCEDURES
Procedures
aresetsof OCL statements
in a sourcelibrary.
Procedures
arestoredin the sourcelibraryvia the library
maintenance
program.Sincethe recordsin the source
libraryarecompressed,
a nestedprocedurecontaininga
CALL statementshouldnot be modifiedby a program
run
aspart of that nestedprocedure.A procedurecannot
containmore than one LOAD statementand cannor
contain any JOB statements.All other OCL statements,
except
/&, /* , and/., areallowedin procedures.The CALL state_
ment is allowedonly in nestedprocedures.LOAD *
state_
mentsare allowedin procedures;
however,the object
programmust be readfrom the systeminput
device.
A m a x i m u mo f 3 1 c o n t r o ls t a t e m e n tcsa n b e i n c l u d e d
in
procedures
for the systemserviceprograms.The control
statements
must follow the OCL statements
in the proce_
dure. A RUN statementmust be the lastOCL statement
in the procedureto separate
the OCL statements
from the
control statements.The RUN statementin the job stream,
ratherthan the one in the procedure,causesthe system
to run the program.
The followingexampleshowshow to createa procedure
w i t h t h e l i b r a r ym a i n t e n a n cper o g r a m( $ M A I N T ) . T h e
p r o c e d u rn
e a m ei s P R O C l ( N A M E - p R O Ci1n
COpystatem e n t ) . T h i s n a m ei d e n t i f i e tsh e p r o c e d u r e
i n t h es o u r c e
library. The procedureis placedin the sourcelibraryon
F l ( T O - F 1i n C O P Ys t a t e m e n t )T. h i sp r o c e d u r e
isreferred
t o i n a l l o f t h e f o l l o w i n ge x a m p l e s .

OCLbeing
copiedto the
sourcelibrary
asa procedure

To merge the procedure (unchanged)into the job stream,
two statementsare used in the job stream; this is tne
normal procedure call.

Pageof GC21'5162-1
lssued28 September1979
ByTNL: GN21-5674

in any of the statements(exceptthe INCLUDE
Parameters
statement)in a procedurefor the first job stepcan be
placedbetween
changedby procedureoverridestatements
the CALL and RUN statements.Procedureoverridestatementsmodify the procedurefor the first job step. For
can be madeto procedure
example.the followingchanges
PROCl:

Statcrnentscan be added to a procedure by placing the
added statements between the CALL and RUN statements.
For example, to add a NOHALT statement to the procedure, the following statementsare needed in the job
stream:

o I n t h e f i r s t F I L E s t a t e m e n(tN A M E - D A L T O T )c,h a n g e
t h e R E C O R D Sp a r a m e t ef r o m R E C O R D S - l 5 0t0o
RECORDS-1750.
a Changethe parameterin the SWITCHstatementfrom
X X X 0 1 X X Ot o X X X 1 O X X 1 .
are neededin the job streamto
The followingstatements
c a l la n d m o d i f y P R O C l . N o t et h a t t h e N A M E p a r a m e t e r
i s a l s os u p p l i e di n t h e F I L E s t a t e m e n tT. h i s i s n e c e s s a r y
to which the changeapplies.
to identify the F ILE s'tatement
Therefore,the NAME parametercannotbe changed.

in a
Parameters
can be omittedfrom all OCL statements
procedureand then suppliedbetweenthe CALL and RUN
statements.For example,assumethe procedurecontained
the LOAD statementshown.

To run the ENDMONprogram.the entire LOAD statement
did not haveto be supplied;only the missingparameter
wasincludedin the job stream.

Note: lt a validoverridestatementis usedto changea
statementwhich containsan OCL error.an OCL error
message
will still be is:;ued.
Example
a parameterin a procedure
changinga parameter,
Besides
statementcan be entirely deletedif it is a keywordparamthe
eter. To deletea parameterin any of the statements,
with
followed
immediately
keywordand hyphenarecoded
parameter
(which
is
to
PACK
REEL
be
or
a comma. A
deletedby a proceduleoverridestatement)must precede
the parameterthat is to replaceit. The procedureoverride
statementin the followingexampledeletesthe RETAIN
parametercompletely'.

areloggedon the system
overridestatements
Procedure
log devicealongwith the statementsin the iob stream.

Library Facilities

2-33

The statementsfrom the procedureare
mergedwith the
precedingstatements
and printed.

/ / CALL PROC]F
, ,] ,
X X L O A DE N D M O N , R 2
x x F I L E N A M E - D A L T . T T U N I T - pF A
2 cr K - v ' L o 4 r R E C ' R D S - ' , 5 o o r R E T A I N - p
//

F I L E N A M E _ D A L T O T T R E C_ O
1 ,R7D5 S
0

x x F I L E N A M E - A . c r o rr L A B EL - T ' T A
L r u NI T - R i , , p A cK - v ' L o 2 , D A TE - r z / 4 / 7 6
X X S W I T C HX X X O ] , X X O
//

S W I T C HX X X I , O X X l ,

XX RUN
/ / NOHALT
//

RUN

Statementsprecededby XX representthe procedure
state_
mentsasthey appearin the sourcelibrary.
The CALL and
RUN statements
and any statementsintendedasoverrides
to procedurestatements
or additionsto the procedure
beginwith //.
Switchcharacters
can be usedto determinewhetheror
not a job stepwill be executed.The following
example
showshow they areusedto call a procedure
basedon the
resultsof a previousprogram.
Assumethat a programhasjust completed
executing
successfully
and hasset the externalindicatorsto 10,|01010.
The OCL statements
followingthe completedprogramare:

o
E

2-34

E

Step 1 is not executedbecause
the externalindicators
do not agreewith the switchcharacters.An infor_
mationalmessage
with the valueof the external
indicatorsis issued.The systemthen flushesto
the
next step.

E

Step2 is executedbecause
the externalindicators
agreewith the switchcharacters.(Theswitchcharacter X tellsthe systemto cancelthe compareoperation
with the relativeexternalindicator.)

E

Step3 is executedafter step 2 is completed.

Nested Procedures
Some proceduresare done in the same order every time a
j o b i s p e r f o r m e d . N e s t i n gp r o c e d u r e si s a c o n v e n i e n t
w a y t o l i n k t h e p r o c e d u r e sa n d r e q u i r e sa c a l l t o o n l y t h e
first procedure. Each procedure calls the next procedure
u n t i l t h e j o b h a s b e e nc o m p l e t e d .
Nested proceduresprovide severalbenefits:
a Programsare always run in the correct sequence.
a

Operator intervention (and chance of operator error)
is decreased.

o

F i l e sa r e l e s sl i k e l y t o b e d e s t r o y e da s a r e s u l t o f r u n n i n g
nclnrelatedprograms between steps of a job.

Here is an example of how nested proceduresmight be
u s e dt o b a c k u p a m a i n d a t a a r e ac o n t a i n i n gf i l e s t h a t w i l l
be used in the future. The OCL statementsand control
statementsto be entered from the system input device to
c o p y o n e m a i n d a t a a r e a( D 3 ) t o a n o t h e rm a i n d a t a a r e a
( D 2 ) w o u l d l o o k l i k e t h i s i f n e s t e dp r o c e d u r e sw e r e n o t
used:

Assume that the precedingOCL statementswere placed in
the source library as procedureswith the names DEALD2
and CYD3D2, respectively. The use of nested procedures
allows building a procedure to call other procedures. The
following example shows how a nested procedure is built to
c a l l t h e p r o c e d u r e sD E A L D 2 a n d C Y D 3 D 2 :

P l a c e di n
the source

(

librarvasa
J
procedure
t

named

CPYD32

Library Facilities

2-35

To call the two procedures
neededto performthe copy job
described,
only one CALL statementis requiredin the
job streamfrom the systeminput device.

SystemInput Device

Level1

// CALL CPYD32,Fi

CPYD32

// RUN

// CALT DEALD2.F1
/I CALLCYD3D2,Fl

Level2

DEALD2

')ll
\

I/
//
//
i/

\

CYD3D2

\\
\

//
//
//
//

\l
\l
This CALL statementlinks the job streamto the nested
procedure(CPYD32)usedto call the procedures
necessary
to performthe copy job. CpyD32 containstwo CALL
statementsthat call the two proceduresnecessary
to copy
D3 to D2.
Noticethat CPYD32containsonly CALL statements.Any
procedurewithin nestedprocedures
can consistentirely
of CALL statements
and doesnot needa RUN statement
to indicatethe end of the procedure.Nestedprocedures
allow an unrestrictednumberof CALL statementsin a
procedure.Therefore,CPYD32could havemore than
two
CALL statementsif it werenecessary
to add any procedures.

LOAD$DELET,F1
RUN
REMOVE...
END

LOAD $COPY.F1
RUN
C o P Y P A C K. . .
END

Pageof GC21-5162-1
lssued28 September1979
ByTNL: GN21-5674

daily reportson goods
For example,a companyissues
boughtand sold by callingthe DAY procedure.By nesting
procedures
together.ll CALL WEEK can be usedto write
a daily reportand a weeklyreport. Oncea month // CALL
MONTH is usedto write out daily. weekly,and monthly
r e p o r t s .F i n a l l y ,d a i l y ,w e e k l y ,m o n t h l y ,a n dy e a r l y
reportsarewritten oncea year by the YEAR procedure,
together.
which nestsall of the other procedures
// CALL YEAR

II CALL MONTH

/ / C A L LW E E K

// CALL DAY

YEAR
II CALI MONTH
// CALL ENDl

\
\\

\

I

't

MONTH
/I CALIWEEK
// CALL MONSUM
ENDl
Year End
Report

WEEK

I
o*S

// CALL DAY

r'i

can be nested
No more than nine levelsof CALL procedures
aredeterminedby the
together. Levelsof procedures
awayfrom the systeminput
numberof CALL statements
devicea procedureis located. In this example.when
ll CALL YEAR is givenin the systeminput device,the
YEAR procedurewould be one levelawayfrom the system
aretwo levels
input device. MONTH and ENDl procedures
awayfrom the systeminput devicewhen // CALL YEAR
i sg i v e n .
and control
fewerOCL statements
With nestedprocedures,
for systemserviceprogramsareneededin the
statements
job streamfrom the systeminput device. However,certain
work:
rulesmust be followedto makenestedprocedures
o No morethan nine levelsof procedures
are permitted.
o Eachproceduremay havean unrestrictednumberof
to the next levelof procedures.
CALL statements
o Only control statements
for systemserviceprograms
a n ds p e c i f i c a t i o nf osr d i s ks o r t c a nf o l l o w a R U N
can be includedin a
statement;31 control statements
procedure.

I/ CALTWEKSUM
MONSUM
Monthly
Report

N

Procedureoverridesare mergedwith the first similar
(sameidentifier)statementbeforethe RUN of the first
except
LOAD and RUN encounteredin the procedures,
the
based
on
merged
which are
for FILE statements,
p
a
r
a
m
e
t
e
r
.
NAME

l o Any OCL statementspermittedbeforethe RUN statement in the job streamarealsopermittedanywhere
beforethe RUN statementin a procedure.

Example of Nesting Procedures
assumethe NOHALT
As an exampleof nestingprocedures,
operatorintervention.
statementis to be usedto decrease
p
r
o
c
e
d
u r e tsh, e N O H A L T
of nested
ln the illustration
placed
the
between CALL and RUN
statementcould be
input
device. In this case,it
in the system
statements
statementfor the
OCL
would be readasan additional
be placedanywhere
it
could
procedure.
However,
DEALD2
procedure,
before
or
anywhere
CPYD32,
in the master
o
r
C
Y
D
3
D
2p r o c e t h e R U N s t a t e m e nitn t h e D E A L D 2
what
matter
followed
no
dures.The rule would still be
procedurecontainedthe additionalOCL statement.

o Procedure
additionsor overridessuppliedbetweenthe
CALL and RUN statementsin the job streamaremerged
only betweenthe first LOAD and RUN statements
encounteredin the Procedures.

LibraryFacilities 2'37

Example of Nestedprocedltre Restart
Changingthe valueof SWITCHstatement
f) permitsthe
followingprocedureto be restarted
from an;f the steps
within the nestedprocedure.In this
example,the proce_
dure will beginexecutingat step F
because
the SWITCH
statementsetsthe externalindicators
to agreewith the
switchcharacters
on the // CALL e anai CALL F
statements.

@ , r*,r.H oolooool
// CALLA,R1
// RUN

//9ALL B.R1,0001xxxx
//CALL E,Rl,OO1OXXXX
I / C A L LG , R 1 . O O 1 l X X X X

B
//OALL C.R1,00010001
//0ALL D,R1,00010010

c

I l_

//LOAD AA,Rl

// swtTcH00010010
// RUN
D

/ / L O A DB B , R l
// swlTcH00100001
// RUN
E

//C ,ALL
r ,nr ,ootoooor

F

/ / L O A DC C , R 1
// swtTCH00110001
// RUN

H

I l*

2-38

// LOADDD,R1
/ / s w t T c H0 0 1 1 0 0 1 C
// RUN
I
// LOADEE,R1
// RUN

C A T A L O G I N GT O A N A C T I V E L I B R A R Y
ProgramNumber5704-SC2enablesentries(permanentor
temporary)to be stored(cataloged)
in an objectlibrary
locatedon an activeprogrampack (a simulationareacontaininga programcurrentlyloadedfor executionin another
partition).

l f a l l o b j e c tl i b r a r ye n t r i e sa r ep e r m a n e net n t r i e st,h e n
the only conflict ariseswhencatalogingan entry of the
samenameasthe programexecutingin anotherpartition.
(For eitherpermanentor temporaryentries,the overlay
linkageeditor doesnot allow cataloginga modulewith
the samenameasan activeprogramrunningin a batch
partition.)

An objectprogramcan be catalogedto an activelibrary,
but in somecases,a programexecutingin anotherpartition
may be adverselyaffected. An active library is one from
which a programis loadedfor execution.That library
becomesinactiveafter end-of-jobstep for that program.
(Note,however,that a CCPlibrary is alwaysconsidered
active.l

Cataloging
to an activelibrary is an option chosenduring
generation.
system
The configurationrecordprogram
may alsobe usedto changethe supportselectedfor cataloging to an activelibrary (seeConfigurationRecordProgram$CNFIG in Part4 of this manual).The followingthree
levelsof catalogsupportareavailable:

lf an objectprogramdoesnot haveoverlays,onceit is
loadedinto a partitionfor execution,there is no further
needto access
that library. However,if an objectprogram
(afterthe program
requiressubsequent
libraryaccesses
hasbeenloadedfor execution),then an access
to that
libraryfrom anotherpartitionmay causeproblems.

o D i s a l l o wc a t a l o gt o a l l a c t i v el i b r a r i e sT. h i ss u p p o r ti s
identicalto the 5704-SC1supportfor catalogingto a
programpack. With this levelof support,any attempt
to catalogan objectlibraryentry to an activeprogram
pack resultsin an F/ message.(Theoverlaylinkage
only if the programexecuting
editor will issuea message
+
is a LOAD or a temporaryentry.)

Figure2-2 showswhat can happento anotherpartition
whencatalogingto an activelibrary.
Someexamplesof a programrequiringsubsequent
accesses
to a libraryare:
A programwhich requiresan overlayfrom disk during
execution,for example,an RPG ll objectprogram.
A programwhich requiresphaseoverlaysduringexecution, for example,a systemserviceprogram.

.

Allow catalogto activeCCPlibrariesbut not to other
activelibraries.This supportis identicalto 5704-SCl
supportfor all activelibrariesexceptthe CCPlibraries.
No message
will be issuedwhen attemptingto catalog
an objectlibraryentry to an activeCCPlibrary.

o Allow catalogto all activelibraries.No message
will be
issuedwhen attemptingto catalogan objectlibrary
entry to any programpack.
Cataloging
to an activelibrary is supportedby both the
program.
overlaylinkageeditor and the librarymaintenance

A FORTRAN programwhich invokesanotherprogram
from that library.

LibraryFacilities 2-39

Activity in this partition:
Catalogingto an active library
Temporary
Entry

Activity in Another partition
Ha.sa programbeenloade d ' i n t o a n o t h e rp a r t i t i o n
from the activelibrary?
Doesthe programbeing
catalogedhavethe same
name?
Does the program in the
other partition require
subsequentaccessesto
that libraryT

Yes

No

No

ls the programexecuting
i n t h e o t h e rp a r t i t i o na
LOADr program?

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

No

No

Yes

Yes

No

No

No

Yes

Yes

Yes

Yes

No

Yes

No

Yes

Yes

No

Yes

Yes

ls the programexecuting
i n t h e o t h e rp a r t i t i o na
Iemporaryprogram?
l s t h e o t h e rp a r t i t i o n
affected?

How is the other partition
affected?

Permanent
Entry

Yes

Yes

No

Yes

No

Yes

Yes

Yes

No

Yes

Yes

Yes

Overlay
segments
could be
changed
unexpect
edly.

Yes

Overlay
segments
could be
changed
unexpectedly.

T h e o l d versron
of the program,
rather tlran the
new ver ; i o n , i s
execute

I
I
I

I
I
I

The otcI v e r s i o n
o f t h e rrogram,
ratherr h a n t h e
new vel s i o n , i s
execut€

Overlay segments .**
c h a n g e du n e x p e c te d l y .
Overlay seg m e n t s c o u l d b e c l r a n 9 e o
u n e x p e c t €d l y .
rAll

O v e r l a y ss g m e n t sc o u l d b e c lr a n g e d
u n e x p e c la d l v .

of th" ocL for this program was processed
a n d t h e p r o g r a m w a s f e t c h e d i n t o s t o r a g ef o r
execution.
Figure 2-2. Catatoging to an Active Library

240

r"

The followingexampleshowsthe useof the option to
catalogto the activeCCPlibraries:
A userprogramupdatinga partsmasterfile is initiated
in partition 1 undercontrol of CCP. This programwas
l o a d e df r o m t h e C C Pl i b r a r yo n F 2 . W h i l et h e p a r t s
m a s t e fri l e i s b e i n gu p d a t e d R
, P Gl l ( i n p a r t i t i o n2 )
parts;the
compilesa programto order replacement
objectprogramis catalogedby the overlaylinkageeditor
t o t h e C C Pl i b r a r yo n F 2 . ( F 2 f o r p a r t i t i o n s1 a n d 2 i s
to the samesimulationarea.) After the parts
assigned
masterfile hasbeenupdated,the programto order
partscan now be executedin partition 1
replacement
undercontrol of CCP.
Without the capabilityto catalogto an activeCCP
library,it would be necessary
to catalogthe object
programto order replacement
partsto a non-CCP
library,shut down CCP,copy the objectprogramfrom
the non-CCPlibraryto the CCPlibrary,and start up
CCPagainbeforeexecutingthe program.
Followingis anotherexampleshowingthe useof the option
to catalogto the activeCCPlibraries:
CCPis executingin partition 1. batchprogramsare
executingin partition2, and programsare beingcompiled in partition3. All threepartitionsusethe same
programpack. Whilethe batchpartition (P2) is executs e i n gc o m p i l e d( i n P 3 )c a n b e s t o r e di n
i n g ,p r o g r a m b
the objectlibrary on the simulationareain useasthe
programpackfor the threepartitions.

Useof the option to catalogto all activelibrariesis illustratedby the followingexample:
A userprogramperformingan inventoryanalysiswas
i n p a r t i t i o n2 .
l o a d e df r o m R 1 a n d i s c u r r e n t l ye x e c u t i n g
Whilethe programis printingthe report,the library
program,executingin partition3, can be
maintenance
a monthly
usedto copy the programthat calculates
s u m m a r ya n a l y s i isn t o t h e o b j e c tl i b r a r yo n F 2 . R 1 f o r
partition 2 and F2 for partition3 areassigned
to the
s a m es i m u l a t i o na r e a .

UserConsiderations
lf you catalog a CCP module for which the program
find or format find option was not selectedat CCP
startup, the old version of the module (or a different
module than the one intended) may be used if the new
v e r s i o ni s p l a c e d i n a d i f f e r e n t l o c a t i o n i n t h e l i b r a r y .
lf you need to catalog an obiect module for which a
conflict exists (see Figure 2-21, change the other partition to HALT mode, and then perform the catalog
operation when the other partition comes to end-of-job
step. After the catalog operation, change back to
NOHALT mode and continue.

Librarv Facilities

241

SystemFacilities
I N I T I A L P R O G R A ML O A D ( I P L }
Systemoperationbeginswith an initial program
load (lpL)
which clearsmain storageand transfersthe supervisor
(a componentof the systemcontrol program)
from disk
into main storage.
IPL shouldbe performedeverytime the systempower
is
turnedon, the systempack is changed,or a recovery
procedurerequiresit. lt is initiatedfrom
one of the
followingfive sources:a card reader(alternate),
the F1
simulation
a r e ao n d r i v el , t h e R 1 s i m u l a t i o na r e ao n
d r i v e1 , t h e F l s i m u l a t i o na r e ao n d r i v e3 ( 3 3 4 4
only),
o r t h e R l s i m u l a t i o na r e ao n d r i v e3 ( 3 3 4 4o n l y ) .
IPL from drive3 providesoperationof the system
entirely
from fixed media. Also, it enablesdrives1 andlor
2 to be
usedasoffline deviceswhen thereare no simulation
areas
o n d r i v e s1 a n d 2 c u r r e n t l yi n u s e . I n t h i sc a s ei,t i s r e c o m m e n d e dt h a t a l l 5 4 4 4u n i t c o d e s( F l , F Z , R 1 , R 2 )
be
assigned
to simulationareason drives3 and 4.
Choosingany of the disk programload positionsresults
in
a s p e c i f i cs i m u l a t i o na r e ab e i n ga s s i g n etdh e F l o r
R1 unit
code. This assignment
overridesany assignment
madefor
that unit codeduringsystemgeneration.The assignment
of this unit code is madefor all partitions;this provides
a
commonsystempackfor all partitions. Followingare
the
simulationareasassigned
to the four switchpositions:
Switch Position
D i s k1 F l
D i s k1 R l
D i s k3 F l
D i s k3 R l

Area Assigned
D1A
D1B
D3A
D3B

Note: On a 2-, 3-, or 4-drive3340 system,lp L is perf
ormed
o n l y f r o m d r i v el .

After the IPL deviceis selectedand the programLoad
button is pressed,
the dateprompt appearson the CRT
screen.The date is enteredin the format chosenduring
systemgeneration(eithermm/ddlVVor dd/mm/yy). lf
the
systemdateis not given,it must be suppliedbefore
any
programexecutionis initiated. The date is
then supplied
with a DATE OCL statementor a DATE command.
The
systemdate is usedfor time stampingcertainmessages
by
t h e t i m e - o f - d am
y a c r oi n s t r u c t i o n st h, e R p G l l T I M E
operation
c o d e ,a n d b y t h e C O B O La n d F O R T R A NC F T O D
modules.The systemdatecan be changedby the operator
o n l y w i t h t h e D A T E c o m m a n da n d o n l y w h e na l l p a r t i t i o n s
areat end of job. lf the intervaltimer is specifiedat system
generation.
the systemdate is changedat midnight,when
the timer changesfrom 23.59.59to 00.00.00.
After the response
to the systemdatehasbeenprocessed,
the CRT displaycontainsEJ messages
for all the partitions.
At this point. therearethreepossibleactions:
o lf spoolingwasnot chosenduringsystemgeneration,
the operatorcan now initiateprogramexecutionby
responding
to the EJ message
for the partition in which
the programis to execute.
o Whenspoolingis chosenat systemgeneration,
the
spoolingsupportis loadedwith the supervisor
during
lPL. lf spool is not goingto be used,the operatorhas
the option to cancelspoolingsupportat this point.
The CANCELSPOOLcommandcausesthe spooling
routinesto be removedfrom main storage.makingaddi_
t i o n a lm a i ns t o r a g e
a v a i l a b lteo a n y p a r t i t i o n . ( y o u
must performanotherlpL when spoolingsupportis
desired.)The operatorcan now initiateprogramexecution by responding
to the EJ message
for the partition
in which the programis to execute.

a Whenspoolingis to be used,the operatorcan start
spoolingeither by responding
to an EJ message
for a
partitionor by enteringa START SPOOLcommand.
Activatingspoolautomaticallyby initiatingexecution
in a partitioncauses
spacefor the spoolfile to be
obtainedon a main dataareaaccordingto the disk unit
and sizespecifiedduringsystemgeneration.Any existi n g s p o o l e d a t ar e m a i n si n t h e s p o o lf i l e a n d i s n o t l o s t .
Activatingspoolwith a START commandis required
only to overridethe disk unit and/orsizeof the spool
file specifications
madeduringsystemgenerationor to
removeany existingspooleddata. After the START
commandhasbeenenteredand processed,
the CRT
displaycontainsSPOOLlS ACTIVE messages
for each
partitionbeingspooled.After jobs havebeenplaced
on the spoolreaderqueue,the operatorcan initiate
programexecutionby responding
to the program
message
for the partitionin which the programis to
execute. lSeeIBM System/3 Model lS User'sGuide to
Spooling, CG21-7632.1
On 5704-SC2,therearegenerallymore messages
on the
CRT than on 5704-SC1.lf all activemessages
do not
fit one CRT screen,it may be necessary
to scrollthrough
all messages
by repeatedlypressing
the PF12 key.
At this point, it may be helpfulfor the operatorto display
the systemstatusto determinethat the systemis set up
asdesired.The DISPLAYSTATUScommandprovides
the systemstatuson the CRT screen.

P R O G R A ME X E C U T I O N
A minimum of two OCL statements
arerequiredto loada
programinto the systemfor execution. LOAD and RUN
arethe two basicOCL statements
neededto load and
executeprograms;forthoseprogramsin which no disk
filesareused,they may be the only OCL statements.The
LOAD statementidentifiesthe programto be executed
and indicateswhetherthe programis to be loadedfrom
an objectlibrary or from the partition'ssysteminput
device.One LOAD statementis requiredfor eachprogram
executed.
The followingexamplesshowthe OCL statementsneeded
to loadtwo systemserviceprograms:disk initialization
a n df i l e d e l e t e .

// LQAD$DELET,Fl

The f ile deleteprogramis
loaded.

// LOAD$INIT,F1

T h e d i s k i n i t i a l i z a t i opnr o g r a m
is loaded.

System Facilities

243

To load an objectprogramfrom the system
input device,
an * must follow the word LOAD. (The *
tellsthe system
that an objectdeckfollowsthe RUN
statement.)A /*
statementmust follow the objectdeck;
any datawill
f o l l o w t h e / * . T h e f o l l o w i n ge x a m p l e
i l l u s i r a t etsh e s t a t e mentsrequiredto loada programfrom
the systemInput
device:

Job and Step processing
The input stream(programsto be processed)
is madeup
of two differentunits of work: jobs and job
steps.To
supportthesetwo units of work, the systemprovldes
two
processing
modes: job mode and stepmode, Job mode
is
indicatedto the systemby the presence
of JOB statements
in the input stream.Step mode is indicated
by the absence
of JOB statementsin the input stream(seeFigure
2-3).
B o t h m o d e sc a n b e u s e di n t h e m u l t i p r o g r a m m i n g
environ_
m e n t { t w o o r m o r ep a r t i t i o n sr u n n i n gc o n c u r r e n t l y )
or
w h e no n l y o n e p a r t i t i o ni s i n u s e . O n ep a r t i t i o n
c a nb e
r u n n i n gi n j o b m o d ew h i l ea n o t h e ri s i n s t e p
mode.Only
job modecan be usedin partitions
with spoolingactive.
Job StepMode
A job step is a requestfor executionof a program
and
includesa descriptionof the system,urour"",
requiredby
the program.A job stepmay or may not be part
of a job.
Whena job stepis part of a job, the systemis job
in
mode
{indicatedby the presence
of a JOB OCL statement}.When
rio JOB OCL statementshavebeenencountered
in the
input streamin which job stepsarerunning,the
system
is in stepmode. In stepmode,eachset of
LOAD/RUN
statements
is processed
independently,The systeminput
deviceis released
after the RUN statementhasbeen
processed
and the programis executing.Stepmode is not
supportedin partitionsthat havespoolingsupport
active.

The object program is temporarily copied
into the object
library on the system pack and then loaded
into main
storagefor execution. LOAD * programs
will be accepted
in any partition; 5704-SC2 permits severalpartitions
to
execute non-overlay LOAD * program
simultaneouslv.

rVofe; Someprograms.suchasthe RpG ll
compilerand
disk sort, requiresysteminput devicededication
while
executing,in which case,the systeminput
deviceremains
assigned
to that partition until thoseprogramsrelease
it.
An attributebit in the objectlibrarydirectory
entry
indicateswhetheror not a programrequires
system,nput
dedication.
Whena 2 or 3 option is selectedfor a systemmessage
and
the systemis in stepmode,only the currentjob
stepis
canceled.The systemflushesthe input streamuntil
a
JOB. LOAD, CALL, /., or l& statementis encountered.
l f a J O B , L O A D ,o r C A L L s t a t e m e ntte r m i n a t e s
theflush,
the systeminput devicestaysassigned
to the partition.

The LOAD statementis usuallythe beginningof a job
step'sOCL; however,the beginningmay be indicatedby
o n eo f t h e f o l l o w i n g :

All OCL statementsthat follow this record or the JOB
statement but precedethe next JOB statement are associatedwith the job. Any number of LOAD/RUN combina-

o The first recordof a job's OCL.

t i o n s a n d / o r C A L L / R U N c o m b i n a t i o n sc a n b e i n c l u d e d i n
a job. The job name from the JOB OCL statement is used
to identify, monitor, and control jobs when spooling.

o lf the previousjob stepwascanceledand the flush
endedon a I. or l&, the recordafter the l. or l&.
o l f t h e p r e v i o u jso b s t e pw a sc a n c e l e a
d n dt h e f l u s hd i d
not end on the /. or /&, the statementthat endedthe
f lush.
o lf the previousjob stepwasnot canceledand the partition is not in a nestedprocedure,the recordafter the
lastrecordreadfor the previousjob step.
o lf in a nestedprocedure,the statementafter the CALL
to a procedurewith a LOAD statement(endof procedure
goesto the statementafter the CALL in a nestedprocedure or. if at the end of a procedurenest,the nexr
recordin the input stream).
The statements
followingthis record(the beginningof a
job step'sOCL), throughthe next RUN statementand any
recordsreadfrom the input streamby this step,areassoc i a t e dw i t h t h i s j o b s t e p . I n j o b m o d e ,a n y i m m e d i a t e l V
following/. or l& statementis alsoincluded. lf the stepis
canceledin job mode,the end of the step'sOCL is the end
of the OCL for the job in which it is contained. lf the step
is canceledin stepmode,the end of the step'sOCL is the
statementbeforethe next /., /&, CALL, LOAD, or JOB
statement(the /. or /& statementis includedin this step).

When job mode is used, JOB OCL statementsmust be
i n c l u d e di n t h e i n p u t s t r e a mt o d e f i n e t h e j o b s . T h e y
indicate to the system that job mode is active and that the
system input device assignedto the partition will not be
r e l e a s e du n t i l j o b m o d e i s t e r m i n a t e d . P r o c e s s i n g
in job
mode ensuresthat a group of programs are executed
s e q u e n t i a l l y i, n t h e c o r r e c t p a r t i t i o n , a n d i n a p a r t i t i o n
that has sufficient main storageto accommodate all steps
of the job. When a job is initiated, the system checks the
P A R T I T I O N a n d C O R E p a r a m e t e r si,f s p e c i f i e d ,i n t h e
J O B O C L s t a t e m e n tt o e n s u r et h a t t h e j o b i s i n i t i a t e d i n
the correct partition and that enough main storage is
allocated to the partition to satisfy the CORE parameter.
lf either of these conditions is not met, the system issues
a messageand the job must be canceled. The system input
device, unless it is the CRT/keyboard, must be dedicated
t o t h e p a r t i t i o n b e i n gr u n i n j o b m o d e o n n o n s p o o l i n g
systems,or on systemsthat do not have input spooling.
To end job mode and return to step mode, a /. OCL statem e n t i s p l a c e d i n t h e i n p u t s t r e a m . J ' h i ss t a t e m e n ti n d i cates to the system that job mode is to be terminated and
the system input device is no longer ,iedicated to that job.
Job mode will resume when another JOB statement is
processed.
Job mode must be used when spooling is active. The spooli n g r o u t i n e s h a n d l ej o b s c h e d u l i n ga n d j o b i n i t i a t i o n . J o b s

Job Mode
A job is a groupof relatedjob stepsthat must be executed
in sequence.Eachjob stepmust be successfully
completed
beforethe next job stepcan be executed.A job includes
all the programs.files,and OCL statements
necessary
ro
c o m p l e t et h e t a s k . T h e b e g i n n i n og f a j o b i s u s u a l l yi n d i catedby the JOB OCL statementin the input streamfor a
partition. However,the beginningof a job's OCL may be
indicatedby one of the following:
o The first recordin an input streamafter lPL.
o With input spooling,the first recordof the spooled
recordsfor a job.
o The first recordfrom the input streamafter the last
recordof the previousjob (if the previousprocessing
modewasjob mode)or job step (if the previousprocessing mode wasstepmode).

are scheduled for execution basedupon the priority specified in the JOB statement. Spooling ensuresthat jobs are
executed in the requestedpartition, and that all job steps
are executed sequentially in the same partition. Jobs that
c a n n o t b e s c h e d u l e df o r i n i t i a t i o n b e c a u s et h e r e q u i r e dm a i n
storage is not availableare bypasseduntil the required
m a i n s t o r a g ei s a v a i l a b l e .
When a 2 or 3 option is selectedto a system messageand
t h e s y s t e mi s i n j o b m o d e , a l l r e m a i n i n gj o b s t e p si n t h e
job are canceled. On systemsthat have input spooling,
job processingin the partition resumeswith the next job
on the reader queue. On systemsthat do not support input
spooling, the job stream is flushed until a JOB or /. statement is encountered. lf output spooling is supported on
the system, spooled output that has been created by the
job are saved. lf a JOB statement terminates the flush, the
system input device stays assignedto the partition.

Svstem Facilities

245

Without Procedure
Input Stream OCL Job and Step
Classification (with cancellation
of a Job or Job 3tep as indicated)

Input Stream OCL Job and Step
Clarsification (without cancellation of a Job or Job stepl

Statements Read From
the Input Davice

Step2
c a n c ella t i o n

Step3

Step4
cancellation

Step I

aa:r _l
Irr // to^D

| //RUN
I
(data)

Job (step) 3
€nellation

flush

|

|
t

/..

I
I

Job (step) 3

|

-

I

// PRTNTERI

|

|

Job (step)4
canc€llation

Job (step) s

// Loc
II
// LoAD
|
I
//RUN
|
I
l
r
a
l
NoHALr-l
l-l/
// LoAD
|
I

r

// RUN

_l

Figure 2-3. (Part I of 21. Job and Job Step
Classif ication

246

J o b ( s t e p4)

J o b ( s t e D )5

Step
Mode

With Nested Procedures
Run with Canellation
Statements Read from the Input Stream or Proedures

of a Job or Job Step

Run without Cancellation
of a Job or Job Step

as lndicated
Input Str€8m

Proeduro
(Level 1l

r:::
::,7

Proedure
(Levol 2)

B

, CALLB

J o b ( s t e p )1

Procadur€
(Lsvel 3)

'l
Job (step)

// LOAD
// RUN

111

End of
Procedure B

ll cAttc

c
// CALLD

D
// HALT
J o b ( s t e p )2

End of
Procedure

J o b ( s t e p )2

// LOAD
// RUN

C a n c ella t i o n

E n do f
Procedure
C
// PRINTER
End of
Procedure A

PUNCH

_//

, CALLE

E
// CALL F

J o b ( s t e p )3

F
Job (step) 3

// LOG
E n do f
ProcedureF
// CALL G

// LOAD
// SWITCH
// SWITCH

// RUN
// RUN

E n do f
Procedure
G

J o b ( s t e p )4
Canellation

lI

// LOAD
// RUN

L
rI

E n do f
ProcedureE

/i HALT
II JOB

etc.

I__l

Job (step) 4

_l

I

Job 5

Figure 2-3 (Part 2 of 2). Job and Job Step Classification

System Facilities

247

E X T E R N A LI N D I C A T O R S
Externalindicatorsenablea userto influence
the execution
of a programfrom a sourceoutsidethe program
itself.
Eightexternalindicatorsareassigned
to eachpartition;
all externalindicatorsareset off during lpL. The
SWITCH
OCL statementis providedto modify the external
indicatorsfor the partitionin which the statement
is received.
Whena SWITCHstatementsetsan indicator,
that indicator
remainson until one of the followingoccurs:
.

Another SWITCHstatementsetsit off.

o A JOB statementis receivedin the partition.
.

A /. statementis receivedin the partition.in job mode.

o Another IPL is performed.
Eightcharacters
in the SWITCHstatementcorrespondto
the eightexternalindicarors.
I n t h e f o l l o w i n ge x a m p l ea, p r o g r a mu s i n go n ed i s kf i l e
(INVMSTR,an inventorymasterfile) uses
the SWITCH
statementto set on one externalindicatorand setoff
all
others.

S Y S T E MS E V E R I T YC O D E S
A severitycode is an indicatorto the systemspecifying
whenthe defaultoption can be usedfor a systemmessage.
Whena severitycode is not specifiedon the NOHALT
OCL
statement,the operatormust respondto all systemmessages
exceptinformationalmessages;
this includesinformational end-of-step
and end-of-jobmessages.

T h es e v e r i t yc o d ec a n b e 1 , 2 , 4 , o r g . T h e s y s t e m
selects
the defaultoption for systemmessages
of a severityless
than or equalto the code indicated.Severitycodes
and
defaultsareassigned
to most systemmessages
and cannot
be altered. lf the severityassigned
to a systemmessage
is
greaterthan the severityindicatedin the NOHALT
statement.the systemstops,waitingfor the operator,sresponse.
lf the severityassigned
to the message
is equalto or less
than the severityindicatedin the NOHALT statement,
the
systemselectsthe defaultoption for the systemmessage
and processing
continues.The severitycodedoesnot affect
systemmessages
havingno defaultoptionsor requiring
operatorintervention.Severitycode 1 is the leastsevere;
severitycode8 is the most severe.Severitycode6are reset
to no severityat end of job. For more informationon
systemmessages
and severitycodes,seeIBM Svstem/3
Model l5 SystemMessages,
GC21-5076.
rVofe.'Haltsdisplayedin the message
displayunit arenot
affectedby the SEVERlTy parameter.

JOB STREAM EXAMPLE
The examplein Figure2-4 illustratesthe processing
of a
job streamand someusesof OCL statements(part
1). The
exampleconsistsof two jobs with eachjob containing
relatedjob steps.The jobs involvethreefiles: cusromer,
inventory,and transaction.The customerfile contains
suchinformationascustomernamesand addresses,
total
amountsof chargesovera period,and total amountsof
paymentsoverthe sameperiod. The inventoryfile
contains
suchinformationas item numbersand descriptions,
prices
of the items,and the numbersof itemsin stock. The
transactionfile containssuchinformationasordersfor
items,refundordersfor itemsreturned,and cusromer
payments.The transactionfile is usedto update
the
inventoryand customerfiles.

The OCL statements
for the jobs areshownin Figure2-4.
Setsof statementsin the figurearenumbered.The explanationscorresponding
to thosenumbersaregivenin the
job streamsare indicatedby
followingsection.Separate
statements
4 through7 and 9 through 13.

ln eachof thesejob steps,a disk file is created.The
namesthat identify the files on disk are:
Customerf ile
I n v e n t o r yf i l e
T r a n s a c t i ofni l e

The LOG statementassigns
the 1403 printerasthe
log devicefor partition 1. The DATE statement
suppliesthe systemdate,10120176.The operatorcan
enterthe systemdate by responding
to the IPL
prompt for DATE or by enteringa DATE OCCor
OCL beforethe first JOB, LOAD, or CALL statement
after initial programload.

CUST
INV
TRANS

The datefor all files is 1O/2O176.
The cardscontainingthe recordsto be transferred
to disk arebeingreadfrom the samedeviceasthe
OCL statements.In eachcase,the cardsfollow the
OCL statements
that loadthe program.

The JOB statementplacesthe systemin job mode.
T h e j o b m u s tb e s u b m i t t e di n p a r t i t i o n1 ( P A R T I T I O N
parameter).

T o h e l p i d e n t i f ye a c hj o b s t e p ,a u n i q u en a m eh a s
beenplacedin eachof the LOAD statements.This
namefollows the // in the LOAD statement.

Theremust be 32K of main storageavailablein partition 1 to executethe job (COREparameter).

measure
/& statementsareusedasa precautionary
in casethe /* statements
had not beenplacedafter
the sourceand datacards.

Spoolingmust not be active(SPOOLparameter).
The JOB statementassigns
the nameBUILD to the
job.

The /. statementendsjob modeand actsasa delimiter
betweenjobs.

In the first job, threeprogramsare beingcompiled
and executed.Onetransfersthe customerfile from
cardsto disk,one transfersthe inventoryfile from
cardsto disk,and one transfersthe transactionfile
from cardsto disk. The OCL statements
for the
R P Gl l c o m p i l e ra r ei n a p r o c e d u r cea l l e dR P G . A
CALL statement,therefore,is usedto instructthe
systemto readthe procedureeachtime the compiler
is run. The procedureis locatedon the F1 simulation
area.

The secondiob usesfilescreatedin the first job.
The f irst job stepcompilesa program.The second
job stepexecutesthe programcompiledin the first
job step. The third job stepsortsa dataf ile.

I n e a c ho f t h e s ej o b s t e p st,h e R P Gl l c o m p i l e r i s
executedand createsa programwith the name
RPGOBJ.This programis placedin the objectlibrary
onF1.

T h e R P Gl l c o m p i l e ri s c a l l e dt o c o m p i l ea p r o g r a m
designedto updatethe inventoryfile. The program
i s p l a c e di n t h e o b j e c tl i b r a r yo n F 1 .

The JOB statementplacesthe systemback in job
m o d e . T h e n a m ea s s i g n etdo t h i s j o b i s I N V E N T O R Y .
Spoolingmust not be active. The job must be submitted in partition 1. Theremust be 32K of main
storageavailablein partition 1 to executethe job.

This job steploadsthe programcompiledin step 10
and updatesthe inventoryfile. This programcan also
print the transactionf ile records.The printerf ile is
conditionedby externalindicator1. The SWITCH
statementsetsexternalindicator1 on, which prevents
the printingof the records.
The lastjob stepsortsthe newly updatedinventory
file and writesthe sortedfile backto the samearea
on disk.
@

A /. statementendsjob mode.

System Facilities

249

o.
@,
{

oi
(

ol

'i
\

@J

.l
@{

'l
(

@

e
@
(

@.

o

(

Figure 24 (Part

2-50

o
@

\

o
(
(
@
(

@

@ (
Figure 24 lPart 2 ot 21. Job Stream Example

Svstem Facilities

2'51

MULTIPROGRAMMING
One of the prime measures
of a system,s
effioency is the
t h r o u g h p u tt;h a t i s .t h e a m o u n t
o f w o r k h a n d l e di n a
certainperiodof time. CpU processing
time and its usage
aremajor factorsthat influenc,
,yrt.r- througnput.
Multiprogramming,the concurrent
executionof more than
one program,providesefficientuse
of the CpU time by
allowingprogramsto sharethe CpU
facilities,thus reducing
the time the systemis in an unproductive
*ri, ,au,..
With multiprogramming,
control is transferredfrom one
task (for exampre,a userprogram
or a systemfunction such
asspool)to anotherwl

await
compr
etionof #;::*;Ti:[1i],*'::,

example. when a program requests
a print operation but
the printer is still busy with a previous
request.control is
transferred to another program.
Similarly, when a program
requestsa record to be read, it
must wait until reading has
been completed before it can process
the data. During the
wait, control is transferred to
another task. Controt is also
transferred when a system message
occurs. Since most
programs wait a significant
amount of time for l/O completion, sharing the system
facilities reducesunproductive
wait time.
W i t h m u l t i p r o g r a m m i n g ,a d i s k f i l e
m a y b e s h a r e db y t w o
or more programs executing concurrently,
see Frgure 2_1
under Compatible Access Methods
fo, fite Sharing. This
enablesprograms of various functions
to use the same disk
file without being concerned
about job scheduling. When
program requiresexclusive
use of a disk file.
1.q1rli1lar
S H A R E - N O m a y b e s p e c i f i e do n
the FILE statement.
Three program partitions are supported

Supervisor
Area
Partition1
Partition 2

Partition3
File Share Area

by 5704-SC2:

Each partition can contain a
separateprogram, thus allow_
ing concurrent execution of
up to three p-rograms. Each
program is logically independent,
but shareslhe CpU
facilities with the other programs.
When CCp rs executing
in a partition. that partition can
have up to I 5 tasks executing. For sizes of partitions, seeprogram
and partition
Sr2esunder program Facilities.
The supervisorcontrols priority for
CpU processing. When
s p o o l i s a c t i v e ,i t i s a s s i g n e dt h e
h i g h e s tp r i o r i t y , w i t h
p a r t i t i o n 3 s e c o n dp r i o n t y , p a r t i t i o n
2 third priority, and
partition 1 the lowestpriority.
T h i s p r i o r i t y s e q u e n c ei s
set at IPL time but may be changed
via a pTy command.
The PTY command enablesa different
priority order to be
a s s i g n e d( s u c ha s p 2 , p 1 , S p , p 3 ) ,
or one or more of the task
c a n b e a s s i g n e de q u a l p r i o r i t y ( s u c h
a sS p = p 3 , p 2 , p 1 l . A
request for equal priorities causes
the priority of the speci_
fied tasks to be cycled each time
the system watt task gets
c o n t r o l . F o r e x a m p l e ,w h e n t h e r e q u e s t p 1 = p 2
= p3,
is
the cycle would be p3, p2, pl, p2, pl, p3, pl, p3, p2,
etc.
A request for equal priorities does
not guaranteeexactly
equal priorities since processbound programs
will not
relinquish control to the system
wait task very frequently,
b u t i t c o u l d h a v e a n e q u a l i z i n ge f f e c t
over a period of
t a m e . l f o n e o f t h e p a r t i t i o n sc o n t a i n s
the communications
control program (CCp), it cannot
be given equal priority to
another task.
When an interrupt occurs, the supervisor
gainscontrol,
processesthe interrupt. and gives
control to the highest
priority task that is ready
to gain control. Control is given
up by the high priority task when
i t e n c o u n t e r sa c o n d i t i o n
that prevents further processing.
Control is taken away
from a low priority task at the completion
of the event
for which the high priority task is r,vaiting.

Operatingin a Multiprogramming
Environment
A job or job stepcan be executedin any partition. The
operatorloadsa programinto a partition by pressing
the
PF12 key on the keyboard.This movesthe cursoron the
CRT to the EJ (endof job) message
for a partition. When
the cursoris positionedfor the desiredpartition,the ENTER
key on the keyboardis pressed.
Whenever
for a partition is responded
the EJ message
to,
OCL statements
are readfrom the systeminput device
assigned
to that partition.
Whenthe systemis operatingin stepmode without spooling support,the systeminput deviceassigned
to a partition
is availablefor useby any partitionafter the OCL statementsfor the currentprogramhavebeenprocessed.Some
programshaveinput followingthe OCL and requirededication of that systeminput devicewhile processing.In this
case,the input deviceis not availableuntil it is released
by the program.The followingpointssummarizestep
modeoperation:
o All partitionscan sharethe samesysteminput device;
however,only one partitioncan receiveOCL statements
and datafrom the deviceat any one time.
.

Input and output devicesrequiredby the programsthat
areexecutingmust be available.Only the simulation
areas,main dataareas,and the CRT/keyboard(usedas
the systeminput device)can be shared,so careful
scheduling
of iobs is important.

o The systeminput deviceassigned
to a partition is availablefor useby any partitiononcethe currentprogram
hasreleased
it.
Whenthe systemis operatingin job mode without spooling
support.the followingpointsmust be considered:
o OCL statements
for all partitionsmust be enteredfrom
separate
systeminput devices(onefor partition 1, one
partition
for
2, and one for partition3), unlessthe
systeminput deviceis the CRT/keyboard.

o Input and output devicesrequiredby the programsmust
be available.Only the simulationareas,main dataareas,
and the CRT/keyboard(usedasthe systeminput
device)can be sharedby the partitions.Therefore,
carefulscheduling
of jobs is important. The following
chart showswhat devicescan be shared:

Device

Sharedby
All Partitions

5424 MFCU

No

2 5 6 0M F C M

No

2 5 0 1C a r dR e a d e r

No

1442 Card ReadPunch

No

1 4 0 3P r i n t e r

No

S i m u l a t i o nA r e a

Yesr

Main DataArea

Yesl

341013411Tape

No

CRT/Keyboard

Yes2

BSCA

No

3741 DataStation/
Programmable
Work Station

No

'The

device may be shared; however, there are restrictions
on disk files that must be considered.
2Th"r"
t h r e e i n t e r f a c e st o t h e C R T / K e y b o a r d : s y s t e m
"r"
i n p u t d e v i c e ,d a t a m a n a g e m e n t ,a n d s y s t e m l o g d e v i c e .
The CRT/Keyboard is shared between partitions when
the system log device and system input device interfaces
a r e u s e d . T h e C R T / k e y b o a r d i s u n a v a i l a b l ea s t h e
system input device only when it is being used by data
m a n a g e m e n t . O t h e r w i s e , i t i s a v a i l a b l et o a n y p a r t i t i o n
r e q u e s t i n gi n p u t f r o m t h e s y s t e m i n p u t d e v i c e .

o The systeminput deviceassigned
to a partition,except
to that partifor the CRT/keyboard,remainsassigned
tion for the durationof the job, evenif the job step
that is executingdoesnot usethe systeminput device.
(SeeSystemlnput Devicelater in this chapter.)
Whenthe systemis operatingwith spoolsupport,job mode
the jobs to be executed
is required.Spoolingschedules
to the
in eachpartitionaccordingto the priority assigned
variousjobs and producesthe output from the iobs on a
priority basis.The priority of a job on the input queue
or the priority of the output of a job stepcan be changed
throughuseof the CHANGEcommanC.

System Facilities

2-53

Whenthe systemis operatingin a spooledenvironment.
the followingconsiderations
shouldbe made:

O DISPLAY The DISPLAY STATUS
command formats
the CRT screenwith the status of the
system. Each page (display) is the status of
a p a r t i t i o n , t h e s y s t e m ,o r t h e v o l u m e l D s .

o The operatormay schedulejobsfor
executionin all
partitionsfrom the samesysteminput
deviceby supply.
i n gt h e P A R T I T I O Np a r a m e t eorn t h e J O B
OCLstate_
ment. Oncea job hasbeenplacedon the spoolreader
queue,its partitionassignment
can be changedthrough
u s eo f t h e C H A N G Ep a r t i t i o nc o m m a n d .( S e ep a r t
1 for
a descriptionof the JOB statement.)

An ENTER responseto each page causes
t h e n e x t p a r t i t i o n , s y s t e ms t a t u s ,o r v o l u m e
l D s t o b e d i s p l a y e di n s e q u e n c e :s y s t e m
s t a t u s ,P 1 , P 2 , p 3 , v o l u m e l D s , s y s t e m
s t a t u s ,P 1 , e t c . T h e o p e r a t o r m a y r e q u e s t
a p a r t i c u l a rp a g eb y p l a c i n gt h e p a r t i t i o n

a The spooledreader,punch,and printer
devicesmay be
s h a r e db y a l l p a r t i t i o n sw h e nu s i n gs p o o l i n g

number, an S, or an N under the cursoror
b y s p e c i f y i n gt h e p a r t i t i o n o r N o n t h e
DISPLAY STATUS command.

Operator Control Commands for Multiprogramming

T h e s y s t e md i s p l a y i n c l u d e st h e m a x i m u m
p r o g r a m s i z e ( m a x i m u m s i z eo f a p r o g r a m

The followingoperatorcontrol commands(OCC)provide
the usera meansto control multiprogramming.
{Appsndil
C containsthe format of the commands;for
a complete
descriptionof the commands,seeIBM System/3
Modet I5
Operator'sGuide, GC21-5075.)

that can be executed) and the size of the
f i l e s h a r ea r e a . T h e p a r t i t i o n d i s p l a y
i n c l u d e st h e l o c a t i o n o f t h e s i m u l a t i o n
areasassignedto that partition.

o CANCEL

.

CHANGE

T h e C A N C E Lc o m m a n dt e r m i n a t etsh e
j o b e x e c u t i n gi n t h e s p e c i f i e p
dartition.
lf the canceledprogramis a job step in a
j o b o r a p a r t o f a c h a i n e dp r o c e d u r e ,
all
remainingstepsin the job or procedure
arealsocanceled.processing
can continue
with the next job.

T h e D I S P L A Y c o m m a n d a l s oa l l o w st h e
s y s t e mh i s t o r y a r e a ( H I S T O R y ) a n d t h e
c o n t e n t s o f t h e s p o o l i n gq u e u e s( R D R O ,
PRTO, or PCHO) to be formatted on the
CRT screen.

O n ef u n c t i o no f t h e C H A N G Ec o m m a n o
is to alterthe partitionassignment
of the
job on the spoolreaderqueuewhen
spool
is active. This is donevia the pTN operand.

O DUMP

T h e D U M P c o m m a n d e n a b l e st h e s t o r a g e
a l l o c a t e dt o a p a r t i t i o n t o b e d u m p e d .
D U M P c a n a l s o p r o v i d ea d u m p o f t h e
total storagearea of the system.

A n o t h e rf u n c t i o no f C H A N G Ei s t o a l t e r
the main storagerequirements
of a job on
the spoolreaderqueue(spoolmust be
a c t i v e ) .T h e C O R Ep a r a m e t eprl u sa s i z e
s p e c iife st h e m i n i m u ma m o u n to f m a i n
storagerequiredto executethe largeststep
in the job. lt doesnot assignmain storage
t o t h e p a r t i t i o n t; h e S E Tc o m m a n di s u s e d
for this purpose.

.

The HALT command temporarilysuspends
processingin a specified partition after the
current job step is complete and whenever

The PTY operandof the CHANGEcom_
mandallowsthe priority of a job on a
spoolqueueto be altered. (Spoolmust be
active.) The priority of a job determines
when it is executedand when its output
i s p r i n t e do r p u n c h e d .

2-54

T h e v o l u m e l D d i s p l a y i n c l u d e st h e n a m e s
o f a l l t h e d i s k a r e a s( m a i n d a t a a r e a sa n d
s i m u l a t i o na r e a s ) .

HALT

a system message(except an informational
m e s s a g ei)s i s s u e di n t h a t p a r t i t i o n . T h e
H A L T c o m m a n d c a n a l s o c a u s ea n i n f o r m a _
t i o n a l m e s s a g ew h e n u n p r i n t e d e n t r i e si n
the system history area are about to be
o v e r l a i db y a d d i t i o n a le n t r i e s . T h e H A L T
command overridesthe nohalt mode
e s t a b l i s h e da t l p L o r b y a N O H A L T O C L
statement. Processingresumeswhen the
system messageis respondedto.

.

NOHALT

. PTY

Whena NOHALT commandfor a partition
is specified,the partitiondoesnot stop
when an end of job or end of stepoccurs.
NOHALT changesthe processing
mode
for the partitionfrom halt to nohalt. lt
overridesthe halt modeestablished
by a
HALT command;however,it doesnot
overridea HALT OCL statement.
The PTY commandaltersthe priority order
o f s p o o l i n ga n d p a r t i t i o n s1 , 2 , a n d 3 i n
the systemcontrol program.At lPL, the
priority of thesetasksis spool,P3, P2, P1,
with spool (if active)havingthe highest
priority. The priority of thesetasksdeterminesthe order in which they receivethe
services
of the systemcontrol program.
The PTY commandalsoenablesone or
more of thesetasksto haveequalpriority.
Changingthe priority may increase
the
performance
of one task;however,it may
be at the expenseof anothertask.

O R E A D E R T h e R E A D E Rc o m m a n dc h a n g etsh e
systeminput deviceassigned
to a partition.
Whenthis commandis entered,the specified partition must be at end of job or
end-of-jobstep,and must not havea system
input devicededicatedto it. The assigned
deviceremainsasthe systeminput device
untilchanged
b y a n o t h e rR E A D E R
c o m m a n do r R E A D E RO C L s t a t e m e n t ,
or until an IPL is performed.The system
input devicecan be changedin a spooled
job stream;however,jobs arescheduled
for executionfrom the readerqueueonly
when the systeminput deviceis alsothe
spooledreader.

. SET

The SET commandoverridesthe partition
and file shareareasizessetduringsystem
generationor set by a previousSET
command.
Supervisor
P a r t i t i o n1

Partition2
Partition3
File Share Area

Beforea SET command

Supervisor
Partition1
UnusedArea
Partition2
P a r t i t i o n3
File ShareArea
After a SET commandthat
changedthe sizeof partition 1.
The unusedareacould be
assigned
to eitherpartition2
or 3 with anotherSET command.
Whenthe SET commandis enteredto
changea partitionsize,CAN NOT ACCEPT
is displayedif the specifiedpartition is
not at end of job or end-of-jobstep. Partitions 2 and 3 both must be at EJ before
the sizeof partition3 can be changed.lf
the specifiedpartition is at end-of-jobstep
but not end of job, the partitionsizemay
not be decreased
to lessthan:
- The sizespecifiedin the COREparameter of the JOB OCL statement.
- The sizeof the partitionat the startof
the job, if the COREparameteris not
specifiedin the JOB OCL statement.

System Facilities

2-55

T h e m i n i m u m p a r t i t i o n s i z ef o r p a r t i t i o n 1
is 8K. Partitions 2 and 3 can be set at zero

O STOP

to run the system with only one partition
active (dedicatedsystem operation). When
partitions 2 and/or 3 are set to zero,
the
C A N C E L a n d D U M p c o m m a n d sa r e n o t
acceptedfor partitions 2 andlor 3. When
a partition is set to zero during system
generation, the CT EJ messagewill not
be
d i s p l a y e df o r t h a t p a r t i t i o n . B o t h p a r t i _
tions can be reactivatedwith another SET
c o m m a n d s p e c i f y i n g8 K o r m o r e . T h e
m a x i m u m p a r t i t i o n s i z et h a t c a n b e s p e c i _
f i e d i s t h e s y s t e ms t o r a g es i z em i n u s t h e
s i z eo f t h e s u p e r v i s o r( i f p a r t i t i o n s 2 a n d 3
a r e s e t t o 0 ) a n d t h e s i z eo f t h e f i l e s h a r e
area(a minimum of 2K). ln all other cases,
t h e m a x i m u m p a r t i t i o n s i z ei s t h e s y s t e m
m a i n s t o r a g es i z e m i n u s t h e s u p e r v i s o rs i z e ,
t h e o t h e r t w o p a r t i t i o n s i z e s ,a n d t h e f i l e
share area size. When the size of one
partition is decreasedto increasethe other,

for a partition in which the communica_
tions control program (CCp) is executing
or when a partition is using certain system
resourcessuch as system interlocks. This
c o m m a n d t a k e se f f e c t i m m e d i a t e l y . A
S T A R T c o m m a n d i s r e q u i r e dt o r e s u m e
program execution after it has been
stopped.
/ly'ote.'This command can also causethe
spool writers to stop execution if they are
p r i n t i n go r p u n c h i n gD E F E R - N Od a t a
from the job step when it is stopped. They
w i l l r e s u m ep r i n t i n g o r p u n c h i n g w h e n
execution has been started again in the
partition.
The STOP SPOOL command with a partit i o n s p e c i f i e di n d i c a t e st h e p a r t i t i o n i n
w h i c h s p o o l i n gi s t o b e t e r m i n a t e d . T h i s
command can be entered anytime follow_
i n g i n i t i a t i o n o f s p o o l i n ga t l p L ; h o w e v e r ,
it does not take effect until the end of the
next job that releasesthe system input

the decreaseoperation must be done first.
When the SET command is entered to
c h a n g et h e s i z e o f t h e f i l e s h a r ea r e a ,a l l
partitions must be at end of job. The
m i n i m u m f i l e s h a r ea r e as i z e i s 2 K ; l a r g e r
sizesare specified in increments of 2K.

O START

A START SPOOLcommand with a speci_
f i e d p a r t i t i o n i n d i c a t e st h e p a r t i t i o n i n
w h i c h s p o o l i n gi s t o b e i n i t i a t e d . T h e
START SPOOL command specifying a
partition may only be entered after the
spooling function has been activated at
l P L . S T A R T i s u s e dt o r e a c t i v a t es p o o l i n g
for a partition after the STOP command.
lf entered at the end of a job when the
system input device has been released,
spooling for the partition begins immedi_
ately. lf entered during the execution of
a job, it takes effect at the end of the next
job that releasesthe system input device.
Once spooling is activated by the START
command. it remains active until a STOp
command is entered.

2-56

d e v i c e . l f t h i s c o m m a n d i s e n t e r e da t e n d
of job or when the system input device is
released.it takes effect immediately. A
START SPOOL command is required to
reactivatespool support for that partition.

A START command with a specified parti_
tion indicatesexecution can be started in a
partition in which execution was previously
stopped by a STOP command. This com_
mand can be entered at any time and takes
effect immediately.

The STOP command with a partition specified indicates to stop execution in that
partition. This commandcannot be entered

Mu I ti pl e Parti tion Supp ort
The three-partition support provides the capability of
o p e r a t i n gi n t h e f o l l o w i n g t y p i c a l e n v i r o n m e n t s :
o C C P - b a t c h - l i m i t e d a p p l i c a t i o nd e v e l o p m e n t
o CCP-batch-batch
o CCP-MRJE-batch
o

Batch-batch-batch

.

Batch-batch-limited

application development

Batch processingis the execution of programs such that
each program is completed before the next program is
initiated. Limited application developmerf refers to the
compilation and debugging of programs in a batch environment.

and Restrictions
Considerations
Multiprogramming
Li brary Main tenance Program
programcan executein one partiThe library maintenance
program,including
nondedicated
tion while any other
in
is executing anotherpartition.
library maintenancer,
functionscan be performed
All of the librarymaintenance
i n a m u l t i p r o g r a m r r i negn v i r o n m e netx c e p tc o p y i n go r
renamingsystementrieson the simulationareafrom which
the systemis loaded.Thesefunctionsrequirethe other
partitionsto be inar:tive.
Restrictions
existon the functionsthat can be performed
l
i
b
r
a
r
ym a i n t e n a n cper o g r a mi f a s i m u l a t i o na r e ai s
by the
specifiedthat is alreadyin useby anotherpartition. These
restrictionsare:
o A n y d e l e t eo r r e n a m ef u n c t i o n( L I B R A R Y - O ,
L I B R A R Y - Ro, r L I B R A R Y - A L L o) r a l l o c a tfeu n c t i o n
that specifiesthr:simulationareafrom which a program
executingin anotherpartitionis loaded,will not be
performed.
o Basedupon the option selectedat systemgeneration
time or duringexecutionof the configurationrecord
program,the followingsupportappliesfor the copy
f u n c t i o n( L I B R , A R Y - OL, l BR A R Y - R .L IB R A R Y - A L L ,
or f ile-to-library):
For catalogto no program packs,anYcopy function that
specifies
a simulationareafrom which a programexecut'
, ill not beperformed.
i n g i n a n o t h e rp a r t i t i o ni s l o a d e dw
For catalog to CCPprogram pack, any copy function
that specifiesa r;imulationareawhich is currentlyin use
asa CCPprog!'ampack,will be performed. lf that simulation areais alsoin useasa programpackfor the third
partition.the copy function will still be performed.
However,if the programexecutingin the third partition
is loadedfrom a differentsimulationarea,the copy
function will not be performed.
For catalog to a,llprogram packs, any copy function
that specifiesa simulationareafrom which a program
the
e x e c u t i n gi n a n o t h e rp a r t i t i o ni s l o a d e d( i n c l u d i n g
C C Pp r o g r a mp a c k ) ,w i l l b e p e r f o r m e d .

o Any copy function that specifiesa simulationareathat
is alsobeingusedby a systemserviceprogramin another
partitionfor library purposeswill not be performed
unlessboth the copy function and the systemservice
programareperformingreadonly functions.
r

lf a libraryfunction can changethe extentsof the
l i b r a r y( t h a t i s ,t h e a l l o c a t ef u n c t i o n ,L I B R A R Y - O ,
L I B R A R Y - Ro. r L I B R A R Y ' A L Lc o p yf u n c t i o nf,i l e . AME-ALL,
t o - l i b r a r yf u n c t i o n ,o r L I B R A R Y - O N
RETAIN-Tdeletefunction),a systemserviceprogram
, n df i l e s
i n a n o t h e rp a r t i t i o nc a n n o tu s et h a t s a m ea r e a a
cannotbe allocatedin that areauntil the libraryfunction
i sc o m p l e t e d .

a
o Any delete,rename,or modify function that specifies
simulationareathat is alsobeingusedby a system
serviceprogramin anotherpartitionfor librarypurposes
will not beperformed.
o Any function that specifies
a simulationareathat is
dedicatedto anotherpartitionfor useby a systemservice
p r o g r a mo r f o r a n o f f l i n em u l t i v o l u m ef i l e o r a d e f e r r e d
m o u n tf i l e w i l l n o t b e P e r f o r m e d .
Any simulationareathat is not in useby a systemservice
programin anotherpartition or hasa usenot previously
describedasa restrictioncan be usedby the librarymainte'
nanceprogram.

File Share
P r o g r a mN u m b e r5 7 0 4 ' S C 2a l l o w ss h a r i n go f a d i s kd a t a
of a
file betweentwo or more partitions,tasks,or access
f i l e i n a s i n g l ep r o g r a mw h e n e v eirt i s l o g i c a l l yp o s s i b l e .
monitorsf ile usageat a block level
Diskdatamanagement
and allowsaccessfor disk raritesor potential disk uzritesto
any portion of the file not in useby anotherprogramfor
the samepurpose.tnput only operationsareallowedwithout regardto block usageby anotherprogram.Since
potential write operationsare block protectedwhen f ile
sharing,the greaterthe block sizespecified,the greater
the portion of the file that cannotbe sharedat any given
periodwith anotherpotentialwrite program.
A potentialdisk write occursduringinput/updatetype
operations.Whenthe input block is read,it is protected
on an
for a possibleupdateoperation.The block is released
and
sequential
During
request.
next
input
the
or
update
when all
processing,
the block is released
consecutive
processed.
random
During
are
in
block
the
records
aftereveryrecord.
processing,
the block is released

System Facilities

2-57

Page
of GC21-5162-1
lssued
28 September
1g79
B yT N L : G N 2 1 - 5 6 7 4
Add blockshaveconsiderations
similarto input/update
type operations.Randomaddsareprotected
duringthe
actualadd and released
so anotherrandomadd program
may access
that record. Sequentialand consecutive
adds
areprotectedduringthe entireadd run
and are not avairablefor processing
until that programhasbeencompleted.
A usermay gainexclusiveuseof a file
by specifying
S H A R E - N Oi n t h e F I L E s t a t e m e n tS
. HARE_NO
excludes
other programsfrom usinga file including
input onty access
methods.Whenfiles arenot shared
betweenpartitionsor
tasks,SHARE-NOshouldbe usedto
decrease
the disk
processing
time, especiallyif largeamountsof random
addsare to be performed.
Whentwo or more programsaresharing
a file, a lockout
conditioncan occur if one of the programs
taitsto retease
a block of recordsand a secondprogram
attemptsto access
a recordwithin the sameblock. A lockout
can atsooccur
whena programis executedin sucha
mannerthat another
programcannotgaincontrol.

E x a m p l eC :
1.

ProgramY is readingand updatingrecords
randomly
from file A. programy is codedto loop
on a chain
operationwhen the recordis not found.
lt is alsoa
high priority programlevel.

2.

ProgramX is randomlyaddingand updating
records.
I t i s l o w e ri n p r i o r i t yt h a np r o g r a my .

3.

ProgramY chainsfor a recordhigher
than any
p r e v i o u sr e c o r d si n t h e f i l e . l t l o o p s
o n t h ec h a i n
operationwaitingfor programX to add the
record.
Sincedatamanagement
detectsthe high key request,
no disk operationsoccurand,therefore,control
is
not passedto programX. so no further processing
is
d o n ea n dt h e p a r t i t i o nm u s tb e c a n c e l e d .

Example
D:
1.

Filename
A a n d f i l e n a m eB d e f i n et h e s a m ep h y s i c a l
file in programy.

2.

Programy usesf ilenameA to performupclates.
The
recordswithin the l/O block of filenameA arepro_
tecteduntil released
by programy.

3.

ProgramY then usesf ilenameB in an attempt
to
readand updatea recordwithin the samel/O
block
usedby filenameA. However,programy cannor
use
f i l e n a m eB u n t i l t h e l / O b l o c ku s e db y f i l e n a m e
A
is released.

E x a m p l eA :
1.

ProgramX beginsand readsa recordto
updatefrom
fiteA.

2.

ProgramY beginsand readsa recordfrom
file B.

3.

ProgramX attemptsto readthe samepart
of f ile B
without updatingor releasing
file A. lt musr now
wait for programy to release
its block.

4.

ProgramY attemptsto reada portion
of file A in the
sameblock asprogramX without releasing
the file
B block. programy is now waitingon program
X
and both programsare lockedout.

E x a m p l eB :
1.

ProgramY performsupdatesuntil at some
condition
it issuesa halt after inputinga record.

2.

ProgramX attemptsto readand update
a record
within the sameblock ownedby programy. program
X will wait for programy to release
the block.
Oncethe halt in programy is responded process_
to,
i n gw i l l c o n t i n u e .

2-58

Becauseof these considerations,programs that
will be
sharingfiles should not be coded to do consecutive
reads
from different disk files without doing intervenrng
writes.
P r o g r a m st h a t w i l l p o t e n t i a l l y h o l d u p u s a g e
of a block of
recordsbecauseof length calculationsor halts
should
releasethe block before the action and reread
the block
for any update. When this type of coding
cannot be avoid
e d , t h e u s e r m u s t b e a w a r e o f t h e p o s s i b l el o c k o u t
condi_
t i o n s a n d s c h e d u l ej o b s a c c o r d i n g l y .

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued 28 September 1979
By TNL: GN21-5674

During index add processing,if a program executing in one
p a r t i t i o n i s s h a r i n ga f i l e w i t h a n a d d p r o g r a me x e c u t i n gi n
another partition, the key sort is deferred until the last
user of the file goes to end of job. lf the last user of the
f i l e d o e s n o t h a v ea $ l N D E X 4 5 o r $ l N D E X 4 0 F I L E s t a t e ment to allocate spacefor the work file (which is used to
sort the keys), the system will attempt to automatically
allocate the space. However. the system may not be able
to automatically allocate the space. Therefore, if the work
f i l e i s r e q u i r e d ,i f t h e r e i s a p o s s i b i l i t yt h a t t h e k e y s o r t
w i l l b e d e f e r r e d ,a n d i f s u f f i c i e n ts p a c ew i l l n o t b e a v a i l a b l e f o r t h e s y s t e mt o a u t o m a t i c a l l ya l l o c a t et h e w o r k f i l e ,
t h e n t h e u s e rs h o u l di n c l u d ea $ l N D E X 4 5 o r $ l N D E X 4 0
F I L E s t a t e m e n tf o r t h e s h a r i n gp r o g r a m e v e n t h o u g h i t
may not be an add program.
D u r i n g r a n d o m a d d st o a n i n d e x e d f i l e , i t i s p o s s i b l ef o r
two programs to attempt to add the same record. lf both
programs do so together, the f irst program will add the
r e c o r d a n d t h e s e c o n dw i l l g e t a n A T T E M P T T O A D D
DUPLICATE RECORD message.

SvstemFacilities

2'54.1

T h i sp a g ei n t e n t i o n a l l lye f t b l a n k .

2-5a.2

Programscoded to perform two random updates to the
s a m ed i s k f i l e w i t h o u t a n i n t e r v e n i n gr e a d w i l l r e c e i v ed i s k
e r r o r m e s s a g e sO
. n c e a r e c o r du p d a t e i s i s s u e d a
, n input
operation must be performed before another update is
attempted.
W h e n a d d i n g r e c o r d st o a f i l e , t h e a v a i l a b i l i t yo f t h e a d d e d
recordsto another program depends on the accessmethod
adding the record and the accessmethod retrieving the
record. The most permissiveaccessmethod is indexed
random add. In order to retrieve records added bv another
partition, random add accessmust be used by the retrieving
program even though no actual adds will be performed by
t h e p r o g r a m . T h e f o l l o w i n g c h a r t i n d i c a t e sr e c o r d
availability.

Sharing Accessto Added Records

Record

\

Availability
T" Access:

\

\
Records
\
Added by
Access:

CA
ISA/ISUA
IA/IRA/IRUA

\

IS

cl
CU

DI
DU

r sL
tsu

IR
IRU

IRA
IRUA

o
o

o,@

ISUL

\

o
o
o

o
o
o

o
o

o

recordsimmediatelyavailable
@ nOOeO
prior to openavailable
O Recordadded
recordsavailableafter closeof addingprogram
@ nOOeO
recordsavailableafter key sort at end of job or CCPclose
@ nOOeO
@

A"".tt method not availableuntil add accesshas completed

CA
ISA
ISUA
IRA
IRUA

Consecutiveadd
I n d e x e ds e q u e n t i a a
l dd or input add
lndexed sequential update add
I n d e x e dr a n d o m i n p u t a d d
I n d e x e dr a n d o m i n p u t u p d a t e a d d

System Facilities

2-59

Multiprogramming
Examples
The followingsamprejob streamsassume
four jobs areto
Deexecuted(Figure2-4). The system
configurationconsistsof a processing
unit with 256K,5424 tvt"rcu,t+os
printer,3340 disk drives,and
a CRT/keyboard.The
systeminput devicesarethe 5424 MFCU
for partition 1
a n dt h e c R T / k e y b o a r df o r p a r t i t i o n s
2 a n d3 . B . f o r . . " . cutingthesejobs,the operatormust
decidewhetnerto
executethem in job modeor stepmode. job
lf
modeis
chosen,spoolor nonspoolmust be chosen.
Whentne
systemis operatingin stepmodeor in job
modewithout
spool,all l/O devicesusedby the job
stepsmust be avail_
able. Carefulplanningand scheduling
of job stepsis necessaryto makemaximumuseof multiprogramming
and to
avoid l/O deviceconflictsbetweenpartitions.
Assuminga nonspooled
environment,jobs 1, 3, and 4
(whichusethe MFCU for reading
and punctringcards)are
scheduledin the samepartitionto avoid
confrictwith the
M F C U . S i n c ej o b 3 d o e sn o t r e q u i r et h e p r i n t e r ,
it is
scheduled
asthe first job in partition 1 to avoida
conflict
with job 2 in partition 2. Job 1 is scheduled
as the second
j o b i n p a r t i t i o n1 ; h o w e v e r .
t o a v o i da c o n f l i c tw i t h t h e
printer.step 2 of job 1 cannotbe
starteduntil job 2 is
finishedexecuting.Any subsequent
jobs scheduled
in
partition2 would haveto avoid
usingthe printeror MFCU
job 4 usesboth thesedevices.partition
because
3 is not
u s e di n t h i se x a m p l e .

The OCL statementsrequiredfor partition
1 would be as
follows:
// DATE 10/20/76
//JOB3JOB SPOOL.NO
/ / H I S T O R YL O A D P HI S T , F1
/ / F | L E. . .
// RUN
/ / P U N C HL O A D P H O R D , F l
/ / F I L E. . .
/i RUN
//JOBI JOB SPOOL.NO
/ l U P DA T E L O A D U P D A T E , F1
/ / F I L E. . .
// RUN
/ / P A U S ES T A R T N E X T S T E PO F J O B l
A F T E R J O B 2E J
i / W R I T EL O A D O R D R S , F l
// FILE...
i/ RUN
//JOB4 JOB SPOOL-NO
// LOAD$RPG,F1
// FILE...
// FILE...
// RUN
sourcestatements
// LOAD RPGOBJ.F1
// FILE...
// RUN

The OCL statements
requiredfor partition2 would be as
follows:
//JOB2 JOB SPOOL-NO
/ / C H E C K SL O A D P A Y R OL . F1
/ / F I L E. . .
// RUN

2-60

lf the samejobs wererun in job mode with spoolingactive,
all jobscould be readby one input device(seeFigure2_b).
Assumethat the systemdatewasenteredat lpL. After
lPL, the followingoperatorcontrol commandswould be
entered(seeAppendixC for a summaryof operatorcontrol
commands):
S T A R TR D R ( S p o o l i n g
b e g i n sr e a d i n gt h e i n p u tj o b
streamand placingjobs in an areaof the spoolfile
c a l l e dt h e r e a d e q
r ueue.)
S T A R TP R T
START PCH (Canbe enteredafter the spoolreaderhas
terminated.
)
The followingOCL statements
would be placedin the
spooledreader:

Jobswould be executedin the partitionsasfollows:
J O B1

P a r t i t i o n1, a ss p e c iife d b y t h e p A R T I T I O N
parameterin the JOB OCL statement

JOB2

P a r t i t i o n2 , a ss p e c i f i e b
dy the pARTITION
parameterin the JOB OCL statement

JOB3
JOB4

Defaultsto partition 1 because
no pARTITION
parameteris specifiedin the JOB OCL statement

Sincespoolingschedules
the useof the spooledl/O devices,
scheduling
of jobs in the partitionsis madeeasier.Also,
moreefficientuseof the multiprogramming
capabilityof
the systemis realizedwhen operatingin a spooledenvironment.

I I J O B IJ O BP A R T I T I O N - 1P,RI O R I T Y . 3
/ / U P D A T EL O A D U P D A T E , F l
/ / F I L E. . .
// RUN
/ / W R I T EL O A D O R D E R S . F l
// FILE.. .
// RUN
/ / J O B 2J O B P A R T I T I O N - 2 , C OER- 2 O , PIRO RI T Y . 4
/ / C HE C K SL O A D P A Y R O L . F1
/ / F I L E. . .
// RUN
/ I J O B ZJ O B P R I O R I T Y . 2
/ / H I S T O R YL O A D P H I S T , F l
// FILE...
// RUN
/ / P U N C HL O A D P H O R D . F l
// FILE. , ,
i/ RUN
/ l J O B 4J O B C O R E - 1 6
/ I L O A D$ R P G , F 1
ll FILE. ..
/ / F I L E. . .
// RUN
sourcestatements
/i LOAD RPGOBJ,FI
/l FILE...
// RUN

System Facilities

, .r#r.

+*!srr

f rdr:ffir.ffirG:rrtr*#ItttuM.r.

2-61

u..

Job 1: Inventory
Step: 1 Updateinventory
f ile
o Readcards
o Writedisk records
Step2: Write orders
o R e a dd i s k
o print orders
Job 2: payroll
S t e p1 : p r i n t c h e c k s
o R e a dd i s k
o Print checks

Job 3: Detail punch
S t e p2 : P u n c hh i s t o r yf i l e
o R e a dd i s k
o Punchcards
Step2: Punchorderfile
o R e a dd i s k
o Punchcards
Job 4: Compile
S t e p1 : C o m p i l ep r o g r a m
. Readcards
o W r i t eD i s k
o P r i n tl i s t i n g
Step2: Executeprogram
o Readcards
o Write disk records

JOB4

J O B1

JOB3

Partition1
Assignred
SysternInput Device
Supervisor

JOB2

Partition1
Partition1

Partition2
Assigne,d
SystemInput Device

Partition2
Partition2
Partition3
File Share Area
Non Spooled System

FiSuro 2-5. Scheduling
Jobs in a Multiprogramming
Environmont
2€.2

Partition3
F i l eS h a r eA r e a
Spooled System

DATE SUPPORT
The System/3Model 15 usesfour datefields: a system
dateand threepartitiondates(onefor eachpartition).
The datescan be changedby a DATE statementor a DATE
command.

SystemDate
The systemdate is usedfor time stampingcertainmessages
b y t h e t i m e - o f - d am
y a c r oi n s t r u c t i o n st h, e R p G l l T I M E
o p e r a t i o nc o d e .a n d b y t h e C O B O La n d F O R T R A NC F T O D
modules.The systemdate is set at IPL when the operator
responds
to the DATE prompt or when the operatorenters
a DATE command. lt is alsosetwhen an OCL statement
is enteredat IPL beforeany JOB, CALL, or LOAD statement. The systemdatecan be changedby the operator
o n l y w i t h t h e D A T E c o m m a n da n d o n l y w h e na l l p a r t i t i o n s
areat end of job.
lf the intervaltimer is specifiedduringsystemgeneration,
the systemdate is changedat midnight-whenthe timer
changes
from 23.59.59to 00.00.00.

Partition Date
Thereis a datefield for eachpartition. The partitiondate
is usedby programsrunningin that partition,and it may
be differentfrom the systemdate or from the date in
anotherpartition. The partitiondate is usedby the RPG ll
U D A T Ef i e l d a n d w h e nc r e a t i n gf i l e s .
The partitiondatesareestablished
initially from the system
date;wheneverthe systemdate is entered,the threepartition datesarealsoset. The partitiondate is alwaysrestored
to the systemdate at the start of the next job (after EJ).
The partitiondatecan be changedby useof the DATE
statement,asfollows:
.

Job Date: lf the DATE statementis enteredafter the
JOB statementand beforea LOAD statement,that date
will remainin effectfor the remainderof that job. lt is
restoredto the currentsystemdatefor the next job.
It is not necessary
that the DATE statementprecede
the first step;it may be placedprior to any step'sLOAD
statementand will be in effect from that stepto the end
of that job.

o Step Date: lf the DATE statement is entered after a
L O A D o r C A L L s t a t e m e n ta n d b e f o r e t h e R U N s t a t e ment for that step (that is, if the DATE statement is
e n t e r e dw i t h i n a s t e p ) ,t h e p a r t i t i o n d a t e i s c h a n g e df o r
the duration of that step. lt is restored to the current
system date for the next step.
lf the interval timer is supported. and if the system date is
u p d a t e da t m i d n i g h t , t h e n , w h e n t h e p a r t i t i o n d a t e i s
restored after EJ or ES, it may be different from when the
step was started. However, the partition date is changed
b y t h e s y s t e m o n l y a f t e r E S o r E J , n e v e rd u r i n g e x e c u t i o n
of a step.
Use of the DATE statement prior to a LOAD starement
ensuresthat the same date is used for each step in the job.
A l s o , o n c e a D A T E s t a t e m e n ti s e n t e r e d i n t h i s m a n n e r ,
a subsequentDATE statement may be entered for the
job, but only if it occurs prior to a LOAD statemenr.

INTERVAL TIMER
The interval timer provides time-of-day (TOD) support,
w h i c h m a i n t a i n st h e t i m e o f d a y a n d s y s t e md a t e . T h i s
information is used to do the time stamping for jobs and
job steps and for jobs executed using checkpoint/restart.
The time of day isgivenin hours (00-23), minutes (00-59),
a n d s e c o n d s( 0 0 - 5 9 ) .
For time stamping jobs and job steps,the system date and
t i m e o f d a y ( m m d d y y o r d d m m y y a n d h h . m m . s s )a r e u s e d
to time stamp the CTEJ and CTES messages.The system
date and time of day are savedwhen the job or job step
starts, and the time of day is savedwhen the job or job
step ends. The start time of a job or job step is:
r

In halt mode, the responseto the EJ or ES message.

o

In nohalt mode, after the EJ or ES messageis logged in
the system history area, but before an attempt is made
by the system to read the first record of the next iob
or job step.

lf time of day is not specified during system generation.
n e i t h e rt h e d a t e n o r t h e t i m e i s i n c l u d e d i n t h e m e s s a g e s .

Svstem Facilities

2-63

Time stampingfor checkpoint/restart
is asfollows:
o Whena checkpointrequest
is receivedand accepted,
the systemdateand time aresaved.
This information
is put into the CC Hy message
that is givenat a check_
Point.
o Whena restartrequest
is received,
the systemdateand
time aresaved.This information
i, tf,"n put into the
CC HU message
that is given,t . r..rturt."
lf time of day support.isnot specified
duringsysremgen_
eration,the dateand time are not
includedii tfrectrect_
pointlrestartmessages.
The systemdate is automatically
incrementedto the next
day at midnight(whenthe time
changesfrom 23.59.59to
00.00.00). The partitiondate,used
ai the oeation date
for the disk and tapefiles,is not
updatedat midnightuntil
the startof the next job or job step.
The partitiondate is
changedby the systemonly after ES
or EJ occurs,never
duringthe executionof a job step.
As a result,filescreated
in two adjacentjob stepscould have
differentdates. Also,
asa result,the CCpdatewill not
changeduringone execution, eventhoughit may stay up for
overa day.
Full intervaltimer supportprovides
time of day support
and alsoallowsthe userto set time
intervalsand to determineelapsedtime by usingsystem
control progrrmmlng
macroinstructions.The five macros_$Oeie
, $TlOB,
$Stf, $fOO, and gRlT_are available provide
and
the
followingfunctions:
.

Retrievethe systemdateand time
of day.

o Set the intervaltimer
to causean interruptafter a specified amountof elapsedtime.
o Choosea format for specifying
the time intervals.
o Specifythe type of intervals
to be timed.
.

Returnthe remainingamountof time
in an interval.

o Cancelan unexpiredtime
interval.
For informationon thesemacroinstruc
tions,seetgM
System/3 Model lS System Control programming
Macros
ReferenceManual, GC21_760g.

2$4

S Y S T E MI N P U TD E V I C E
Duringsystemgeneration,a system
input deviceis assigned
to eachpartition. Whenprogramloading
is initiatedin a
partition,OCL statements
are readfrom the systeminput
deviceassigned
to that partition. (Thesysteminput
device
is often referredto assysin.)
The followingdevicescan be assigned
asthe systeminput
device: 5424 MFCU,2560 MFCM,
1442 CardReadpunch,
2501 Card Reader,CRT/keyboard,
or 3741DataStation/
Programmable
Work Station.
Whenthe systemis runningin stepmode,
the systeminput
deviceis assigned
to a partition while the OCL statements
arebeingprocessed,
unressthe systeminput deviceis the
CRT/keyboard.After the OCL statements
are processed,
the systeminput devicemay be allocated
to anotherpartition. Whenan error conditionoccurs
duringa programand
a 2 or 3 option is taken.the job stream
in the systeminput
deviceis readbut not processed
until a LOAD. CALL,
JOB,/&, or /. OCL statementis found.
Unlessa /. or a /&
OCL statementis found, the systeminput
deviceis not
released.
rVofe.'Someprograms,suchasthe
RpG llcompiler and
disk sort, requiresysteminput device
dedicationwhile
executing,in which casethe systeminput
deviceremains
assigned
to the partition until thoseprogramsrelease
it.
Whenthe systemis runningin job mode
and spoolingis
inactive,the systeminput deviceis
assigned
to a partition
for the durationof a job, unlessthe
,yrim input deviceis
the CRT/keyboard.Oncea JOB OCL
statementis pro_
cessedin a partition,that partition,s
assigned
input device
is assigned
to the partition until the job i-sterminated
by
a /' statementor a 3 0ption is takento
a readerhardware
error message.
Whenthe systemis runningin job mode
with spooling
active,one input deviceis assigned
asthe spooledreader
from which all input can be readfor
all spooledpartitions.
The spooledreadershouldbe the same
deviceas that
assigned
asa partition,ssysteminput device.
Job mode doesnot causethe system
input deviceto be
dedicatedwhen it is the CRT/keyboard.
Whennohaltmode is usedwith job mode,
the systeminput
deviceis not released
until halt mode is established
and
end of job occurs.

The assigned
deviceremainsthe systeminput deviceuntil
changed
b y a R E A D E RO C L s t a t e m e n ta, R E A D E R
c o m m a n do, r u n t i l a n I P L i s p e r f o r m e d .T h e R E A D E R
OCL statementis readby the currentsysteminput device
and specifies
the new systeminput device.The READER
commandspecifiesnot only the new systeminput device,
b u t a l s ot h e p a r t i t i o ni t i s a s s i g n etdo . W h e nt h e R E A D E R
commandis entered,the specifiedpartitionmust be at end
of job or end of job step,and, if executingin job mode,
the partitionmust havereleased
its currentsysteminput
device.

.

Systemmessages
and control statements
areloggedto
the 3284 when the 3284 is assigned
asthe systemlog
deviceand is not beingusedby a programin a partition.

.

When1403 printedoutput is beingspoolei,spoolingis
active(interceptingprint requests
for this partition),
and the systemlog devicehasbeenassigned
to the 1403
printer.all systemmessages
that would normallybe
loggedon the 1403areplacedon the spoolprint queue.
Whenthe spooledoutput is printed,the systemmessages
are printedalongwith the job step'soutput.

The systeminput devicecan be changedin a spooledjob
stream;however,jobs arescheduled
for executionfrom
the readerqueueonly when the systeminput deviceis
the sameasthe spooledreaderdevice.

o All systemmessages
and OCL statements
areloggedto
the systemhistoryarea(SHA) on the systempack.

The systemcontrol programsupportfor sysinis usedby
most of the systemfunctionsthat readinput. This includes
the systemserviceprogramsand the language
translators.
The usermay usesysinvia the ACCEPTverb in COBOLor
a macrostatementwith the basicassembler.Spooling
supportdoesnot usesysin.

Note: The SHA may be printedor copiedto a device
independentfile by the systemhistoryareadisplay
program($HIST),or displayedon the CRT by useof
the DISPLAY command. SeePart4 for a description
of $HIST or AppendixC for a summaryof the DlSpLAy
command.
The followinginformationis not loggedon the printer
but is loggedin the systemhistoryarea(SHA):

S Y S T E ML O G D E V I C E

a Responses
to ERP (errorrecoveryprocedures)
messages

The systemlog device,specifiedduringsystemgeneration,
is usedby the systemto communicatewith the operator
and to recordmessages,
OCL statements,
and OCC
commands.

o Responses
to EJ/ESmessages
.

Volumerecognitionfacility mes,sages
and responses

o Spoolingmessages
and responses
The devicespecifiedasthe systemlog deviceremainsin
effect until a LOG OCL statementaltersit; the new system
log deviceremainsin effect until anotherLOG sratement
is processed
or anotherIPL is performed.A systemlog
deviceis assigned
for eachpartition;for example,the 1403
printermay be the log devicefor partitions1 and 2, and
the CRT/keyboardmay be the log devicefor partition3.

o Any ERP message
receivedwhile a printer ERp message
is active.

In selectingthe systemlog device.the usershouldconsider
t h e f o l l o w i n gp o i n t s :

o Partitionidentificationon OCL statements
and control
statementsfor systemserviceprograms.

o Systemmessages
(informationaland decisiontype) are
loggedto the CRT independent
of the assignment
of
the log device.The only effect of a LOG CONSOLE
statementis to stop loggingto a printer.

lf loggingof the aboveinformationis required,the log
deviceis assigned
only to the CRT, and the contentsof
the systemhistory areaareperiodicallyprinted by $HlST.

o occ
o OCCdiagnostics

o Systemmessages,
OCL statements,
and control statementsare loggeddirectlyto the 1403 when the 1403 is
assigned
asthe systemlog device,and print spoolingis
neitheractive(intercepting
print requests)nor usingthe
1 4 0 3( p r i n t i n gs p o o l e do u t p u t )a n dt h e 1 4 0 3i s n o t
beingused,bya programin anotherpartition.

System Facilities

2-65

S Y S T E MP R l N T D E V I C E

S Y S T E MH I S T O R YA R E A

The systemprint device,specifiedat system
generation,
is usedby varioussystemfunctions,
suchas,n, libr.ry
maintenance
program,to print their output.

The systemhistory area(SHA) is a space
on the system
packthat containsa log or audit
trail of the following
information:

The PRINTERstatementis usedto change
the system
print deviceor provideinformation
about printer output
that hasbeenspooled.

o OCL statementsloggedby the
system
o OCL diagnostics
issued

The PRINTERstatementdefinesthe
systemprint device
for the partition in which the statement
is processed.
Eitherthe 1403or 32g4 printercan
be defineoasthe system print device;however.spoolsupports
only the 1403.
The systemprint devicemay be changed
in a spooledjob
stream;however,if the new deviceis the
32g4. printed
output for the systemprint deviceis not placecl
on the
print queue. Spoolingof systemprinted
output resumes
wfienthe systemprint deviceis reassigned
tothe ,|403.
For more informationon the pRINTER
statement,see
P a r t1 .

o Controlstatementsloggedby
the systemfor sysrem
serviceprograms
o Operatorcontrol commandsentered
o Diagnostics
issuedfor operatorcontrol commands
o Systemmessages
issued
o Volumerecognitionfacility (VRF)
mg556rr.
.

SYSTEMPUNCHDEVICE

o Unit recordrestartand 3340 restart
messages

The systempunchdeviceis usedto provide
optionaloutput
from systemfunctionssuchasthe overlay
linkageeditor
and output from the library-to-punch
function of the
librarymaintenance
program. A defaultsystempunch
devicemay be established
for eachpartitionduringsystem
generation.
The followingdevicescan be assigned
asthe systempunch
device: 5/24MFCU,2560 MFCM, 1442Card
Readpunch,
or 3741 DataStation/programmable
Work Station. The
PUNCHstatementis usedto changethe
systempunch
deviceor provideinformationabout punch
output that
hasbeenspooled.
The systempunchdevicemay be changed
in a spooledjob
stream;however,if the new systempunch
deviceis not the
spooledpunchdevice,punchedoutput for
the systempunch
deviceis not placedon the punchqueue.
Spoolingof this
punchedoutput resumes
when the systempunchdeviceis
reassigned
to the devicedesignated
asthe spooledpunch
device.

Operatorresponses
to systemmessages

o Programproduct messages
o Displayscreenimages(optional)
A systemhistoryareais createdon the systempack
during
systemgeneration;
a sizeoption with a minimum of two
tracks(48 sectors)is provided.The allocatefunction
of
the librarymaintenance
programreserves
spacefor the
systemhistoryareawhen allocatinglibraries
on a packthat
will be usedasa systempack_thereis only
one system
historyareaper simulationarea.
The librarymaintenance
programis the only meansto
changethe sizeof the systemhistoryarea(HISTORy
parameterof the allocatefunction)
after systemgeneration.
T h e m i n i m u ms i z ei s 2 t r a c k s t; h e m a x i m u mi s
the number
of contiguoustracksavailableon the packfollowing
the
objectlibrary. The foilowingareconsiderations
for determiningthe sizeof the systemhistoryarea:
.

Eachrecordin the areais 40 bytes;this is the
length
o f o n e l i n eo n t h e C R T .

o Eachoperatorcontrol command
and eachOCCdiagnosticrequiresone record.

2€6

Pageof GC21-5162-1
lssued28 September1979
ByTNL: GN21-5674
o

a

Each OCL statement and each control statement require
no more than three records, but generally require only
one record.

Information in the system history area can also be lost
when the library maintenance program is used to reorganizean object library (unlesscompress in place is used),

Each messageand each messageresponsegenerally
r e q u i r eo n l y o n e r e c o r d .

or when the program allocatesor changesthe size of a
source library. Therefore, it is advisableto print the
contents of the system history area on a regular basis-as
the last step of a job, for instance.

T h e f o l l o w i n g c a n b e u s e dt o d e t e r m i n et h e n u m b e r o f
t r a c k sr e q u i r e d :

Numberof Tracks
2 (minimum)
3
4
5
10
15
20

Numberof Records
233
377
521
665
13 8 5
2105
2825

The system history area can be printed or written to a
device independent data managementfile by the system
h i s t o r y a r e ad i s p l a y p r o g r a m ( $ H I S T ) , w r i t t e n t o a d i s k f i l e
by the system history area copy program ($HACCP) under
C C P , o r d i s p l a y e do n t h e C R T b y u s e o f t h e D I S P L A Y
command. A copy of the system history area can aid in
t r o u b l e s h o o t i n gp r o b l e m sa n d c a n p r o v i d e a n a u d i t t r a i l o f
s y s t e m a c t i v i t y . S e e P a r t 4 I o r a d e s c r i p t i o no f $ H I S T
and Appendix C for a summaryof the DISPLAY command.

SPOOLING
The system history area is a reusablearea. When the space
i s f i l l e d , t h e o l d e s t e n t r i e sa r e o v e r l a i db y t h e n e w e s t
entries, a processcalled SHA wraparound. To prevent data
f r o m b e i n gl o s t , t h e H A L T c o m m a n d w i t h t h e S H A p a r a m eter is used. HALT SHA causesa decision-type messageto
b e i s s u e dw h e n t h e S H A w r a p a r o u n dw a r n i n g p o i n t i s
r e a c h e d . ( T h e S H A w r a p a r o u n dw a r n i n g p o i n t i s d e f i n e d
a s a s p e c i fi c n u m b e r o f t r a c k s t h a t r e m a i n i n t h e S H A b e f o r e u n p r i n t e d e n t r i e sa r e o v e r l a i d . ) T h e m e s s a g ei s n o t
i s s u e da g a i nu n t i l e i t h e r $ H I S T o r $ H A C C P h a s b e e n e x e c u t e d . T h e H A L T S H A , C C P c o m m a n d a u t o m a t i c a l l yi n v o k e s $ H A C C P w h e n t h e S H A w r a p a r o u n dw a r n i n g p o i n t
i s r e a c h e d .T h e H A L T S H A c o m m a n d r e m a i n si n e f f e c t
u n t i l a N O H A L T S H A c o m m a n d i s e n t e r e d ,a n I P L i s p e r formed, or the SHA is full messageis respondedto without
s u b s e q u e n t l ye x e c u t i n g$ H I S T o r $ H A C C P .
Note: Ihe system history area copy program ($HACCP)
can be used to copy the current portion of the SHA to a
d i s k f i l e . T h i s p r o g r a mc a n b e a u t o m a t i c a l l yi n v o k e d i f
t h e c o m m u n i c a t i o n sc o n t r o l p r o g r a m ( C C P )i s e x e c u t i n g .
For information about the system history area copy program, see lhe IBM System/3 Communications Control
Program System Reference Manual, GC21 7620.
T h e l i b r a r y m a i n t e n a n c ep r o g r a m ( $ M A I N T ) i s u s e d t o
change the size of the system history area. The SHA wrapa r o u n d w a r n i n g p o i n t i n t h e c o n f i g u r a t i o nr e c o r d i s r e d u c e d
d u r i n g I P L i f i t e x c e e d so n e - h a l ft h e n e w s i z eo f t h e S H A .

S p o o l i n gs u p p o r t f o r M o d e l 1 5 i s a n o p t i o n a l f a c i l i t y o f
t h e s y s t e mc o n t r o l p r o g r a m f o r h a n d l i n gu n i t - r e c o r di n p u t
and output at disk l/O (input/output) speed,thereby
increasingtotal system throughput. Spooling support must
b e s p e c i f i e dd u r i n g s y s t e m g e n e r a t i o n v; a r i o u so p t i o n s
enable spool to be tailored to the user environment.
To handle a system's unit-record l/O without being dependent on l/O device speeds,spooling support builds a file
o n o n e o f t h e m a i n d a t a a r e a sa n d u s e st h i s f i l e f o r i n t e r m e d i a t es t o r a g e . T h i s a r e a i s l o g i c a l l yd i v i d e d i n t o q u e u e s
f o r r e a d e ri n p u t a n d p r i n t a n d p u n c h o u t p u t d a t a .
As job streams (including OCL statements,programs.and
data) for the individual partitions are read. the spool reader
routine stores each job on the reader queue. After a job
has been completely read and stored in the reader queue,
it is ready to be transferred to the appropriate partition
1 1 , 2 ,o r 3 ) f o r e x e c u t i o n .
When the operator initiates execution in a partition by
respondingto the EJ message,spooling support presentsall
the records for a job to the partition as though they were
just read from the physical input device. When all job
stepsfor a job have been executed, the spooling support
removesthe job from the reader queue.

System Facilities

2-67

As a job executes,its printedand/orpunched
output is
s t o r e dt e m p o r a r i l yi n t h e s p o o lf i l e o n p r i n t
a n dp u n c h
queues.The output may be printed
or punchedraterwhire
otherjobs areexecuting,thus allowing job
a
to execute
without havingto wait for the unit_record
devices.

o Only programs48K or lessmay be
checkpointed.A
diagnosticis issuedwhen attemptingto checkpoint
a
programlargerthan 4gK.
a Programs
usingf ile sharingor externalbufferscannot
be checkpointed.

Whenever
a spooledreader,cardpunch.or printer
becomes
inoperative,
the systemcontinuesprocessing
jobs already
on the readerqueue. Whenthe l/O unit
becomesoperative
a g a i nr, e a d i n gp, u n c h i n go, r p r i n t i n gc o n t i n u e s
w i t h o u ta
lossof output or processing
time.

.

o lf any l/O requestsfrom partition
1 are beinghandled
by spooling,checkpointrequests
are ignored;therefore,
spoolingshouldbe stoppedin partition 1 using
a STOp
command. SeeAppendixC for a summaryof the
STOp
command.

with spooling,iobs can be executecr
in ail threepartitions
without the needfor separate
unit-recorddevicesfor each
partition. For example,one card
readercan be the system
input devicefor all threepartitions;
threecard readersare
not necessary.
Also, one printercan serviceall threeparti_
t i o n sw i t h o u td e v i c ec o n t e n t i o n .

o Any l/O devicesbeingusedby spooling
that wallbe used
by the checkpointprogrammust be released
by operator
control commands.(SeeAppendixC for a summary
of
operatorcontrol commands.
)

Executionof the spoolingfunctionsis
controlledwith
operatorcontrol commandsand operation
control language.
For further informationon spoolsupport,
seetBM System/3
Model l5 lJser'sGuide to Spooling, GC2j_7632.

CHECKPOINT/RESTART
Checkpointis a meansof recordingthe
statusof a user
programat desiredintervals.Restart
is a meansof resuming
the executionof the programfrom the
lastcheckpoint
ratherthan from the beginning,
when processing
is termi_
natedfor any reason(with the exception
of a controiled
cancel)beforethe normalend of job, such
aswhen a power
failureoccursand causesan interruption.
Whencheckpoint/restart
is used,the followingprogramm i n gc o n s i d e r a t i o n
s o u l db e k e p t i n m i n d ;
sh
o Checkpoint/restart
enablesthe userto restarta check_
pointedprogramfrom the lastcheckpoint
taken pro_
videdno interveningprogramexecutions
havetaken
place.
o The checkpoint/restart
supportwasselecteddurinq
systemgeneration.
.

2$a

Checkpointrequests
areacceptedonly in partition 1.
Checkpointedprogramsmust be restarted
in partition 1.
ff partitions2 or 3 areusedto execute
a checkpoint
program,the checkpointrequests
are ignored.

A LOG statementmay be requiredto reestablish
the
partition'sloggingdevice.

o lf CCPis activein the partition being
checkpointed,
the checkpointrequestis ignored.
o lf the intervaltimer is beingusedto
time intervalsfor
the partitionbeingcheckpointed,
the checkpointrequest
is ignored.
o A PRINTERstatementmay be
requiredto establishthe
3284 asthe printer. Multifile tapevolumesthat
have
beenprepositioned
and left thereby tapeallocate
(SEONUM-X
p a r a m e t eor n F I L E s t a t e m e n tw) i l l n o t
be checkpointedor repositioned
duringrestarr.
.

A R E A D E Ra n d / o rP U N C Hs t a t e m e n t ( sm) a y b e
requiredto reestablish
the spooledreaderand punch
devices.

o Compilersand the overlaylinkage
editor shouldnot run
i n p a r t i t i o n1 a s i n t e r v e n i npgr o g r a mw
s ith a LOAD "
or temporarycheckpointprogram.Whena program
is
catalogedby the overlaylinkageeditor, if the checkpoint programis terminated(immediate
cancel).the
checkpointprogrammay be deletedbeforethe restart.
Preceding
the initiationof the checkpointprogramwhen
spoolingsupportis active,a STOpSPOOLcommand
must
be enteredto terminatespoolingin partition I.

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued 28 September 1979
By TNL: GN21-5674

Assume the f ollowing job stream was submitted:
/ / J O B C HI " P T J O B P A R T I T I O N . l , S P O O L - N O
//CH KPTl LOAD CHKPT,unit
/ / P A U S E S T O PT H E S P O O L R E A D E R A N D P R I N T
A N D P U N C HW R I T E R S
// RUN
T h e J O B s t a t e m e n ti n c l u d e sP A R T I T I O N - 1 a n d S P O O L - N O .
These parametersprevent the checkpoint job from being
run in partitions 2 or 3 or, if spooling is active, in partition
1 . l f s p o o l i n gi s a c t i v e ,i t i s t h e o p e r a t o r ' sr e s p o n s i b i l i t y
t o s t o p s p o o l i n gi n p a r t i t i o n 1 a n d r e s u b m i tt h e c h e c k p o i n t
iob.
The PAUSE statement is a technique to inform the operator
t h a t t h e c h e c k p o i n t p r o g r a mw i l l b e i n i t i a t e d . T h i s s t a t e m e n t i s n o t r e q u i r e di f s p o o l i n gi s n o t a c t i v e .
T h e f o l l o w i n g o p e r a t o r c o n t r o l c o m m a n d ss h o u l d b e
e n t e r e da t t h i s t i m e :
STOPPRT
STOP PCH or STOP RDR
This releasesthe spooled devicesfor the checkpoint
program.

SystemFacilities 2-68.1

T h i sp a g ei n t e n t i o n a l l lye f t b l a n k .

2-68.2

Restartalsorequiresspoolingsupportto be inactivein
partition 1, and the devices(samedevicesasusedby the
checkpointprogram)must be released
by usingoperator
controlcommands.
The followingOCL is required:
/ / J O BR S T RJ O B S P O OL - N O , P A R T I T I O N - 1
// LOAD$$RSTR,unit
// RUN

o Interveningand activecheckpointprogramsmust not
add to the samef ile.
Note: The checkpointmust be deactivated
beforeloading a checkpointprograminto partition l.
o T h e $ D E L E Tf u n c t i o n( F O R M A Ts t a t e m e n ti)s n o t
usedto deallocate
spacewhich doesnot containfiles,
libraries,or systemareason any packsusedby the
c h e c k p o i npt r o g r a m .

SPOOL-NOis requiredto preventthe job from beingrun
i f s p o o l i n gi s a c t i v ei n p a r t i t i o nl . p A R T I T I O N - l i s
requiredbecause
$$RSTRcan only be executedin partition
1.

Checkpoints
can be takenvia linkageprovidedby COBOL
and the basicassembler.Seethe appropriatereference
m a n u afl o r m o r e i n f o r m a t i o n .

Programs
can be executedprior to the restartof a checkpoint program;however,the followingitemsshouldbe
observed
sinceno systemprotectionis provided:

I N O U I R YP R O G R A M

o The checkpointprogramhasbeenpermanentlycataloged. Also, LOAD * must not be used.
o lf any tapesare processedby the basictape access
method(BTAM) or by direct call to tape IOS in the
checkpointprogram,they aredismountedto allow the
interveningprogramto usethe tapeunits. The user,s
restartroutinemust repositionthe tapesto the status
at the activecheckpoint.
o $MAINT is not executedduringthe time between
failureand restartof the checkpointprogram.
r

T h e R P Gl l , F O R T R A N ,a n d C O B O Lc o m p i l e r a
s nd
the assemblercan be executedif the object programis
punchedor catalogedto a pack other than the program
(load)packof the checkpointprogram.Anything with
the samenameasthe checkpointprogramcannotbe
catalogedon the programpackof the checkpoint
program.

a Interveningprogramsmust not access
disk volumesin
useby the activecheckpointprogramfor new or scratch
fi les.
o Disk files beingusedby the checkpointprogramshould
not be modifiedby an interveningprogramif the user,s
restartroutinestoresselectedrecordsin the files. This
destroysthe updatesof the interveningprogram.
o The disk packsonlineat restartarethe samepacksas
thoseusedby the checkpointprogram,at the last
checkpoint.

An inquiry programis a programthat is identifiedasan
l - t y p ep r o g r a mi;t c a n b e e i t h e ra n R p G o r F O R T R A N
program.The programwill haveattributesof X,4000,
after it hasbeencompiledand link edited. l-type programs
can only be executedby an inquiry request(pressing
the
PA1 key on the keyboard).An l-type programcannotbe
interrupted. l-type programsaremost efficientin a multiprogrammingenvironmentbut can alsobe usedon a dedicatedsystem.Spoolingcannotbe usedfor an l-type
program.
For more informationon executingan inquiry program,
seel8M System/3 Model l5 Operator's Guide, GC21-S07S,
IBM System/3 RPG ll ReferenceManual, SC2l-7504. and
IBM System/3 FORTRAN lV ReferenceManual,
sc28-6874.

S Y S T E MI N T E G R I T Y
Systemintegrityand securityof userdatais providedin
severalways:

Data File Security: File labelsand volume labelsprotect
datafilesfrom accidentallybeingdestroyedwhena wrong
datamoduleis mounted,a wrongprogramis loaded,or an
attemptis madeto write overa valid datafile.
Everydisk data file is protectedby a file labelcontaining
file characteristics.
Sometypical fieldsin the file label
arethe file name,creationdate,retentionstatusof the file,
and file type. The usercannotaccess
or changethe file
without first checkingthe file label.

System Facilities

2-69

The volumelabelrecorddefines
the characteristics
of a
m a i nd a t aa r e ao r a s i m u l a t i o na r e a .
A t y p i c a lf i e l d i n t h e
v o l u m el a b e li s t h e p a c kn a m e .

A U T O M A T I CM E S S A G ER E S T A R T
{UNITRECORD
RESTART)

T o u s ea p a r t i c u l adr i s kf i l e r e q u i r e d
i n a p r o g r a mt,h e u s e r
m u s tp r o v i d et h e n e r

A u t o m a t i cm e s s a gree s t a r e
t l i m i n a t etsh e n e e df o r s y s t e m
o p e r a t o irn t e r v e n t i o inn r e s p o n d i n(gw i t h
a 1 o p t i o n )t o
certatnsystemmessages.

sta
tements.,n,,u,liilL:T'J
*:''."#,|;HH,"J
;::

statementsto verify that the
correct pack is mounted and
t h a t t h e r e q u i r e dd i s k f i l e o r a r e a
is available.

Volume Security: There are
times when an entire volume
( a m a i n d a t a a r e aa n d
its associated
s i m u l a t i o na r e a s )i s
d e d i c a t e dt o o n e p a r t i t i o n , su s e .
D u r i n g t h e s ep e r i o d s ,a n y
r e q u e s tf r o m a n o t h e r p a r t i t i o n
f o r a n y o f t h e s ea r e a sw i l l
be denied(F/message)C
. onditions
w h i c h r e q u i r ev o l u m e
d e d i c a t i o na r e :
o Offline Multivolume
F : i l ea c t i v e
.

$lNlT (Type-Force)

o Deferred Mounts
o Dismount pending
s i t u a t i o n s( W p

m e s s a g er s o n t h e C R T )

5 7 0 4 - S C 2p r o v i d e sa v o l u m e r e c o g n i t i o n
facility (VRF)
f o r m a i n t a i n i n gd i s k i n t e g r i t y
a n d p r o v i d i n ge a s eo f u s e f o r
334013344 attention situations. primary
fJrrctions ot ttre
VRF are:
o

o

Diagnoseimproper pack changes
and request that the
o r i g i n a lp a c k b e p l a c e d b a c k o n l i n e .
D i a g n o s ei m p r o p e r s t a t e c h a n g e( w r i t e
to write
i n h i b i t e d ) . C h a n g i n gt h e s t a t e
of the drive to write
i n h i b i t e dc a n n o t b e a l l o w e d ( 0 B
m e s s a g ei)f a n y a c t i v i t y
e x i s t so n t h e e n t i r e d r i v e .

o Automatic restart for
3:340/3344 diagnostic messages
a n d p a c k c h a n g em e s s a g e sM
. e s s a g ew
shich qualify for
automatic restart are listed in the
lgM System/3
Model I S System MessagesManual
, GC21_5076.
T h e V R F m a i n t a i n sa t a b l e o f p a c k
n a m e sf o r e a c h d i s k
a r e a ( m a i n d a t a a r e a sa n d s r i m u l a t i o n
a r e a s ) .T h i s t a b l e
e x i s t si n r e s i d e n ts t o r a g e ,i s i n i t i a l i z e d
at lpL ano updated
any time a valid pack change occurs
or a system service
program changesthe pack
name (SSCOpy, $DCOpy,
$ C O P Y , a n d g l N l T ) . R e a d / W r i t es t a t e
o f e a c hd r i v e i s a l s o
m a i n t a i n e di n t h i s t a b l e .
y'y'ofe;Changing pack
a
name by any other means is not
a l l o w e d a n d m a y c a u s eu n p n e d i c t a b l e
r e s u l t su n l e s s
i m m e d i a t e l yf o l l o w e d b y a n l p L .

2-70

This function of the SCpcan be included
duringsystem
generationby the userspecifying
the unit recororestart
and/orthe extendedrestartoption(s).
Regardless
of the
option selected,
certainmessages
areautomaticallyrestarted
for the 3340 DirectAccessStorageFacility
and the 3344
DirectAccessStorage.For more information
about automatic message
restart,refer to the IBM System/3Model
l5
System Messages,GC21-5076.
For automaticrestart,the message
response
is placedin
the systemhistoryareawith an R in the
response
position
( i n d i c a t i nagu t o m a t i cr e s t a r t
a n d i m p l i c i t l ym e a n i n g
a1
option response).lf the response
is loggedto a pnnter,
t h e r e s p o n speo s i t i o nw i l l c o n t a i na 1 .
T h ec o n f i g u r a t i o rne c o r dp r o g r a m( $ C N F I G )
c a nd i s a b l eo r
e n a b l et h e e x t e n d e dr e s t a r ft u n c t i o ni f
t h e u s e rp r e v i o u s l y
selectsthe extendedrestartand/orthe unit
recordrestart
f u n c t i o n ( sd) u r i n gs y s t e mg e n e r a t i o n .
All messages
that apply to the automaticrestartfunction
are includedin the IBM System/3Model
| 5 System
Messages,
GC21-b076publication.

Unit RecordRestart(SystemGeneration
Optionf
Unit recorddeviceerror recoverymessages
can be auto_
m a t i c a l l yr e s t a r t e fdo r t h e f o l l o w i n gd e v i c e s :
2 5 0 1C a r d
Reader,1442 CardReadpunch, S4Z4
MFCU,2560MFCM,
3741 DataStation,3741 programmable
Work Station,
f i r s t ' 1 4 0 3P r i n t e r a, n ds e c o n d1 4 0 3p r i n t e r .

ExtendedRestart(SystemGeneration
Optionl
The followingmessages
are automaticailyrestartedwhen
t h e a p p r o p r i a tree s o u r c ies a v a i l a b l e :
Component Halt
lD
lD

Subhalt Resource
lD
Needed
Px
px

SP

F/
WA
UT

SP

UT

RE

82

02

NI

Disk
Disk
J o b a v a i l a b loen
r e a d eq
r ueue
J o b a v a i l a b loen
readerqueue
Tape

M A I N S T O R A G EU S A G E
CPUmain storageis logicallystructured(carvedup) during
systemgenerationaccordingto specifiedoptionsdescribing
t h e u s e r ' so p e r a t i n g
e n v i r o n m e n tT. h e f o l l o w i n gi l l u s t r a _
tion showsthe logicalstructure.

The supervisor
containsthe systemcontrol programsthat
performthe functionsnecessary
for the operationof a
system.The sizeof the supervisor
is basedon the options
chosenat systemgeneration.The approximatemain
storagerequirements
for eachof the functionsis asfollows:
Basesupervisor

Supervisor
Partition 1

gser program
External buffers

P a r t i t i o n2

Userprogram

23.O7
(includes3340/
3344 supportand
a n dm i n i m u m2 K
fileshare
commonarea)

Options:

Externalbuffers
Partition3

Userprogram

e"t.-JouTiers
File ShareArea

-

F i l eS h a r i n g - a d d i t i o n a l
commonarea
Tapesupport
3 7 4 1s u p p o r t
3284 support
2 5 0 1s u p p o r t
1 4 4 2s u p p o r t
M F C Us u p p o r t
M F C Ms u p p o r t
l/O storageprotection
Unit recordrestart
S u p p o r tf o r M L T A / B S C A / L C A / D A
S u p p o r tf o r S I O C
Memoryresidentoverlays

0-14K
1. 1 6
0.50
0.50
O.21
O.2S
0.65
0.69
0.49
0.34
1.41
1.81
O.bO

I n t e r v aTl i m e r :
T i m eo f d a y o n l y
F u l l t i m e rs u p p o r t

o.47
2.00

Spooling:
Minimum
Maximum

7.11
20.79

CCP:
Minimum
Maximum

1.90
6.il

System Facilities

2-71

2-72

Part 3. Disk Storage

Part 3. Disk Storage

3-1

DirectAccessStorage

Diskstorageis providedby one of the followingconfigurations: 3340 Model42; or 3340 ModelA2 and 3340 Model
B1; or 3340 ModelA2 and 3340 ModelB2; or 3340 Model
A2 and 3344 Model82.

3 3 4 0 D I R E C TA C C E S SS T O R A G EF A C I L I T Y
A 3340 ModelA2 or 3340 ModelB2 consistsof two drives.
A 3340 ModelB1 consistsof one drive. Eachdriveutilizes
a removabledatamodule(referredto asa volume)asthe
storagemedium. Eachvolumeconsistsof a main dataarea
and its associated
simulationareas.The followingillustration showsthe format of a datamodule(volume)mounted
on drive 1 or 2.

I

I
I
-l

-r--iMain DataArea

t

t

l

t

t

l

I
J

\<-v,--l

Simulation Areas

Direct Access Storage

3-3

4344 DIRECTACCESSSTORAGE
A 3344 Model82 consistsof two drives.The storage
mediumon eachdrive is fixed and cannotbe removed"The
storagemediumon eachdrive is dividedinto four volumes.
The format of eachvolumeis similarto a 3340 votume.
Oneexceptionis that only two simulationareasareassociatedwith eachmain dataarea. Also. the main daraareaon
a 3344(single
v o l u m e )h a sa l a r g e cr a p a c i t ve S . 7 m i l l i o n
bytes)than the main dataareaon a 3340 volume(40.g
m i l l i o nb y t e s ) .
The followingillustrationshowsthe storagemediumdivided
into four volumes.(A volumeis one main dataareaand its
associated
simulationareas.)
F o u rV o l u m e s
O n eV o l u m e
/-..'-//\..'-\

\

Simulation
- _Areas
\
\

The threepartsof Figure3-l showthe capacityand format
for eachstoragemediumusedon the disk storagedevices.
Part 1 showsthe byte capacityfor eachdivisionof the
storagemedium. Part2 showsthe byte capacity,by model,
for the main dataareas.part 3 showsthe byte capacityand
t h e c y l i n d e rd e s i g n a t i ofno r e a c hd i v i s i o no f a v o l u m e .

DISK
CAPACITY
IN BYTES

3348 Data
Module
(3340)
Drives1 and 2

t-lserdata area
Simulationarea
Subtotal
C ! l i n d e r0
(reserved)
Subtotal
Alternatetracks
(reserved
)
Other use
(reserved)
Total physical
capacity

3348 Data
Module
(33401
Drives3 and 4

334/Direct
Access
Storagel

40,796,160

40,796,160

45,711,360

9,830,400

4,915,200

4,915,2ffi

334,4
Direct
Access
Storage2

182,845,440
19.660.800

50^6r6560

4t?1 1360

50^6r6560

2OL5O6r24o

245,760

245,760

245,760

983,040

n,872,320

45,957l?o

n,872,320

203,489,280

491,520

491,520

491,520

1,966,080

98,304

98,304

245,760

983.040

51,462,144

46,5.4.6,944

51,609,600

206,438,400

';ffi"
-One

drive;four volumes.

Figu,'r,.11 (Part 1 of 31. Byte Capacity of Each Storage Medium

Configurations

Storagein Millions of Bytes

3340r
One Model A2
One Model A2 and one Model 81
One Model A2 and one Model 82

81.6
122.4
163.2

3340/$44r
One 3340 Model A2 and
one 3344 Model 82

447.2

tstor"g

size is for main data areas onry and does not incrude simuration areas
or reserved areas.

Figure 3-1 (Pan 2 of 31. Byte Capacity (Main Data Areal for Each Model

Direct Access Storage

3-5

System Use

Cylinder
3348 Data
Module
3344 Direct
Access
Storage
EachVolume

Million
Bytes

User Data Area

Cylinder

Million
Bytes

SimulationAreas

C!linder

Million
Bytes

Cylinder

Million
Bytes

Total

0

0.25

1- 1 6 6

40.80

169-2081 9.93r
(4)

1 6 71 6 8
209

0.49
0.10

51.471

0

o.25

1- 1 8 6

45.71

189-208

18 7 - 18 8
209

0.49

51.61

o.25

4.91

(21
4 Volumes

Othelr Use

0.98

182.85

19.66

2.95

206.44

'lf

t h e d a t a m o d u l e i s m o u n t e d o n d r i v e 3 o r d r i v e 4 , o n l y t w o s i m u l a t i o n a r e a sa r e a c c e s s i b l e - T h e s t a r t i n g
cylinder is 189 and the
c a p a c i t y i s 4 . 9 1 m i l l i o n b y t e s . T o t a l c a p a c i t y i s 2 t 6 . 5 6m i l l i o n b y t e s .

Figure 3-l (Part 3 of 31. Byte Capacity and Cylinder Assrgnment
for Each Volume

SIMULATION AREAS

InterchangingData Modules (3340)

System control program 5704-SC2 requires the simulation
o f a 5 4 4 4 d i s k s t o r a g ed r i v e . A l l l i b r a r i e s( f o r e x a m p l e ,u s e r
programs,system programs,and procedures)are located in

Y o u c a n i n t e r c h a n g e la n y d a t a m o d u l e so n a n y d r i v e s .
However, to accessthe correct simulation area when a data
m o d u l e i s m o u n t e d o n d r i v e 3 o r d r i v e 4 r e q u i r e ss p e c i a l
c o n s i d e r a t i o n s .R e f e r t o F i g u r e3 - 2 a n d n o t e t h e u n i q u e
s i m u l a t i o na r e ac o d e s ( D 3 E , D 3 A , D 4 E , a n d D 4 A ) a n d t h e i r

a n a r e ao n d i s k c a l l e da s i m u l a t i o na r e a . T h e c o n t e n t s o f
t h e s i m u l a t i o na r e aa r e t h e n u s e d i n t h e s a m ew a y a s a 5 4 4 4
d i s k s t o r a g ed r i v e .
F o u r s i m u l a t i o na r e a s e
, a c h h a v i n ga u n i q u e c o d e , c a n b e
accessedon each of the volumes mounted on disk drives 1
a n d 2 . E a c h s i m u l a t i o na r e a i s c o n t a i n e dw i t h i n 1 0 c o n t i g u o u s c y l i n d e r so f a v o l u m e . ( A v o l u r n e i s o n e m a i n d a t a a r e a
and its associatedsimulation areas.) Therefore, a total of 40
cylinders, 169 through 2O8, are reservedfor the simulation
areason these drives. Disk drives 3 and 4 can be a 3340 or
3344. However, regardlessof the type of disk drive, each
v o l u m e o n d r i v e 3 o r 4 c o n t a i n so n l y t w o s i m u l a t i o na r e a s .
T h e s ea r e a s ,h a v i n gu n i q u e c o d e s ,o c c u p y c y l i n d e r s 1g 9
through 208.

l o c a t i o n a s s i g n e dt o t h e s i m u l a t i o na r e a so n d r i v e s3 a n d 4 .
Also notice that only two simulation areascan be accessed
o n e a c hd r i v e .
S i m u l a t i o n a r e a sD 3 E ( d r i v e 3 ) a n d D 4 E ( d r i v e4 ) o c c u p y
t h e s a m e r e l a t i v ec y l i n d e r s ( 1 8 9 t h r o u g h 1 9 8 ) a s s i m u l a t i o n
a r e a sc o d e d D 1 C ( d r i v e 1 ) a n d D 2 C t i d r i v e2 ) . A l s o . s i m u l a t i o n a r e a sc o d e d D 3 A ( d r i v e 3 ) a n d D 4 A ( d r i v e4 ) o c c u p y
t h e s a m e r e l a t i v ec y l i n d e r s ( 1 9 9 t h r o u g h 2 0 8 ) a s s i m u l a t i o n
a r e a sc o d e d D 1 D ( d r i v e 1 ) a n d D 2 D ( d r i v e 2 ) . T h e r e f o r e ,
when you move a data module from drive2 to drive3 and
the system accesses
the simulation area coded D3A, the data
r e t r i e v e di s a c t u a l l y f r o m s i m u l a t i o n a r e a D 2 D . T h i s s a m e
l o g i c i s t r u e f o r s i m u l a t i o n a r e a c o d e sD 3 E , D 4 E , a n d D 4 A .
T h e m a c h i n ew i l l n o t a c c e s sc y l i n d e r s 1 6 9 t h r o u g h 1 8 8 i n
t h e m a i n d a t a a r e aw h e n t h e d a t a m o d u l e i s m o u n t e d o n
drive 3 or drive 4. Therefore, when \/ou move a data
module from drive 1 or 2 to drive 3 or 4, the system cannot
r e t r i e v et h e d a t a l o c a t e d i n s i m u l a t i o na r e a sc o d e d D 1 A ,
D2A, D1B,D2B.

'You

m u s t p e r f o r m a n I P L a n y t i m e y o u c h a n g et h e s y s t e m p a c k o r
the pack that containsthe active$SPOOL f ile.

3€

Figure3-2 showsthe format and the uniquecodefor each
simulation
a n d m a i nd a t aa r e aw h e nt h e s y s t e mh a sf o u r
334O disk drives.

D4 or D41

D3or D31

D1

MainDataArea

Main Data Area

D1A

D2A
D2B
D2C
D2D

Io

D1B
D1C

D1D
Drive1 (3340)

MainDataArea

Io

Drive2 (3340)

D3E
D3A

Main Data Area

)o

Drive3 (3340)

D4E
D44

)o

Drive 4 (3340)

with eachvolume.
O D.notessimulationareasassociated
Figure 32.

Main Data Area and Associatod Simulation Areas

Accessing
SimulationAreas
D e p e n d i nogn t h e d i s kc o n f i g u r a t i o nt h, e n u m b e ro f a v a i l a b l es i m u l a t i o n
a r e a sc a nb e 8 ( t w o 3 3 4 0d i s k d r i v e s )1, 0
( t h r e e3 3 4 0 d i s kd r i v e s )1, 2 ( f o u r3 3 4 0 d i s kd r i v e s )o, r 2 4
( t w o 3 3 4 0 d i s kd r i v e sa n dt w o 3 3 4 4 d i s kd r i v e s )t;h e y a r e
a l f d i r e c t l ya c c e s s i b l eH.o w e v e rb, e f o r ea s i m u l a t i o na r e a
can be directlyaccessed,
it must first be assigned
to a5444
u n i t c o d eT
. h e 5 4 4 4 u n i t c o d e s a r e, F
R'1! , F 2 , a n d R 2 .
(Thesystemserviceprogram$SCOPYprovidesaccess
to a
simulationareaeventhoughit is not assigned
to a5444
unitcode.)

Duringsystemgeneration,each5444 unit code (F1, R1,
F2, R2l must be assigned
by partitionto a simulationarea
c o d e . T h e s i m u l a t i o na r e aa s s i g n m e n
mtu s tb e u n i q u ew i t h i n a p a r t i t i o n. T h e 5 4 4 4u n i t c o d e sm u s tb e a s s i g n eidn t h e
f o l l o w i n gs e q u e n cdeu r i n gs y s t e mg e n e r a t i o n :
F 1 , R 1, F 2 , R 2

Figure3-3showstheformatandcodeforeachsimulatio
and main data areawhen the systemhastwo 3340 disk
drivesand two 3344 disk drives.
lf you do not assignsimulationareas,systemgeneration
p r o v i d e tsh e f o l l o w i n gd e f a u l ta s s i g n m e n t s :

Assigning
SimulationAreas
F 1 - D 1 A ,R 1 - D 1 8 ,F 2 - D 2 A ,R 2 - D 2 B( a l lp a r t i t i o n s )
Assignment
of the simulationareasto the 5444 unit codes
m u s to c c u rd u r i n gs y s t e mg e n e r a t i o nA. s s i g n m e notc c u r s
when a unique simulationareacode, suchas D1C, is assigned
by partitionto a5444 unit codesuchas R2. Then,after an
I P L i s p e r f o r m e dt,h e s i m u l a t i o na r e aD 1 C i s d i r e c t l ya c c e s siblewhen 5444 unit code R2 is specifiedin the correct
p a r t i t i o n .F o r e x a m p l ea, s s u m sei m u l a t i o na r e aD 1 C i s
a s s i g n etdo u n i t c o d eR 2 . T h e f o l l o w i n gO C L s t a t e m e n t
causes
the systemto access
simulationareaD1C and load
the programnamed$COPY:

F o r m o r ei n f o r m a t i o na b o u ta s s i g n i nsgi m u l a t i o na r e a s .
refer to the l8M System/3Model l5 SystemGeneration
Reference
Manual,GC21-7616.

// LOAD$COPY,R2

Direct Access Storage

3-7

D1

vz

D3/D31

D4/D41

Main Data Area

Main Data Area

Main Data Area

Main Data Area

D1A
DlB
DlD
Drive 1 (3340)

I'

D24
D28
D2C
D2D
Drive 2 (334O)

I'

D3E
D3A
D32

fo

MainDataArea

D3F
D3B
D33

fo

Drive 3 (3344)

O

D"not., simulationareasassociated
with eachvolume.

Figure3-3. Main DataAr6a and AssociatodSimulationAreas

3-8

D42

fo

D4F
D4B
D43

fo

MainDataArea

fo

MainDataArea

D3H
D3D

D4A

MainDataArea

MainDataArea

D3G
D3C
D34

D4E

D4G
D4C
D44

I

fo

Main Data Area

fo

D4H

D4D
Drive 4 (3344)

fo

The following considerationsand restrictions apply when
y o u a s s i g ns i m u l a t i o n a r e a sd u r i n g s y s t e mg e n e r a t i o n .

F l m a y b e a s s i g n etdo a n y s i m u l a t i o na r e ae x c e p tD 1 B
a n d D 3 B . H o w e v e rw, h e nt h e I P L i s p e r f o r m e di,f t h e
s y s t e mp a c ki s o n d r i v e1 o r d r i v e3 a n dt h e P R O G R A M
L O A D S E L E C T O Rs w i t c hp o s i t i o ni s e i t h e rD I S K l F 1
sssigno r D I S K 3 F 1 , t h e s y s t e mo v e r r i d etsh e p r e v i o u a
m e n ta n da s s i g nFs1 t o D 1 A o r D 3 A i n a l l p a r t i t i o n s .

T h e f o l l o w i n gc o n s i d e r a t i o na sn d r e s t r i c t i o nasp p l yt o
reassignments:
.

T h e s i m u l a t i o na r e af r o m w h i c ha n I P L i s p e r f o r m e d
c a n n o tb e r e a s s i g n e d .

o D u p l i c a t ea s s i g n m e nat sr en o t a l l o w e dw i t h i n a p a r t i t i o n .

Numberof SimulationArea Assignments
R 1 m a y b e a s s i g n etdo a n y s i m u l a t i o na r e ae x c e p tD 1 A
and D3A. However,when the IPL is performed,if the
s y s t e mp a c ki s o n d r i v eI o r d r i v e3 a n d t h e P R O G R A M
L O A D S E L E C T O Rs w i t c ho o s i t i o ni s e i t h e rD I S K l R 1
o r D I S K 3 R 1 , t h e s y s t e mo v e r r i d etsh e p r e v i o u sa s s i g n m e n t a n d a s s i g nR
s1 to D1Bor D3B in allpartitions.
F 2 m a v b e a s s i g n etdo a n y s i m u l a t i o na r e ae x c e p tD 1 A ,
D l B . D 3 A .o r D 3 B .

T h e m a x i m u mn u m b e ro f s i m u l a t i o n
a r e a st h a t c a n b e
directlyaccessed
is: 10 in a three-partition
system;7 in a
two-partition
s y s t e m ; 4i n a s i n g l e - p a r t i t i os n
y s t e m .W h e n
an IPL is performed,the systemoverridesany previous
a s s i g n m e nttos e i t h e rF 1 o r R 1 a n da s s i g ntsh e s i m u l a t i o n
areacontainingthe systempackto all partitions.The
f o l l o w i n ge x a m p l es h o w sh o w a m a x i m u mo f 1 0 s i m u l a t i o n
areascould be assigned:

o R 2 m a y b e a s s i g n etdo a n y s i m u l a t i o na r e ae x c e p tD 1 A ,
D 1 B ,D 3 A ,o r D 3 B .

I

F1 assigned
to
R1 assigned
to
F2 assigned
to
R2 assigned
to

Dl A
D4E
D2A
D3A

SystemPack

Dl A
Dl D
BIA
Dl B

SystemPack

Partition2

to
( F1 assigned
to
) Rl assigned
fZ
assigned
to
)
( R2 assigned
to
to
F1 assigned
R l a s s i g n etdo
to
F2 assigned
to
R2 assigned

Dl A
D2D
D3E
D2C

SystemPack

Partition3

I
)
)
(

Partition1
SimulationArea Reassignment
(by partition)by useof
Simulationareascan be reassigned
the ASSIGNstatement.This statementcannotbe usedin a
p r o c e d u r ei t; c a n n o tb e p l a c e db e t w e e na C A L L a n d a R U N
statement;and it is effectiveimmediatelyafter being
processed.
The format of the ASSIGNstatementis asfollows:
areacode
// ASSIGN5444 unit code-simulation
on
One,two, or threesimulationareascan be reassigned
e a c hA S S I G Ns t a t e m e nut n l e s st h e P A C Ka n d / o rA B E A
p a r a m e t ei rs u s e d . I n t h i sc a s eo, n l y o n e s i m u l a t i o n
area
for eachASSIGNstatement.
can be reassigned
T h e n e w a s s i g n m e nr et m a i n si n e f f e c tu n t i l a n o t h e rA S S I G N
or until an IPL is performed,at
statementis processed
which time the simulationareaassignments
revertto those
m a d ed u r i n gs y s t e mg e n e r a t i o no,r d u r i n gt h e e x e c u t i o no f
the configurationrecordprogram.
Simulationareascan alsobe reassigned
by meansof the
c o n f i g u r a t i orne c o r dp r o g r a m$ C N F l G . T h i s p r o g r a m
reassigns,
by partition,the 5444 unit codesto the simulation areasby changingthe configurationrecordon the
systempackfrom which the IPL wasperformed. For more
information about this program,seeConfigurationRecord
Program-$CNFIG in Part 4 of this manual.

T h e s a m ea s s i g n m e ni st a l l o w e di n m o r et h a n o n ep a r t i t i o n .
F o r e x a m p l eR
, 2 c o u l db e a s s i g n etdo D 2 B i n a l l p a r t i t i o n s .
T h e f o l l o w i n ge x a m p l es h o w st h e d e f a u l ta s s i g n m e nat sn d
a l s os h o w sh o w a m i n i m u mo f f o u r s i m u l a t i o n
a r e a sc a n b e
assigned:
D1A
Dl B
D2A
D2B

SystemPack

Partition1

to
F1 assigned
to
R1 assigned
to
F2 assigned
to
R2 assigned

I

Dl A
D1B
D2A
D2B

SystemPack

Partition2

to
F'l assigned
to
R1 assigned
to
F2 assigned
R2 assigned
to

F 1 a s s i g n etdo D 1 A
R1 assigned
to D1B
F2 assigned
to D24
R2 assigned
to D2B

SystemPack

Partition3

t

Direct Access Storage

3-9

MAIN DATA AREAS

Disk SpaceAllocation

A main dataareais a portion of a volumethat is usedto
storedatafiles. (lt is not usedfor librarystorage.)

For the main dataareason a 3340 or 3344, the allocationof
d i s ks p a c eb e g i n sa t c y l i n d e rI a n de x t e n d st o w a r dc y l i n d e r
1 6 6o r 1 8 6 . l f t h e L O C A T I O Np a r a m e t ei rs s p e c i f i e o
dn
t h e F I L E s t a t e m e n ft ,i l e a l l o c a t i o nb e g i n sa t t h e s p e c i f i e d
l o c a t i o na n de x t e n d st o w a r dc y l i n d e r1 6 6 o r 1 g 6 .

Maindataareasfor eachvolumestartat cylinder 1 and
e x t e n dt h r o u g hc y l i n d e r1 6 6 ( 3 3 4 0 )o r l g 6 ( 3 3 4 4 ) .
Eachmain dataareais accessed
by meansof a specificcode.
lf the main dataareathat you want to accessis locatedon a
3340 datamodule,the disk drivethat the datamoduleis
mountedon determinesthe code. For example,if a data
moduleis mountedon drive 1. the codeto access
the main
d a t aa r e ai s D 1 , o n d r i v e2 t h e c o d ei s D 2 . o n d r i v e3 t h e
c o d ei s D 3 o r D 3 1 ,o n d r i v e4 t h e c o d ei s D 4 o r D 4 1 .
The storagemediumfor a 3344 is fixed, and the main data
areaof eachvolumeis assigned
a uniquecode. The following illustrationshowsthe uniquecodeand the relativelocation for each3344 volume:
D r i v e3

Temporaryor Permanent Files
Whenthe LOCATIONparameteris not specified.the entire
maindataareais searched
to find the optimum spaceavail_
a b l ef o r t h e f i l e . T h e f i l e i s a d j u s t e d
t o w a r dt h e c y l i n d e r1
end of the space.This procedureis alsousedto allocatethe
s p o o lf i l e .

Scratch Files
o Main dataareaon a 3344:
- T h e d i s ks p a c eb e t w e e nc y l i n d e r s1 6 7a n d 1 g 6 i s
searched
to f ind the optimum spaceavailablefor the
f i l e . l f s u f fi c i e n ts p a c ei s f o u n d ,t h e f i l e i s a d j u s t e d
toward the cylinder-186 end of the space.
- l f s u f f i c i e nst p a c ec a n n o tb e f o u n d w i t h i n c y l i n d e r s
1 6 7a n d 1 8 6 ,t h e e n t i r em a i nd a t aa r e ai s s e a r c h efdo r
t h e o p t i m u ma v a i l a b lsep a c e .T h e f i l e i s a d j u s t e d
toward the cylinder-186 end of the space.
o M a i nd a t aa r e ao n a 3 3 4 0 :
- The entiredisk is searched
for the optimum space,
a n d t h e f i l e i s a d j u s t e dt o w a r dt h e c y l i n d e r - 1 6e6n d
of the space.

D r i v e4

Considerations
and Restrictions
Use the file compress program ($FCOMp) periodically to
remove existing gaps between files.
To decreasethe amount of seek time, group all f iles
associatedwith a specific job together on the same
volume.
To decreasethe amount of seek time, fill all disk spaceon
a main data area of a 3344 to capacity before using a new
volume.

3-10

ALTERNATE TRACKS

File Processing
Considerations

An alternate track is a substitute track selectedto accept
the contents of a defective track. Forty alternate tracks are
a v a i l a b l eo n e a c h v o l u m e . F o r a 3 3 4 0 v o l u m e , t h e y a r e

Systemperformanceis degradedif an alternatetrack is
a s s i g n ef do r o n e o r m o r et r a c k so f a f i l e i n d e x . l t i s r e c o m mendedthat the file be movedso that the alternatetrack
c o n t a i n st h e d a t ap o r t i o no f t h a t i n d e x e df i l e .

c o n t a i n e di n c y l i n d e r s1 6 7 a n d 1 6 8 . F o r a 3 3 4 4 v o l u m e .
t h e y a r e c o n t a i n e di n c y l i n d e r s1 8 7 a n d 1 8 8 .
An alternate track can be assignedto any track except
c y l i n d e r 0 , h e a d0 o n t h e f o l l o w i n g m a i n d a t a a r e a s : D 1 ,
D 2 , D 3 , D 3 1 , D 4 , a n d D 4 1 . W h e n e v e ra p r o g r a m a t t e m p t s
to use a track that has been assignedan alternate, the
a l t e r n a t ei s u s e d a u t o m a t i c a l l y .
When programs encounter permanent reading or writing
errors, the system automatically halts the current operation.
The alternate track assignmentprogram can then be executed to test suspecteddefective tracks; alternateswill be
assignedas needed. Some of the data might not be recovered
when the alternate track assignmentprogram is used. lf the
data cannot be recoveredwithout an error condition, the
record or records are read under reduced hardware checking
conditions and are written on the alternate track. The
record or records that contain the error are printed in a form
that completely identifies the data written on the alternate
t r a c k s . T h i s p r i n t o u t s h o u l d b e r e t a i n e d . l t i s r e q u i r e df o r
r u n n i n g t h e a l t e r n a t et r a c k r e b u i l d p r o g r a m .

D i r e c t A c c e s sS t o r a g e

3 - 11

C Y L I N D E RO F O R M A T

followingillustrationshowsthe format of cylinder0 and
the type of informationcontainedin eachrecord:

On eachvolume.cylinder0 is reserved
for systemsupport
of the main dataarea. lt alsocontainsthe necesary
microprogramand data to performan lpL for the system.
The
Head0
IPL
s/3701

EC lwel of
IMPL codel

IPL

70r

l:i33't I ft"

I

Records 4-24 are not written. This meets
the direct accessstorage device (DASD)
label standard requirements.

Rl

System/3
IMPLcode Reserved

R2 R3

R24 R25

System/3
IMPL code

R30 R32

Reserved

R37 R38

R46

Head 1
Records 1-20 contain the same type of data on
both the 3340 and the 5ut45.

I P L NI P

CEFE dump to disk

R20 R21 R24 R25

R32 R33

CEFE
---------

CEFE/supervisor
rollout
d:FZl

Head 2

Head 3
System/37O VTOC has a 44-byte key length and a g6-byte data
length, with one entry allocating the entire data module as a
n o n e x p i r i n gd a t a f i l e . r

Remaining track area is not forrnatted

R48
Heads 5l 8

System/31OOGf
ile VTOC

System/3 lOOGfile VTOC

R40 R41
ril"

vwitten in count-kev-data
format (standarddata forrnat) readabreto System/3and system/37g. other areas
"** in
"recompressed
are written
dataformat.

3-12

Considerations
and Restrictions

I N I T I A L P R O G R A ML O A D ( I P L I

o W h e nu s i n gt h e d u m p / r e s t o rper o g r a m( $ D C O p y )t o
p r o v i d eb a c k u pf o r t h e s y s t e mp a c ka n dc y l i n d e r0 , t h e
S Y S T E MY E S p a r a m e t ei rs s p e c i f i e tdo d u m p c y l i n d e r0 .

T h e p o s i t i o no f t h e p R O G R A ML O A D S E L E C T O Rs w i t c h
d e t e r m i n ews h i c hs i m u l a t i o na r e aw i l l b e a c c e s s e d d u r i n
ag
n
l P L . A n I P L c a n b e o e r f o r m e df r o m d r i v e1 . A n I P L c a n
alsobe performedfrom drive3, providedthat drive3 is a
3344 directaccess
storage.

.

lf you specifySYSTEM-YESwhen the dump function is
p e r f o r m e dy, o u m u s ta l s os p e c i f yS Y S T E M - Y E w
Shen
the restorefunction is performed.

The systempack must occupyone of the followingsimulat i o na r e a s D
: 1 A ( F 1 )o r D 1 B( R 1 )o n d r i v e1 ; o r D 3 A ( F l )
(
R
1
)o n d r i v e3 .
or D3B
Figure3-4 showsthe relationshipbetweenthe positionof
t h e P R O G R A ML O A D S E L E C T O Rs w i t c ha n dt h e a c c e s s e d
simulation
area.
For more information about lPL, seelnitial ProgramLoad
i n P a r t2 o f t h i s m a n u a l .

D i r e c t A c c e s sS t o r a g e

3'13

o

o

o

+
a

O
s

q
f

o

o

o

O

o

a

ct

o
LIJ
$

s

o o

N
s

o

.
l

g
o

tL
$

co
s

o

(9
<

o

f

(9
sl

.-c
o

=

o

o
o

o

o

o

rir
v

$

o
+ . 9
s
l
e
o

s?
I
\t

o
s
o

Y

l

)

uJ

o

>

+--

A
Y

N .
( 9

o

o o
o
r--------.1

g
o

i

LL
cr) C',

o o

cf,
cf,

o

.g
o

v

ct
o

o

o

o

sf
sl
CV)

s?

G

:,,

s
o

st
c

o

9

.E
G

o
o o
I

ct
o

'o

I
I
I
I
I

|

I
!

sr
o
N

c
\

G

o

c

d
N

C\

U
N

c o

.=
o

I
I
I
I

A
E
C'

Y

o

I
o

q)

cl

o

v(V)
(r,

o
'.o

o

c o
C C

o

.=
o

_ii

uJ
F

z
E

C)

=
-(J
F

=
(n
o
o
J

E

IJJ

F
J

tr

o-

Figure 34,

3-14

Main Data Area and Associated Simulation Areas

E
i

ES
€
T
o
o

o

Ei

H
3

so ; 3

E
-

A

o
c
o

o

A

L

6

a

q

c
o

x
U
-

:

E
8.9q
' 6 i 'E
s
E
)

Y

t

s

>

F : nb t
8EFEE

o o

Part4. SystemServicePrograms

Part 4. System Service Programs

4-1

Introduction

) c l u d ea
T h e M o d e l1 5 S C P( 5 7 0 4 - S C 2i n
s g r o u po f d i s k residentsystemserviceprograms.Theseprogramsdo a
varietyof jobs,from preparingdisksand tapesto maintaini n gt h e s y s t e ml i b r a r i e sT
. h e f o l l o w i n gi s a l i s t o f t h e s y s t e m
programs
service
in this sectionand their
discussed
function(s):
Program

Name

ProgramFunction

Alternate
Track

$ALT

Assignsan alternate track in
place of a defective track and
prints the data content of the
a r e aI n e r r o r .

Assignment

Alternate
Track
Rebuild

$ B UI L D

Corrects data on the assioned
alternate track.

Configuration Record

$ C N FI G

C h a n g e sc e r t a i n i n f o r m a t i o n i n
the configuration record.

coqv I
Dump

$COPY

C o p i e sa f i l e , a n e n t i r e m a i n
d a t a a r e a ,o r a n e n t i r e s i m u l a tion area.

Dump/
Restore

$DCOPY

Providesbackup for a main
d a t a a r e ao r s i m u l a t i o n a r e ao n
m a g n e t i ct a p e , o r a s i m u l a t i o n
area on diskette.

Fi l e

$DELET

Name

ProgramFunction

Chain
Cleaning

$KLEAN

Exercises
the IBM 1403 Printer
purpose
for the
of cleaningthe
p r i n t c h a i n( t r a i n ) .

F i l ea n d
Volume
Label
Display

$LABEL

Printsthe informationfrom
V T O C p e r t a i n i n tgo a s i n g l ef i l e
or to allf iles.

Library
$MAINT
Maintenance

$FCOMP

SOCOPY C o p i e sa n e n t i r es p o o lf i l e ;
c o p i e sa l l o r p a r t o f a s p o o l
p r i n t ,s p o o lp u n c h ,o r s p o o l
readerqueue;copiesto the
spoolreader,spoolprint, or
spoolpunchqueue;copiesthe
statusof the spoolfile queues.

Recover
lndex

$ RI N D X

Sortsthe file index and updates
the VTOC entry of an indexed
file to reflectaddedrecordsin
c a s eo f a b n o r m atle r m i n a t i o n .

Reassign
Alternate
Track

$RSALT

the alternatetrack
Relocates
areaon a 3340 datamoduleso
that the datamodulecan be
usedon a System/360or
System/370.

Simulation
Area

$SCOPY

Supportsthe simulationareas
of a 3340 or 3344 volume.

Deletestemporary or permanent

System
History
Area
Display

$HIST

Disk
In it i a li z a t o
i n

$ I NI T

Movesfilesfor the purposeof
removinggapsbetweenfiles.
T h i s p r o g r a ma l s oc o p i e sa l l
f i l e sf r o m a m a i nd a t aa r e a .

Tape
$TINIT
Initialization

Createsor deletesstandardtape
v o l u m el a b e l sc, h e c k sf o r u n sxiste x p i r e df i l e s .a n d d i s p l a y e
i n gv o l u m ea n dd a t af i l e l a b e l s .

Tape
Error
Summary

$TVES

Printstapeerror statisticsthat
during
havebeenaccumulated
processing.

VTOC
Service

$WVTOC Removesthe gapsbetween

D i s p l a y tsh e c o n t e n t so f t h e
systemhistoryarea.

Performssurfaceanalysison
disksand formatsdisksaccording to disk systemmanagement
requirements.

, ainA l l o w sy o u t o p r o d u c em
libraries.
t a i n ,a n ds e r v i c e

S p o o lF i l e
copy

data fi les.

Delete
File
Compress

Program

entriesin a VTOC.

f ntroduction

4-3

T h e i n f o r m a t i o nf o r m o s tp r o g r a m iss d i v i d e di n t o s i x
sections:
.

C O N T R O LS T A T E M E N T S
A l l s y s t e ms e r v i c e
p r o g r a mes x c e p t$ T V E S ,$ R l N D X , a n d
$KLEAN requirethat you supplycontrol statemenrs.
Thesestatements
givethe programinformationconcerning
the output you want the programto produceor the way in
which you want the programto performits function. The
programsreadthesestatements
from the systeminput
device.They must be the first input readby the program.

Programdescription

a Controlstatementsummary
O Parameter
summary
o Parameter
descriptions

PROGRAMMING
CONSIDERATIONS

Everycontrol statementis madeup of an identifier and
parameters.The identifier is a word that identifiesthe
controlstatement.lt is alwaysthe f irst word of the state_
m e n t . P a r a m e t ea
r sr ei n f o r m a t i o ny o u a r es u p p l y i n gt o t h e
program. Everyparameterconsistsof a keyword,which
identifiesthe parameter,followed by the informationyou
a r es u p p l y i n g .

F o r i n f o r m a t i o na n d r e f e r e n c et h, e f o l l o w i n gi s a l i s t o f S C p
s y s t e ms e r v i c e
p r o g r a m as n dt h e m i n i m u mp a r t i t i o ns i z e s
required for execution:

W R I T I N GC O N T R O LS T A T E M E N T SF O R S Y S T E M
S E R V I C EP R O G R A M S

o O C L ( o p e r a t i o cno n t r o ll a n g u a g ec)o n s i d e r a t i o n s
o Examplds

$$RSTR
$ALT
$ B UI L D
$CNFIG
$COPY
$DCOPY
$ D EL E T
$FCOMP
$ HI S T
$ I NI T
$KLEAN
$LABEL

$MAINT
$MPXDV
$OLINK
$OCOPY
$RINDX
$RSALT
$SCOPY
$TINIT
$TVES
$WVTOC

CheckpointRestart
AlternateTrack Assignment
A l t e r n a t eT r a c k R e b u i l d
C o n f i g u r a t i oR
n ecord
Copy/Dump
Dump/Restore
F i l eD e l e t e
F i l eC o m p r e s s
S y s t e mH i s t o r yA r e aD i s p l a y
D i s kl n i t i a l i z a t i o n
C h a i nC l e a n i n g
F i l ea n d V o l u m eL a b e lD i s p l a y
S i m u l a t i o na r e aV T O C
1 0 0 0 - f i l eV T O C
1 - 10 0 0 e n t r i e su n s o r t e d
1 - 3 0 0e n t r i e ss o r t e o
3O1-500entriessorted
501-700entriessorted
7 0 1 - 9 0 0e n t r i e ss o r t e o
901-1000 entriessorted
L i b r a r yM a i n t e n a n c e
MacroProcessor
O v e r l a yL i n k a g eE d i t o r
S p o o lF i l eC o p y
R e c o v eIrn d e x
Reassign
AlternateTrack
S i m u l a t i o nA r e a
T a p eI n i t i a l i z a t i o n
T a p eE r r o rS u m m a r y
VTOC Service

8K
8K
8K
8K
10K
8K
8K
10K
8K
8K
8K

8K
10K
10K
12K
14K
16K
18K
10K
12K
10K
10K
10K
8K
10K
8K
8K
8K

To write control statements,
usethe sectionsin the followi n gw a y s :
'1
.

Look at the Control StatementSummary to determine
which control statementsand parameters
apply to the
programfunctionsyou are interestedin. (Theprogram
function(s)is statedin the text precedingthe Control
StatementSummary.l

2.

lf you needinformationabout the contenrsor meaningsof particuiarparameters,
look at theparameter
Summary.

3.

l f y o u n e e dm o r ed e t a i l e di n f o r m a t i o na b o u tp a r a m eters,read the ParameterDercriptionsfollowing the
ParameterSummary.

4.

l f y o u n e e de x a m p l e os f s p e c i f i cj o b s ,l o o k a t t h e
Examplesection.All examplesshowthe OCL statementsand control statements
for specific jobs.

5.

To find informationconcerningthe useof the system
serviceprograms,refer to OCL Considerations
for the
necessary
OCL statements.

CodingRules

END Control Statement

The rulesfor codingcontrol statements
areasfollows:

The END statementis a specialcontrol statementthat indicatesthe end of control statements.lt consistsof // END
startingin position 1 and must alwaysbe the lastcontrol
statementfor the programs.

1.

Statementidentifier. // followed by a blank should
precedethe statementidentifier. Do not useblanks
w i t h i n t h e i d e n t i ife r .

2.

Blanks. Useone or more blanksbetweenthe identifier
and the first parameter.Do not usethem anywhere
elsein the statement.
StatementParameters.Parameters
can be in any
order. Usea commato separate
one parameterfrom
another. Usea hyphen(-) within eachparameterto
separate
the keywordfrom the informationyou
s u p p l y . D o n o t u s eb l a n k sw i t h i n o r b e t w e e n
parameters.

3.

Statementparameterscontaining a list of data after
(') to enclosethe
the keyword. Useapostrophes
itemsin the list. Usea commato seoarate
one item
f r o m a n o t h e r .E x a m p l e :U N I T - ' R 1 , R 2( R
' 1 a n dR 2
a r et h e i t e m si n t h e l i s t ) .

4.

5.

Statementlength. No control statements,except for
s o m ed i s k i n i t i a l i z a t i o nl i,b r a r ym a i n t e n a n c e
a ,n d
spoolfile copy statements
may exceed80 to 96
characters.The followinglibrarymaintenance
statementscan be continuedon anotherstatement(see
Continuation underCoding Rules in Part 1 of this
manual):
// ALLOCATE
or COPYstatements
ll COPY(not ENTRY statements
r e a df r o m a f i l e )
// DELETE
, E P L A C Eo, r I N S E R T
/ / M O D I F Y( n o t R E M O V E R
statements
)
// RENAME
T h e d i s k i n i t i a l i z a t i osnt a t e m e n/t/ V O L a n d t h e s p o o l
f i l e c o p y s t a t e m e n t/s/ C O P Y R D R O/,/ C O P Y P R T O ,
/ / C O P Y P C H O/ /, C H A I N ,/ / R E S T O R E , I IC O P Y O ,
a n d / / D I S P L A Yc a na l s ob e c o n t i n u e d .

The followingis an exampleof a control statement:

Placementof Control Statementsin the Job Strearn
Controlstatementsfor systemserviceprogramsmust follow
t h e R U N s t a t e m e n tT
. h e f o l l o w i n ge x a m p l es h o w st h e u s e
and placementof control statements.

ocL
I t t u o a o$ c o P Y , F l
statements
I ll nUU
// COPYPACK
1 ControlStatements
F R O M - F 1 , T O - R| 1 f o r t h e $ C O P Y
ptogt.t
!
// END

SpecialMeaningof GapitalLetters,Numbers,and Special
Characters
C a p i t a l i z ewd o r d sa n d l e t t e r sn, u m b e r sa, n ds p e c i acl h a r a c '
tershavespecialmeaningsin control statementdescriptions.
capitalizedwordsand lettersmust be
In control statements,
written asthey appearin the statementdescription.Somet i m e sn u m b e r sa p p e a w
r i t h t h e c a p i t a l i z eidn f o r m a t i o n .
Thesenumbersmust alsobe written asshown.
Wordsor lettersthat are not capitalizedmeanyou must use
a v a l u et h a t a p p l i e st o t h e i o b y o u a r ed o i n g . T h e v a l u e s
for
that can be usedare listedin the parametersummaries
the control statements.
Braces{ } and brackets[ ] sometimesappearin parameters
s h o w ni n s t a t e m e nst u m m a r i easn do a r a m e t esru m m a r i e s .
they simply indicatea
They are not part of the parameter;
choiceof vatuesto completethe parameter.You rnust
chooseone of the valuessurroundedby braces;you may
choosea parametersurroundedby bracketsor omit that
p a r a m e t eern t i r e l y . U n d e r s c o r i nogf o n ev a l u ee n c l o s e b
dy
you
keyword
of
lf
specify
the
bracesindicatesthe default.
a parameter,you must completethe parameterby supplying the codeor dataeventhougha defaultis indicated.

E . S Y S T E M , T O 1. R
/ / C O P YF R O M . F1 ,L I BR A R Y - O , N A M
The statementidentifier is COPY. The parameterkeywords
a r eF R O M ,L I B R A R Y ,N A M E ,a n dT O . T h e i n f o r m a t i o n
y o u s u p p l yi s F 1 , O , S Y S T E Ma, n d R 1 .

fntroduction

4-5

Forexample:

D E V I C EC O D E S

(eo.ll
^. f--^,
HhuLmeansthat if you do not specifythis
-I

1gO
| |
'- /J

parameter,
the systemwill select
RECL-96. lf you specifythe keyword
RECL,you must alsosupplyone of the
v a l u e s( 8 0 o r 9 6 ) .

(T)

o RETAIN-{
m e a n st h a t y o u m u s ts p e c i f ye i t h e r
' O /I
R E T A I N - To r R E T A T N - p .
o [ , B L K L - b l o c kl e n g t h ] m e a n st h a t t h e b l o c kl e n g t h
parametermay be omitted
entirely.

Systemserviceprogramsuseparameters
that requirea code
to indicatethe unit beingreferenced.A unit codecan refer
to a main dataarea.simulationarea,tapedrive,or other
device.dependingon the function beingperformed.
Figure4-1 showsthe codesusedfor the main dataareasand
simulationareas.The simulationareacodesareusedin the
ASSIGNstatement,configurationrecordprogram($CNFlG),
a n d i n t h e s i m u l a t i o na r e ap r o g r a m( $ S C O P Y ) .I n a l l o t h e r
programs,
a 5/'44 unit code (F 1, R1, F2. R2l is usedinstead
of the simulationareacode. Beforeusingthesecodes,you
shouldbe familiarwith the format of eachvolumeand the
assignment
of the codesasdescribedin Part3 of this manual,
Disk Drive
Main Data
Type and
Area Codes
Designation

SimulationArea
Codes

3340 drive 1
3340 drive2
3340 drive3
3340 drive4

D1
D2
D3 or D31
D4 or D41

D 1 A ,D 1 B ,D 1 C ,D l D
D2A,D2B,D2C,D2D
D 3 E ,D 3 A
D 4 E ,D 4 A

3344 drive3
V o l u m e1
V o l u m e2
V o l u m e3
V o l u m e4

D3 or D31
D32
D33
D34

D 3 E .D 3 A
D 3 F ,D 3 B
D3G. D3C
D 3 H ,D 3 D

3344 drive4
Volume 1
V o l u m e2
Volume3
V o l u m e4

D4 or D41
D42
D43
D44

D 4 E .D 4 A
D 4 F ,D 4 B
D 4 G ,D 4 C
D 4 H ,D 4 D

Figure 4-1. Main Data Aroa and Simulation Area Codes

4€

AlternateTrack AssignmentProgram-$AlT
P R O G R A MD E S C R I P T I O N
The alternatetrack assignment
programhasthe following
f un c t i o n :
Assignalternatetracksto disk tracksthat become
defectiveafter they are initialized.
Whenthe programassigns
an alternate,it transfersthe
contentsof the defectivetrack to the alternate.Alternate
trackscan replaceany primarytracksexceptcylinder0,
h e a d0 , o n D 1 . D 2 , D 3 o r D 3 1 , D 4 o r D 4 l . T h e c y l i n d e r0 ,
head0, track is reserved
for systemuse.

CONTROLSTATEMENTSUMMARY
The control statements
you must supplydependon the
desiredresults.

Control StatementsO
C o n d i t i o n aAl s s i g n m e n t
U n c o n d i t i o n aAl s s i g n m e n t

@

//
//
II
//

A L T \ 9 P A C K - n a m e , U N l T - c o d e , VFEYR-ln u m b e r
E N D^
ALTU) PACK-name,UN
lT-code,VERI FY-number,ASSl
GN-track
END

f o r e a c hu s e ,t h e p r o g r a mr e q u i r e tsh e s t a t e m e n tisn t h e o r d e rt h e y a r el i s t e d : A L T , E N D .

@ tr.ru can be ten ALT statementsper job,

A f t e r n a t e T r a c k A s s i g n m e n tP r o g r a m - $ A L T

4-7

P A R A M E T E RS U M M A R Y
Parameter

Description

PACK-name

Nameof the main data area.

U Nl T - c o d e

L o c a t i o n o f t h e d i s k . P o s s i b l ec o d e sa r e t h o s e f o r t h e m a i n d a t a
areas.

VERIFY-number

I n t e s t i n gt h e c o n d i t i o n o f a t r a c k , d o s u r f a c ea n a r y s i st h e n u m b e r
of times
i n d i c a t e d( n u m b e r c a n b e 1 - 2 5 5 ) . l f V E R I F y p a r a m e t e ri s
omitted. do
s u r f a c ea n a l y s i si 6 t i m e s . T h e V E R I F y p a r a m e t e ra p p l i e so n l y
to tracks
in the suspecteddefective track list.

ASSIGN-track

T h e s p e c i f i e dt r a c k i s u n c o n d i t i o n a l l ya s s i g n e da n a l t e r n a t e .
onry one track
c a n b e a s s i g n e df o r e a c h A L T s t a t e m e n t . V a l i d t r a c k n u m b e r s
are: 1-41g7
f o r e a c h v o l u m e o n a 3 3 4 0 ; 1 - 4 1 9 9f o r v o r u m e sD 3 o r D 3 1
and D4 or D41
o n a 3 3 4 4 ; 0 - 4 1 9 9 f o r v o l u m e sD 3 2 , D 3 3 , D 3 4 , D 4 2 , D 4 3 , D 4 4
on a 3344.

P A R A M E T E RD E S C RI P T I O N S
PACK Parameter
The PACK parameter(PACK-name)
tellsthe programthe
nameof the areato be processed.This is the volumelabel
written by the disk initializationprogram. (SeeDr.sk
In i tial i zation Program.l
The alternatetrack assignment
programcomparesthe name
in the PACK parameterwith the volumelabelto ensure
that they match.

UNIT Parameter
The UNIT parameter(UNIT-code)indicatesthe locationof
the area'containing
suspected
defectivetracks. Codesfor
the possiblelocationsarethosefor the main daraareas.

VERIFY Parameter
T h e V E R I F Y p a r a m e t e(rV E R l F y - n u m b e re) n a b l eyso u t o
indicatethe numberof timesyou want the programto do
surfaceanalysisbeforejudgingwhetheror not the track is
defective.The numbercan be from 1 to 255. lf you omit
the parameter,
the programdoessurfaceanalysis16 times.
This parameterappliesonly to tracksin the suspected
defectivetrack list.

ASSIGNParameter
T h e A S S I G Np a r a m e t e(rA S S I G N - t r a c kp)r o v i d e u
snconditional assignment
of the specifiedtrack to the next availablealternatetrack.
You can assignalternatesfor all tracksexcept0 whenthe
v o l u m ei s o n a 3 3 4 0 l D 1 , D 2 ,D 3 o r D 3 1 ,D 4 o r D 4 1 ) .
V a l i dt r a c kn u m b e r sa r e 1 t h r o u g h4 1 8 7 .
You can assignalternatesfor all tracksexcept0 on volumes
D 3 o r D 3 1 a n d D 4 o r D 4 1 o n a 3 3 4 4 . V a l i dt r a c kn u m b e r s
a r e 1 t h r o u g h4 1 9 9 .
You can assignalternates
for all trackson volumesD32,
D33, D42, D43, and D44. Valid track numbersare0
t h r o u g h4 1 9 9 .
You can assignan alternatefor only one track for eacn
ALT statementyou supply.

U N C O N D I TO
I NAL ASSIGNMENT
U n c o n d i t i o n aals s i g n m e n
a tp p l i e st o t r a c k st h a t o c c a s i o n a l l y
causereador write errors. Suchtracksmight not cause
program
errorswhen testedby the alternatetrack assignment
( $ A L T ) d u r i n gc o n d i t i o n aal s s i g n m e n tl f. t h e y d o n o t , t h e
programwill not assignalternatetracksto them. lf you
still want to assignalternates
to thesetracks,useuncondit i o n a la s s i g n m e n tI .n d o i n gu n c o n d i t i o n aals s i g n m e nt th,e
programassigns
an alternatewithout f irst testingthe condition of the track(s)suspected
of beingdefective.
After a track hasan assigned
alternate,the only way to
retestthe track is to executethe disk initializationprogram
( $ l N l T ) w i t h p a r a m e t e rTsY P E - F O R C E
andERASE-YES.

Surface Analysis: Surface analysis is a procedure the
program usesto test the conditon of tracks. lt consistsof
writing test data on a track, then reading the data to ensure
that it was written properly.
Before doing surface analysis,the alternate track assignment
program transfers any data from the track to an alternate
track. This alternate is assignedif the track proves to be
defective.
ln judging whether or not the track is defective, the program
does surface analysisthe number of times you specify in the
V E R I F Y p a r a m e t e r . l f y o u o m i t t h e p a r a m e t e r ,t h e p r o g r a m d o e s s u r f a c ea n a l y s i s1 6 t i m e s . l f t h e t r a c k c a u s e s
r e a d i n go r w r i t i n g e r r o r sa n y t i m e d u r i n g s u r f a c ea n a l y s i s ,
the program considersthe track defective.

C O ND I T I O N A LA S SI G N M E N T
Conditionalassignment
consistsof testingthe conditionof a
track (surfaceanalysis)
and, if the track is defective.assigning an alternatetrack to replaceit.

Assignment of Alternate Tracks: lf a track proves to be
defective, the program assignsan alternate track. The
alternate becomes,in effect, a substitute for the defective
track. Any time a program attempts to use the defective
track. it automatically usesthe alternate instead.

Situation: Conditionalassignment
appliesto tracksthat
c a u s er e a d i n go r w r i t i n ge r r o r sd u r i n ga j o b . A n y t i m e a
trackcauses
sucherrors,the systemdoesthe following:

simulation
E a c hv o l u m e ( a m a i n d a t a a r e a a n d i t s a s s o c i a t e d
areas)has 40 alternate tracks. The program does not do
c o n d i t i o n a la s s i g n m e n itf a l l a l t e r n a t et r a c k s a r e i n u s e .

1.

Stops the program currently in operation

2.

Writes the track addressin the main data area defective track table

3.

H a l t sw i t h a h a l tc o d ei n d i c a t i n g
a p e r m a n e ndt i s k l / O
error

program.
You can then run the alternatetrack assignment
programto do
Whenyou usethe alternatetrack assignment
conditionalassignment,
the programlocatesthe tracksby
from the defectivetrack table. The
usingthe addresses
p r o g r a mw i l l d o c o n d i t i o n aal s s i g n m e n
f ot r a l l i d e n t iife d
tracks(oneat a time) aslong astherearealternatetracks
a v alia b l ef o r a s s i g n m e n t .

//ote: $ALT does not processsuspecteddefective tracks in
any area that is currently being used. /\ messageis used if
suspecteddefective tracks are not processed.

lncorrect Data: lf a track is defective, some of the data
transferredto the alternate track could be incorrect.
Therefore. when reading data from the defective track, the
program prints all track recordscontaining data that caused
r e a d i n ge r r o r s . C h a r a c t e r st h a t h a v e n o p r i n t s y m b o l a r e
printed as two-digit hexadecimal numbers.
The following is an example:
ABCDE GH123 56. ..
B
A
6
4
Appendix A lists the charactersin the standard character
set and their correspondinghexadecimal numbers.
To correct errors on the alternate track, use the alternate
track rebuild program.

A l t e r n a t e T r a c k A s s i g n m e n tP r o g r a m - $ A L T

4-9

OCLCONSIDERATIONS
The followingOCL statements
areneededto load the
alternatetrack assignment
program:
ll LOAD $ALT,code
// RUN
Explanation:
T h e c o d ey o u s u p p l yd e p e n d os n t h e l o c a t i o no f t h e s i m u l a tion areacontainingthe alternatetrack assignment
program.
Possible
codesare R1, F 1, R2 andF2.

EXAMPLES
ConditionalAssignment
Figures4-2 and4-3 areexamplesof the OCL starements
and control statements
neededfor a conditionalassignment
a sd e s c r i b eidn t h e f o l l o w i n gs i t u a t i o n .

o T h e n a m eo f t h e d i s k( B I L L N G ) a n di t s l o c a t i o n( m a i n
dataareaon drive2) are indicatedby the PACK and
s the ALT statement.
U N I T p a r a m e t e ri n
o B e c a u steh e V E R I F Y p a r a m e t ewr a so m i t t e df r o m t h e
ALT statement,the programdoessurfaceanalysis16
timeswhen it teststhe conditionof suspected
defective
tracks.
Figure 4-3, Control Statemonts for a Conditional Assignment

UnconditionalAssignment
Situation
The systemcancelsa job if a defectivetrack is found on the
m a i nd a t aa r e ao n d r i v e2 . ( T h en a m eo f t h e d i s k i s
B I L L N G . ) B e f o r ed o i n gm o r ej o b s ,t h e o p e r a t o w
r a n t st o
usethe alternatetrack assignment
programto checkthe
conditionof the track and assignan alternateto the track
if it is defective.

Figure4-4 is an exampleof the OCL statements
and control
s t a t e m e n tnse e d e df o r a n u n c o n d i t i o n aals s i g n m e n t .

Explanation:
Explanation:
Alternatetrack assignment
programis loadedfrom the Fl.
Figure 4-2. OCL Load Sequence for Alternate Track Assignment

o T h e n a m eo f t h e d i s k ( B I L L N G )a n d i t s l o c a t i o n( m a i n
dataareaon drive2) are indicatedby the PACK and
UN lT parameters
in the ALT statement.
.

Because
of the ASSIGNparameter,the programassigns
track number4120 an alternatewithout testingits
condition.

Figure 4-4. OCL and Control Statements for an Unconditional
Assignment

4-10

F O R A L T E R N A T ET R A C K A S S I G N M E N T
MESSAGES
Message

Meaning

A L T E R N A T ET R A C K
ASSIGNED

is printedwhen an
This message
hasbeenassigned
track
alternate
and the data
track
to a defective
hasbeentransferredto the
alternatetrack.

is printedwhen the
This message
P R I M A R YT R A C K
program
that a
determines
H A SB E E NT E S T E DO K
primary
is
not
defective.
track
T R A C Kx x x x , U N l T - z z z
primary
track
is
the
xxxx
numberandzzz is the volume
involved.
**RECORD
WITH
DATAERROR**

is printedwhen the
This message
alternatetrack assignment
Pro'
gramfound an error when transferringdata. The recordthat has
the error is printedout.

is printedafter
This message
P R I M A R YT R A C K
A
L
T
E
R
N
A
T
ET R A C K
xxxx ALTERNATE
T R A C K y y y y , U N l T - z z z A S S I G N E D .x x x x i s t h e
p r i m a r yt r a c kn u m b e r Y
, Y Y Yi s
the alternatetrack number,and
zzz is the volumeinvolved.

Afternate Track Assignment Program-$ALT

4-11

AlternateTrack RebuildProgram-$BulLD
P R O G R A MD E S C R I P T I O N
The alternatetrack rebuildprogramhasthe following
function:
Enableyou to correctdatathat could not be transferred
correctlyto an alternatetrack.
One or more alternatetrackscan be correctedby the
systemduringone executionof this program.You must
supplythe datato correctthe errors.
To write control statements
for this program.you needthe
informationprinted by the alternatetrack assignment
programwhen it assigned
the alternatetrack. The printedinformationtellsyou the nameof the areaand numbersof
the track and recordssuspected
of containingincorrect
data. lt alsoincludesthe datafrom theserecordsthat you
can useto locateincorrectdata. Fixed recordrefersto a
physical256-byterecord.

CONTROLSTATEMENTSUMMARY
you must supplydependon the
The control statements
desiredresults.

Function

Control Statementsand Substitute Data

To repfacecharacters1-12and75-78ot a sector,you can
useeitherof the following:

lT-code,TRACK// REBUILD PACK-name,UN
location,LENGTH-number,D
I SP-position

Useone R EBUILD statementand replaceall the
characters
specifyinga LENGTH parameterof 78.
Useone REBUILD statementfor everysetof positions you correct.
The datayou want to substitutemust follow the REBUILD
statementsto which it applies. The order of the control
statements
and datain the preceding
examplewould be:
/ / R E B U I L Ds t a t e m e n t
data
// END
// REBUILD statement
data
// REBUILD statement
data
// END

4-12

for positions1-78

for positions1-12
for positions75-78

Substitutedata

// END

PARAMETERAND SUBSTITUTEDATA SUMMARY
REBUILD Statement
Parameter

Description

PACK-name

Nameof the area.

UNIT-code

codesarethosefor the main dataareas.
Locationof the disk. Possible

TRACK-location

Numberof track and fixed recordcontainingincorrectdata- Numberis
program.Track numbermust be
printedby alternatetrack assignment
number
must
be two digits. (TRACK-011109
four digits;fixed record
r
e
c
o
r
d
9
.
)
m e a n st r a c k 1 1 1 ,f i x e d

LENGTH-number

Number of charactersbeing replaced. Number can be 2'256 and must be
a m u ft i p l eo f 2 1 2 , 4 ,6 , e t c ) .

DISP-position

Positionof the first characterbeingreplacedin the record. Positioncan be
1-255.

form.
SubstituteData: Codeeachcharacterin hexadecimal
Followeverysecondcharacter.exceptthe last,with a
comma. Example: The numbers123456would be coded
a sF 1 F 2 , F 3 F 4 , F 5 F 6(.A p p e n d i xA l i s t st h e h e x a d e c i m a l
codesfor System/3characters.)

Alternate Track Rebuild Program--$BUILD

4-13

P A R A M E T E RA N D S U B S T I T U T ED A T A D E S C R I P T I O N S
PAGK Parameter
The PACK parameter(pACK-name)tellsthe programthe
nameof the areathat containsthe alternatetrack being
corrected.This is the volumelabelwritten by the disk
i n i t i ailz a t i o np r o g r a m .
The alternatetrack rebuildprogramcomparesthe namein
the PACK parameterwith the volumelabelto seeif they
match.

Length applies to charactersthat occupy consecutiveposi_
tions in the fixed record. lf the charactersyou want to
replacedo not occupy consecutivepositions, you must
e i t h e r r e p l a c ea l l i n t e r v e n i n gc h a r a c t e r so r u s e m o r e t h a n
o n e R E B U I L D s t a t e m e n t . F o r e x a m p l e ,t o r e p l a c ec h a r a c ters 10-11 and24-25 in a fixed record, you can do either of
the following:
o

U s e o n e R E B U I L D s t a t e m e n tt o r e p l a c ec h a r a c t e r s
1 0 - 2 5{ L E N G T H - 1 6 ) .

o

Use two REBUILD statementsto replacecharacrers
1 0 - 1 1( L E N G T H . 2 )a n d 2 4 . 2 5 ( L E N G T H - 2 ) .

UNIT Parameter
DISP (Displacement)Parameter

T h e U N I T p a r a m e t e(rU N I T - c o d ei)n d i c a t etsh e t o c a t i o no f
the areathat containsthe alternatetrack beingcorrected.
Possible
codesarethosefor the maindata areas.

TRACK Parameter
T h e T R A C K p a r a m e t e(rT R A C K - l o c a t i o ni d) e n t i f i e tsh e
track and recordcontainingthe databeingcorrected.The
defectivetrack, not the alternatetrack, is the one you refer
to. Referencing
the defectivetrack is the sameas referenc_
ing the alternatetrack.

T h e D I S P p a r a m e t e r( D | S P - p o s i t i o n )i n d i c a t e st h e p o s i t i o n
of the first character being replaced in the fixed record.
T h e p o s i t i o n o f t h e f i r s t c h a r a c t e ri s 1 ; t h e p o s i t i o n o f t h e
s e c o n dc h a r a c t e ri s 2 . a n d s o o n . T h e m a x i m u m p o s i t i o n
you can specify is 255.
B e g i n n i n ga t t h e p o s i t i o n y o u i n d i c a t e ,t h e a l t e r n a t et r a c k
rebuild program replacesthe number of charactersVou
i n d i c a t ei n t h e L E N G T H p a r a m e t e r .

Substitute Data

F o r t h e m a i nd a t aa r e a t, h e p o s s i b l ter a c kn u m b e r sa r e
0001-4184A
. l w a y su s ef o u r d i g i t s .T h e p o s s i b l fei x e d
recordnumbersare01-48. Alwaysusetwo digits. The
track numbermust precedethe fixed recordnumber. For
e x a m p l et h
, e p a r a m e t eTrR A C K - 1 1 1 0 1m
9 e a n st r a c k1 1 1 0 .
r e c o r d1 9 .

A f t e r e a c h R E B U I L D s t a t e m e n t ,y o u m u s t c o d e t h e s u b stitute charactersthat apply to that statement. The characters must be in hexadecimal form. Appendix A shows the
hexadecimalcodes for the System/3 character ser.

Trackand recordnumbersareprinted by the alternate
track assignment
programwhen it printsdatafrom records
'
that containincorrectdata.

Include a comma after every second character. For
e x a m p l e ,t h e d a t a F 1 F 2 , F 3 F 4 , F 5 F 6 r e p r e s e n t s1 2 3 4 5 6 .
F l i s t h e h e x a d e c i m a fl o r m o f 1 ; F 2 i s t h e h e x a c l e c i m a l
form of 2, and so on.

LENGTH Parameter

C o d e o n l y t h e n u m b e r o f c h a r a c t e r sy o u i n d i c a t e i n t h e
L E N G T H p a r a m e t e ri n t h e R E B U I L D s t a t e m e n t .

T h e L E N G T Hp a r a m e t e(rL E N G T H - n u m b etre) l l st h e p r o gramhow many characters
you are replacingin the f ixed
r e c o r d .Y o u m u s tr e p l a c e
c h a r a c t e ri sn m u l t i p l e so f 2 ( 2 , 4 ,
6 , a n ds o o n ) . T h e m a x i m u mi s 2 5 6 ,w h i c h i s t h e c a p a c i t y
of a fixed record.

N o t e : l t t h e L E N G T H p a r a m e t e ro f t h e R E B U I L D s t a t e ment exceeds38, at least two substitute data statements
are required. Each substitute data statement, except the
l a s to n e , m u s t b e c o m p l e t e l y f i l l e d w i t h d a t a a n d m u s t h a v e
a comma in column 95 and a blank in column 96. For an
8 0 c o l u m n i n p u t d e v i c e ,i t i s p o s s i b l et o h a v e o n r y o n e
substitute data statemenr.

4-14

O C LC O N S I D E R A T I O N S

EXAMPLES

The followingOCL statements
areneededto loadthe
alternatetrack rebuildprogram.

CorrectingCharacterson an AlternateTrack

// LOAD$BUlLD.code
// RUN

Figures4-5 and 4-6 areexamplesof the OCL and control
on an alternate
neededfor correctingcharacters
statements
track.

The codeyou supplydependson the locationof the simulation areacontainingthe alternatetrack rebuildprogram.
P o s s i b lceo d e sa r e R 1 , F 1 , R 2 , F 2 .

Explanation:
Alternatetrack rebuildprogramis loadedfrom F1.
Figure 4-5. OCL Load Sequence for Alternate Track Rebuild

Alternate Track Rebuild Program-$BUILD

4 - 15

Situation
Assumethat the alternatetrack assignment
program($ALT)
p r i n t e dt h e f o l l o w i n gi n f o r m a t i o :n
, I . , I R E C O RID
.ITH DATA ERROR*i.
TRACK 1,.......1,0..
20........30.
.40........50.
.60........70.
.80......88
020001,
000000000000000011,111,1i.1'1'L1'1'1'L1,1'2222222222222222?333333333333333
444444+444444445s555555
0123456789ABCDEF0l,23456789ABCDEFO723456789ABCDEFO123456789ABCDEF
L234561BgABCDEF01,234567
5 5 5 5 5 5 5 5 6 6 6 6 6 6 6 6 6 6 6 6 6 66 6 1 1 7 1 7 7 7 7 1 1 7 1 1 1 1 1 8 8
I 8 8 8 8 8 I I 8 8 8 S 8 8 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 A A A A A A A A A A A AA A A A
89ABCDEF0123456789A3CDEFOL23456189ABCDEFOl,23456789ABCDE
F 0 1 , 2 3 4 5 6 7 8 9 A B C D E F O 1 2 3 4 5 6 7 8-9 A 3 C D E F

BBBBBBBBBBBIIIIISo"ottt*taa...arJKLMNoPQRDDooorrrtt'u"ttrrrurrotzl+sltas,r,
OL23456189ABCDEFO
ABCDEFO

It meansthat errorsweredetectedin record1 of track 200.
( A s s u m teh e n a m eo f t h e a r e ai s B I L L N G . )
ln checkingthe characters
printedby the alternatetrack
assignment
program.you found that the characters
in
positions120-123in the recordare incorrect.and you want
the operatorto run the alternatetrack rebuildprogramro
correctthem.

Explanation:
r

T h e n a m eo f t h e m a i nd a t aa r e a( B I L L N G )a n d i t s l o c a _
t i o n ( d r i v e2 ) a r ei n d i c a t e di n t h e p A C K a n d U N I T
p a r a m e t e ri n
s t h e R E B U I L Ds t a t e m e n t .

o The recordcontainingthe incorrectcharacters
is record1
of the alternatetrack assigned
to track 200 (TRACK_
020001). The characterin position,|20 is the first
c h a r a c t ebr e i n gr e p l a c e d
( D l s p - 12 0 ) .
.

The characters
in positionsI 20 through123 in record1
a r eb e i n gr e p l a c e d
(LENGTH-4).

r

T h e s u b s t i t u t ceh a r a c t e rf so l l o w t h e R E B U I L Ds t a t e m e n t . T h e ya r eG ( C 7 ) ,H ( C 8 ) ,t ( C 9 ) ,a n d | ( F 1 ) .

Figure 4-6. Control Statements for Correcting Charactars on an
Alternat6 Track

4-16

ABCDEFO],

ABCDEF

ABCDEF

"'

Pageot GC21-5162'1
1979
lssued
28 SePtember
By TNL: GN2'l-5674

FlG
ConfigurationRecordProgram-$CN

) C h a n g et h e w a r n i n gp o i n t f o r S H A o v e r l a y .

P R O G R A MD E S C R I P T I O N

r Changethe sizeof mainstorage,selectedpartitions,and
f i l e s h a r ea r e a .

The configurationrecordprogramhasthe following
fu nctions:

t h e s p o o lf i l e c y l i n d e rs i z e .
r Change

o Changethe assignment
of the 5444 unit codes.

r Changethe spoolfile location.

o Set the automaticstartfor spoolingfunctionson or off.

r Includethe page/card
count and the form/cardtype inthat areentered
formationon the spooltime messages
in the systemhistoryarea.

o Set the automaticwrite for spoolingfunctionson or off .
o A l l o w o r d i s a l l o wt h e b l a n kO C L f u n c t i o n .
r Changethe supportfor catalogingto a programpack.
o Allow or disallowsharingamongpartitionsof the consoleasa systeminput device.
o Changethe spoolingcardtype. forms type. or track
g r o u ps i z e .

. Changethe systeminput, punch,or print deviceassigned
to a partition.
o A l l o w o r d i s a l l o wt i m e s t a m p i n g
o f l - , D - ,a n d R - t y p e
messages
that appearon the systemconsole.
o Change
t h e r a t i oo f s h a r eD T F sa n d F S O E si n t h e f i l e
sharearea.
o Changethe f ile sharedefaultoption.

o Changethe systemdateformat.
o Changethe halt statusfor a partition.
o Changethe halt statusfor the systemhistoryarea.
o Change
t h e s y s t e mI D E L E T Es t a t u s .

Note: Before executing this program. you should be
f a m i l i a r w i t h t h e i n f o r m a t i o n a b o u t s i m u l a t i o na r e a si n
Part 3 of this manual and also the information presented
under Considerations for Program Pack Protection in the
IBM System/3 Model l5 System Generation Reference
Manual, GC2'l-7616.

o Changethe log deviceandejectstatusfor a partition.
Changingthe ConfigurationRecord
o Deleteor retainl-type messages
that areon the console
at EJ.
o Formatand print the configurationrecord.
o C h a n g et h e p r i o r i t yo f p a r t i t i o n sa n d s p o o ld u r i n gl P L .
o Allow or disallow$OCOPYto erasethe displayscreen
to the terminal.
beforewriting the next message
($OCOPYmust be executingunderCCP.)
a

Changethe requirementfor $OCOPYauthorization.

O

Changethe limit of the priority of jobs placedon the
activespoolfile readerqueueby $OCOPY. ($OCOPY
must be executingunderCCP.)

The parameterthat you specifyon the control statement
the configurationrecordon the systempackfrom
changes
which the IPL was performed.Therefore,it is not necessaryto do a systemgenerationfor the purposeof changing
any part of the configurationrecordthat can be changed
b y t h e $ C N F I Gp r o g r a m .
Althoughthe configurationrecordon the systempack is
changedat the time $CNFIG is executed,the changeis not
effectiveuntil anotherIPL is performed.The changeto the
configurationrecordremainsin effect until anothersystem
g e n e r a t i oonr u n t i l i t i s c h a n g e d
by $CNFlG.

d h i l eE N T E R R E A D E R
t os b e d i s p l a y e w
Allow message
DATA or ENTER DATA is promptedon the console.
Changethe extendedrestartfunction.

ConfigurationRecord Program-$CNFIG

4'17

P a g eo f G C 2 1- 5 16 2 - 1
lssued 28 September 1g79
B y T N L : G N 2 1- 5 6 7 4

C O N T R O LS T A T E M E N TS U M M A R Y
The control statements
you must supplydependon the
desiredresults.
Function

control statements

Assign 5444 unit codes ro
p a r t i t i o n1 , 2 , o r 3 s i m u l a t i o n
areas

//AsNP
1l1""0.-,*,

Set automatic start for
spooling functions on
or off
Set automatic write for
s p o o l i n gf u n c t i o n s o n
or off
B l a n kO C L

Catalog to a program pack

Specify whether the system
console can be shared by
the partitions as a system
input device

(s)

, ^,,,?[,R,Nr
l 15'f
] [,,,*.,l15'l]
[,^.oo
ln't]
\ves/l
/AUrP[,,,*,
I ;:'l][,,,^.,I ' ol l
// BLANK
".. {ffit}

//cArLG
'^._
{iii.}
// coNsoLsHARE.{J5r
}

Changespooling card type

ii DEFCN

CARD-xxx

Changespooling forms type

// DEFFN

FORM-xxx

Changesystem date format

// FoRMAT DATE-lMMDDYY\
IDDMMYY,'

Change ratio of share DTFs
t o F S O E sa n d / o r f i l e s h a r e
defaultoption

//FSHARET[^*
l*rl]
L "lii]F,^-.

H a l t p a r t i t i o n 1, 2 , o r 3 o n
system messages

,{iiiii},.,,
{ffi'}

Set the delete l-messages
function

lt trypE

O"ou

4-18

must specifyat leastone parameter.

TDELETE
{l|s I

P a g eo f G C 2 1- 5 16 2 - 1
l s s u e d2 8 S e p t e r n b e r1 9 7 9
By TNL: GN21-5674

/
,o.u,.u
llilliig;.,i

R e a s s i gpna r t i t i o n1 , 2 , o r
3 l o g d e v i c ea n ds e te j e c t
status

(r-ocer
//

(,3
)
'{ffi'}

( 1 )

/ / s Y r N <>2
( e)

MFCUl
MFCU2
MFCMl
MFCM2
DEVICE.
1442
2501
CONSOLE
3741
MFCUl
MFCU2
MFCMl
MFCM2
1442
3741
NONE

/sYPc{;}
".".=
I

/ s Y P R i lDEV'cE
f
j
{li8;}
ts
// TSTAMP

,{+'n,}.
"{+3,}

T h i s p a g e i n t e n t i o n a l l yl e f t b l a n k .

Configuration Record Program-$CNFIG

4'19

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

P A R A M E T E RS U M M A R Y
Parameter

Description

A U T H O RI Z E - Y E S
-NO

S p e c i fe sw h e t h e ra u t h o r i z a t i oins r e q u i r e df o r $ Q C O P Y .

CARD-xxx

xxx can be a maximum of threevalid IBM Svstem/3
c h a r a c t e r se x c e p t c o m m a s ,l e a d i n go r e m b e d d e db l a n k s ,
or apostrophes.

code-area

P o s s i b l e5 4 4 4 u n i t c o d e sa r e
F 1 , R 1, F 2 , R 2
P o s s i b l es i m u l a t i o na r e ac o d e sa r e
D 1 A , D 1 B , D 1 C .D 1 D ,
D2A, D2B, D2C, D2D.
D3A, D3B, D3C,D3D, D3E. D3F, D3G, D3H,
D4A, D4B, D4C,D4D, D4E,D4F, D4G, D4H

CYL-xxx

S p e c i f i e st h e n e w t o t a l n u m b e r o f c y l i n d e r sf o r t h e s p o o l f i l e . T h e
number (xxx) must be from 1 through 166 (3340) or 1 through
186 (3344).

DATE-N4MDDYY

Month-day-year
Day-month-year

DDMMYY
D-NO
YES

l f D - Y E S i s s p e c i f i e d ,D - ( d e c i s i o n )a n d R - ( r e p l y ) t y p e
m e s s a g etsh a t a p p e a ro n t h e s y s t e mc o n s o l ea n d t h e i r
r e s p o n s e as r e t i m e - s t a m p e dw h e n e n t e r e di n t h e S H A ( s y s t e m
h i s t o r y a r e a ) . l f D - N O i s s p e c i f i e do r a s s u m e d D
, -type
m e s s a g easr e n o t t i m e - s t a m p e d .

D E V I C E . fFuC
l M1
.MFCM2
,MFCU1
- MF C U 2
-1403
1442
2501
-CONSOLE
-3284
3741
.NONE
EJECT/NOEJECT

4-20

P r i m a r yh o p p e r o f 2 5 6 0
Secondary hopper of 2560
Primary hopper of 5424
Secondary hopper of 5424
1403 Printer
1442 Card Read Punch
2501 Card Reader
3277 Display Station
3284 or 3287 Printer
D i r e c t l y a t t a c h e d3 7 4 1 D a t a S t a t i o r r / P r o g r a m r n a bW
l eo r k
Stati on
N o p u n c h d e v i c ea s s i g n e d
S p e c i f i e sw h e t h e r a p a g e i s t o b e e j e c t e db e f o r e E S a n d E J
and after EJ.

P a g eo f G C 2 1 - 5 1 6 2 - ' l
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

ERASE.YES
_NO

S p e c i fi e sw h e t h e r $ O C O P Y ( w h e r re x e c u t e du n d e r C C P ) i s t o
erasethe terminal screenaf ter inf ormation has been entered on
the terminal.

EXTENDED.YES
NO

S p e c i f i e sw h e t h e r t h e e x t e n d e dr e s t a r tf u n c t i o n i s t o b e u s e d .

FORM-xxx

x x x c a n b e a m a x i m u m o f t h r e e v a l i d I BM System/3 characters
e x c e p t c o m m a s ,l e a d i n go r e m b e d d e d b l a n k s ,o r a p o s t r o p h e s .

FS-xxx

S p e c i f i e st h e n e w s i z e ( a m u l t i p l e o f 2 ) o f t h e f i l e s h a r ea r e a . T h e
n u m b e r ( x x x ) c a n n o t b e l e s st h a n 2 .

HALT-YES
-NO

S p e c i f i e sw h e t h e r t h e s y s t e m i s t o h a l t . n o t h a l t , o r i n v o k e $ H A C C P
w h e n a p r e d e t e r m i n e dn u m b e r o f t r a c k s r e m a i n i n t h e S H A b e f o r e
u n p r i n t e d e n t r i e sa r e o v e r l a i d .

r-No
ves

l f l - Y E S i s s p e c i fi e d , l - t y p e ( i n f o r m a t i o r r a l )m e s s a g etsh a t
a p p e a ro n t h e s y s t e mc o n s o l ea r e t i m e - s t a m p e dw h e n e n t e r e di n
t h e S H A ( s y s t e mh i s t o r y a r e a ) . l f l - N O i s s p e c i f i e do r a s s u m e d ,
l - t y p e m e s s a g easr e n o t t i m e - s t a m p e d .

IDELETE.YES
_NO

S p e c i f i e sw h e t h e r l - t y p e m e s s a g easr e t o b e d e l e t e d .

M.YES
-NO

S p e c i fi e s w h e t h e r t o i n c l u d e t h e p a g e / c a r dc o u n t a n d t h e f o r m / c a r d
t y p e i n f o r m a t i o n o n t h e s p o o l m e s s a g ei n t h e s y s t e mh i s t o r y a r e a .

OCL.YES
-NO

S p e c i fi e s w h e t h e r t h e b l a n k O C L f u n c t i o n i s s u p p o r t e d .

P A C KN O N E

N o c a t a l o g i n gt o a n y p r o g r a m p a c k .
C a t a l o g i n gt o t h e C C P p r o g r a m p a c k .
C a t a l o g i n gt o a l l p r o g r a m p a c k s .

-ccP
-ALL

PRINT-YES
-NO

S p e c i f i e sw h e t h e r t h e p r i n t w r r t e r i s t o a u t o m a t i c a l l ys t a r t d u r i n g
I P L ( A U T S T ) . O r , s p e c i f i e sw h e t h e r t h e p r i n t w r i t e r i s t o a u t o m a t i c a l l y s t a r t w h e n o u t p u t i s a v a i l a b l eo n t h e p r i n t q u e u e ( A U T W T ) .

PUNCH.YES
_NO

S p e c i fi e s w h e t h e r t h e p u n c h w r i t e r i s t o a u t o m a t i c a l l ys t a r t d u r i n g
I P L ( A U T S T ) . O r , s p e c i f i e sw h e t h e r t h e p u n c h w r i t e r i s t o a u t o m a t i c a l l y s t a r t w h e n o u t p u t i s a v a i l a b l eo n t h e p u n c h q u e u e ( A U T W T ) .

P1 - x x x

S p e c i f i e st h e n e w s i z e ( a m u l t i p l e o f 2 l o f p a r t i t i o n 1 . T h e m i n i m u m
s i z eo f P 1 i s 8 K .

P2-xxx

S p e c i f i e st h e n e w s i z e ( a m u l t i p l e o f 2 ) o f p a r t i t i o n 2 . f h e m i n i m u m
s i z eo f P 2 ( i f o t h e r t h a n z e r o ) i s 8 K .

Configuration Record Program-$CNFIG

4-24.1

P a g eo f G C 2 1 - 5 16 2 - 1
lssued 28 September 1979
By TNL: GN21-5674

P3-xxx

S p e c i f i etsh e n e w s i z e{ a m u l t i p l eo f 2 } o f p a r t i t i o n3 . T h e m i n i m u m
s i z eo f P 3 ( i f o t h e rt h a n z e r o )i s 8 K .

RATIO.l
-2
-3

S p e c i fe st h e r a t i oo f s h a r eD T F st o F S O E si n t h e s h a r ea r e a .

READ.YES
-NO

Specifies whether the spooled reader i s t o a u t o m a t i c a l l ys t a r t a f t e r
an IPL is performed.

RETAIN-YES
.NO

Specifieswhether to retain the l-type messagesthat are on the
c o n s o l ea t E J .

ROPTY-O
-1

Specifies
the priority limit for the jobs that are placedon the active
s p o o lf i l e r e a d e q
r u e u eb y $ O C O P Y .T h i sf u n c t i o ni s e f f e c t i v eo n l y
when$OCOPYis executedundercontrol of CCP.

-z

-3
-4
-5
SEOUENCE.

t[']l

S p e c i f i etsh e p r i o r i t yo f p a r t i t i o n sa n ds p o o l .

SHARE-YES
_NO

Specifies whether file sharing is allowed between partitions
{ F S H A R E ) . O r , s p e c i fi e s w h e t h e r t h e c o n s o l ec a n b e s h a r e d
a m o n g p a r t i t i o n sa s a n i n p u t d e v i c e( C O N S O L ) .

SYS-xxx

Specifiesthe main storagecapacity of the system. Possible
valuesforxxx are 96, 128, 160. 192, 224,256,384,or 512.

TRACKS.l

T h e s i z e o f t r a c k g r o u p sw i t h i n t h e s p o o l i n gd i s k a r e a .

-t
'z

-4
.E

-10
TRACKS-xx

Specifies
the numberof tracksin the SHA betweenthe SHA warning
p o i n t a n d t h e f i r s t u n p r i n t e de n t r y . P o s s i b lvea l u e sf o r x x a r e
0 t h r o u g h1 0 .

UNll"-code

S p e c i f i e st h e m a i n d a t a a r e at h a t i s t o c o n t a i n t h e s p o o l f i l e .
Possiblecodes are those for the main data areas.

4-20.2

T h i s p a g ei n t e n t i o n a l l y l e f t b l a n k .

Configuration Record Program-$CNFIG

4-21

P a g eo f G C 2 1- 5 16 2 - 1
l s s u e d2 8 S e p t e m b e r19 7 9
By TNL: GN2l-5674

P A R A M E T ER D E S C R I P T I O N S

Restrictions for Assigning Simulation Areas

A U " f H O ! l f Z E P a r a m e t e r( O C O p y )

U n i t c o d e s ( F 1 , R 1 , F 2 , a n d R 2 ) a r e a s s i g n e db y p a r t i t i o n
t o a n y o f t h e s u p p o r t e ds i m u l a t i o na r e a s . E a c h u n i t c o d e
f o r a g i v e n p a r t i t i o n m u s t b e a s s i g n e dt o a s i m u l a t i o na r e a .

T h e A U l ' H O R I Z E p a r a m e t e ri s a s s o c i a t e dw i t h t h e a u t h o r i _
zationfunction of the Spool File Copy program($OCOpy).
W h e n A U T H O R I Z E - Y E Si s s p e c i f i e da n d $ O C O p y i s
e x e c u t e du n d e r C C P , c e r t a i nf u n c t i o n s o f $ O C O p y c a n n o t
b e e x e c u t e du n l e s st h e u s e r i s p r o p e r l y a u t h o r i z e d . W h e n
A U T I - { O R I Z E - N Oi s s p e c i f i e dn, o a u t f r o r i z a t i o ins r e q u i r e d .
F o r m o r e i n f o r m a t i o n a b o u t g r a n t i n ga u t h o r i z a t r o nt o a
user, re{er to the Spool File Copy prograrn, $OCOpy.
C A R D P a r a m e t e r( D E F C N )

S i m u l a t i o n a r e aa s s i g n m e n t a
s r e s e t i n t h e c o n fi g u r a t i o n
r e c o r d d u r i n g s y s t e m g e n e r a t i o na n d r e m a i n i n e f f e c t u n t i l
either another system generation is performed that has
d i f f e r e n t s i m u l a t i o n a r e aa s s i g n m e n t os r u n t i l t h e c o n f i g u r a t i o n r e c o r d p r o g r a m ( $ C N F I G ) i s u s e dt o c h a n g et h e
s i m u l a t i o n a r e aa s s i g n m e n t s A
. n ASSIGN statement
t e m p o r a r i l y r e a s s i g ntsh e s i m u l a t i o na r e a sf o r t h e p a r t i t i o n
i n w h i c h i t i s p r o c e s s e du n t i l a n o t h e r I P L i s p e r f o r m e d o r
a n o t h e r A S S I G N s t a t e m e n ti s p r o c e s s e d .

T h e C A R D p a r a m e t e r( C A R D - x x x ) r e d e fi n e st h e c a r d t y p e
t h a t t h e o p e r a t o r l o a d s i n t o t h e p u n c h d e v i c ef o r t h e n e x t
job. xxx can be any three valid System/3 characters(see

R e f e r t o t h e f o l l o w i n g c h a r t f o r i n v a l i d s i m u l a t i o na r e a
assignments.

A p p e n d i x A ) e x c e p t c o m m a s o r l e a d i n go r e m b e d d e d
b l a n k s . T h e C A R D N O p a r a m e t e ro f a P U N C H O C L s t a t e ,
m e n t c a n t e m p o r a r i l y o v e r r i d et h i s d e fi n i t i o n .

52144Unit
Codes

Simulation areasthat cannot be
assignedthe il44 unit codes.

F1

D 1 B ,D 3 8

R1

D 1 A ,D 3 A

F2

D 1 A ,D 1 B ,D 3 A ,D 3 B

R2

D 1 A ,D 1 B ,D 3 4 , D 3 B

Code-Area Parameter (ASNPx)
S i m u l a t i o na r e ac o d e sa r e u n i q u e t o t h e t y p e a n d d e s i g n a t i o n o f e a c h d i s k d r i v e . A f t e r a s s i g n r n e n t ,h e 5 4 4 4 u n i t
c o d e i s u s e d t o i d e n t i f y t h e s i m u l a t i o na r e at o b e a c c e s s e o .
T h e f o l l o w i n g c h a r t s h o w st h e r e l a t i o n s h i po f t h e t y p e a n d
d e s i g n a t i o no f a d i s k d r i v e a n d t h e s i m u l a t i o na r e ac o o e s .

Disk Drive
Type and Designation

S i m u l a t i o nA r e a
Codes

3 3 4 0d r i v ei
3 3 4 0d r i v e2
3 3 4 0d r i v e3
3 3 4 0d r i v e4

D 1 A ,D 1 B D
, 1 CD
, lD
D 2 A , D 2 B .D 2 C , D 2 D
D 3 E ,D 3 A
D 4 E ,D 4 A

3344 drive3
V o l u m e1
V o l u m e2
V o l u m e3
V o l u m e4
3 3 4 4d r i v e4
V o l u m e1
V o l u m e2
V o l u m e3
V o l u m e4

D 3 E ,D 3 A
D 3 F ,D 3 B
D 3 G ,D 3 C
D 3 H ,D 3 D

D 4 E ,D 4 A
D 4 F ,D 4 B
D 4 G ,D 4 C
D 4 H ,D 4 D

C Y L P a r a m e t e r( S P C Y L )
T h e C Y L p a r a m e t e r{ C Y L - x x x ) s p e c i fi e s t h e n e w t o t a l
n u m b e r o f c y l i n d e r sa s s i g n e dt o t h e s p o o l f i l e . T h e n u m b e r
(xxx) must be from 1 through 166 if the spool file is on a
3 3 4 0 D i r e c t A c c e s sS t o r a g eF a c i l i t y o r f r o m 1 t h r o u g h 1 8 6
if the spool file is on a 3344 Direct AccessStorage.

D Parameter (TSTAMP)
T h e D - Y E S p a r a m e t e rs p e c i fi e s t h a t d e c i s i o na n d r e p l y t y p e
m e s s a g etsh a t a p p e a ro n t h e s y s t e mc o n s o l ea n d t h e i r
responsesare to be time-stamped when entered in the
s y s t e mh i s t o r y a r e a . l f D - N O i s s p e c i f i e do r a s s u m e d t, h e
m e s s a g easn d t h e i r r e s p o n s e a
s re not time-stamped.
T h e t i m e - s t a m pr e c o r d i m m e d i a t e l yf o l l c l w st h e m e s s a g e
a n d r e s p o n s e .T h e f o l l o w i n g e x a m p l e s h o w st h e f o r m a t o f
t h e t i m e - s t a m pr e c o r d :
2 //
2 //
2
2
2
?

A a a

LOAD $I!1AINT,F1
RUN
//
COPY F
2 L I . 46 4 S T D
12'
04/26/78 00.00.59
2 2 LM 6A ST D
1,23
04/26/78 00.01.02

$ I " 1 IAN T O l
$ M Ai N T O l

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued 28 September 1979
By TNL: GN21-5674

DATE Parameter{FORMATI

E X T E N D E DP a r a m e t e(rR E A D Y )

The DATE parameterredefinesthe systemdateformat to
e i t h e rm o n t h - d a y - y e (aDr A T E - M M D D Y Yo) r d a y - m o n t h y e a r( D A T E - D D M M Y Y ) .

, Y l N x , S Y P G xS
D E V I C EP a r a m e t e(rL O G P x S
, YPRx)

T h e E X T E N D E Dp a r a m e t e( rE X T E N D E D - Y EoSr
E X T E N D E D - N Os)p e c i f i ew
s h e t h e rt h e a u t o m a t i cm e s s a g e
restartfunction is to be used. This parameterappliesonly
to the extendedrestartfunction and not to the unit record
restartfunction. lf used,the systemoperatorneednot
respondwith a 1 option to certainsystemmessages.

T h e D E V I C Ep a r a m e t erre d eifn e sa p a r t i t i o n ' sa s s i g n el d
og
device,systeminput device,systempunchdevice.or system
p r i n td e v i c e .

/Vote.'This parameteris validonly if the unit recordrestart
andlorthe extendedrestartoption(s)wasselectedduring
systemgeneratton.

Valid codesfor the partitionlog deviceare3277, 14O3,
3284. An EJECTor NOEJECTparametercan be specified
with the 1403or 3284. A LOG OCL statementcan overr i d et h i s d e f i n i t i o n .

F O R MP a r a m e t e(rD E F F N )

V a l i dc o d e sf o r t h e s y s t e mi n p u td e v i c ea r eM F C M 1 .
MFCM2M
, FCU1M
, F C U 2 ,1 4 4 2 , 2 5 0 1 , 3 2 7 7 , 3 7 4 1A.
R E A D E Rc o m m a n do r R E A D E RO C L s t a t e m e ncta no v e r r i d et h i sd e f i n i t i o n .
V a l i dc o d e sf o r t h e s y s t e mp u n c hd e v i c ea r eM F C M 1 ,
M F C M 2M
, FCU1M
, F C U 2 ,1 4 4 2 , 3 7 4 1o, r N O N E . A
P U N C HO C L s t a t e m e nct a no v e r r i d et h i sd e f i n i t i o n .
Valid codesfor the systemprint deviceare 1403or 3284.
A P RI N T E RO C L s t a t e m e ncta no v e r r i d et h i s d e f i n i t i o n .

EJECTor NOEJECTParameter(LOGPx)
r , h e ni n c l u d e dw i t h
T h e E J E C To r N O E J E C Tp a r a m e t e w
t h e D E V I C E - 1 4 0 o3 r D E V I C E - 3 2 8 p4 a r a m e t eorf t h e
LOGPxstatement,specifieswhethera pageis to be ejected
beforeend of step,beforeend of job, and after end of job.
A L O G O C L s t a t e m e nct a no v e r r i d et h i s s p e c i f i c a t i o n .

T h e F O R Mp a r a m e t e(rF O R M - x x x )r e d eifn e st h e f o r m s
type that the operatormountson the printerfor the next
job. xxx can be any threeSystem/3characters
(see
AppendixA) exceptcommasor leadingor embedded
b l a n k sT
. h e F O R M S N Op a r a m e t eorf a P R I N T E RO C L
s t a t e m e not r a C H A N G EF R M c o m m a n dc a nt e m p o r a r i l y
o v e r r i d et h i s d e f i n i t i o n .

F S P a r a m e t e( rS l Z E l
T h e F S p a r a m e t e(rF S - x x x )s p e c i fe st h e n e w s i z e( i n m u l t i .
p l e so f 2 K ) o f t h e f i l e s h a r ea r e a .T h e s i z e( x x x ) c a n n o tb e
l e s st h a n 2 o r g r e a t etrh a nt h e s i z eo f m a i ns t o r a g e
minus
the sum of the amountof main storageassigned
to the
s u p e r v i s opr .a r t i t i o n1 , p a r t i t i o n2 , a n d p a r t i t i o n3 .

HALT Parameter(HLTPx)
T h e H A L T p a r a m e t e(rH A L T - Y E So r H A L T - N O )s p e c i f i e s
whetherthe systemis to halt a partitionfor system
m e s s a g e( H
s L T P x ) . A H A L T O C L s t a t e m e not r a H A L T
c o m m a n dc a no v e r r i d et h i s d e f i n i t i o n .

ERASE Parameter (OCOPY)
W h e n E R A S E - Y E S i s s p e c i f i e da n d $ O C O P Y i s e x e c u t e d
under CCP, the screenon the requestingterminal is erased
before each messageis written. When ERASE-NO is specif ied, the information entered on the terminal remains on
the screen. The operator can erasethe screen by pressing
the ERASE EOF key.

T h i s H A L T p a r a m e t efru n c t i o n sa sa n O C L h a l t a n dc a n n o t
b eo v e r r i d d e b
n y a n O C CN O H A L T c o m m a n d .

Configuration Record Program-$CNFIG

4'22.1

-5162-1
Page
of GC21
lssued
28 September
1979
B yT N L : G N 2 1 - 5 6 7 4
(SHA)
HALT Parameter

M Parameter(SPOPT)

The HALT-YESparameterspecifiesthat the systemis to
issuea message
and stop when a predetermined
numberof
tracksremainin the systemhistoryareabeforeoverlayof
unprintedrecordsoccurs.The HALT-NO parametercauses
no actionto be takenwhen unprintedrecordsin the system
history areaareabout to be overlaid.The HALT-CCPAUTO
parameterspecifies
that the systemis to invokethe $HACCP
program(if CCPis executing)when a predetermined
numberof tracksremainin the systemhistoryareabefore
overlayof unprintedrecordsoccurs.

WhenM-YESis specified.the pagecount and the forms
type for print queuejob stepsare includedon the spool
time message
in the systemhistoryarea. Also, the card
count and the card type for punchqueuejob stepsare includedon the spooltime message
in the systemhistory
a r e a .W h e nM - N O i s s p e c iife d ,t h i sa d d i t i o n ailn f o r m a t i o n
is not includedon the spooltime message.

I Parameter(TSTAMPI
The l-YESparameterspecifies
that informationaltype
messages
that appearon the systemconsoleare to be timestampedwhenenteredin the systemhistoryarea. lf l-NO
is specifiedor assumed,
the messages
are not time-stamped.
The time-stamprecordimmediatelyfollowsthe message.
The followingexampleshowsthe format of the time-stamp
record:
2 _ 2 SP UT FA I
S P O O LF I L E S T A R T E_D O L D , D 4 3 , 5 A , 5
2
0 5 / 0 8 , / 7 80 0 . 0 0 . 1 7

The format of the messages
is shownin the following
examples.
S SP UT TM I JOBA
IODRVROI
1 2 / 0 8 / 7 8 0 0 . 0 1 . 3 70 0 . 0 1 . 4 5 P R
F O R MT Y P E - I O A P A G E S . 2
S S P U TT M o r I J O B B
IODRVR02
1 2 / 0 8 / 7 8 0 0 . 0 1 . 4 60 0 . 0 1 . 5 9 P C
C A R DT Y P E - X Y ZC A R D S - 1 0

OCL Parameter(BLANK)
T h e O C L p a r a m e t e(rO C L - Y E So r O C L - N O )s p e c i f i e s
whetherthe blank OCL function is to be used. lf the
function is used,all statements
enteredvia the systeminput
device(whenthat deviceis the systemconsole)areerased
from the screenwhen the ENTER key is pressed.

IDELETEParameter(lTYPEl
T h e I D E L E T Ep a r a m e t e( Ir D E L E T E - Y EoSr I D E L E T E - N O )
specifies
whetherthe systemis to automaticallydelete
information-type
messages
that havenot beenresponded
to. Normally.a response
is requiredto deletethese
m e s s a g eA
s .n I D E L E T Eo r N O I D E L E T Ec o m m a n dc a n
overridethis specification.

PACK Parameter(CATLG)
p a r a m e t eprr e v e n tcsa t a l o g i nogf a n
ThePACK-NONE
o b j e c tl i b r a r ye n t r y t o a n y s i m u l a t i o n
a r e at h a t c o n r a t n a
s
programwhich anotherpartitionhasloadedand is currently
executing.
parameterallowscatalogingof an object
The PACK-CCP
libraryentry to a CCPprogrampackeventhoughanother
p a r t i t i o n( i n a d d i t i o nt o t h e C C Pp a r t i t i o n )h a sl o a d e da n d
is currentlyexecutinga programfrom the CCPprogrampack.
The PACK-ALLparameterallowscatalogingof object
libraryentriesto all programpackseventhoughone or more
partitionshaveloadedprogramsfrom them and arecurrently
executingthoseprograms.
For other restrictions.seeLibrary MaintenanceProgram
under Multiprogramming Considerationsand Restrictionsin
P a r t2 o f t h i s m a n u a l .

4-22.2

Pageof GC21-5162-1
lssued28 September1979
ByTNL: GN21-5674

(AUTST,AUTWT)
PRINT Parameter

Pl Parameter(SIZE)

T h e P R I N Tp a r a m e t e(rP R I N T - Y E S
o r P R I N T - N O )w. h e n
usedwith AUTST, specifies
whetherthe print writer automaticallystartswhen an IPL is performed.This option
relieves
the operatorof havingto initiallyenteran operator
control commandto startthe printerwhen spoolingis
specified.

The P1 parameter(Pl-xxx) specifies
the new size(a multiple ot 2l of partition 1. The number(xxx) cannotbe less
than 8 or greaterthan the sizeof main storageminusthe
partition2, partition3.
sum of the sizesof the supervisor,
and the file sharearea.

The PRINT parameter,
when usedwith AUTWT, specifies
whetherthe print writer is to automaticallystart whenever
output is availableon the print queue.Whenoutput is
not availableon the queue,the print writer waitsfor output without issuinga message
or requiringoperator
interaction.

P2 Parameter
{SIZE)
The P2 parameter(P2-xxx)specifies
the new size(a multiple of 2) of partition 2. The number(xxx) cannotbe less
than 8 (if other than zero)or greaterthan the sizeof main
storageminusthe sum of the sizesof the supervisor,
partition 1, partition3. and the file sharearea.

PUNCHParameter(AUTST,AUTWT)
(SIZE)
P3 Parameter
Sr P U N C H - N O ) .
T h e P U N C Hp a r a m e t e(rP U N C H - Y E o
when usedwith AUTST, specifies
whetherthe punch
writer is to automaticallystart when an IPL is performed.
This option relievesthe operatorof havingto initially enter
an operatorcontrol commandto startthe punchwhen
spoolingis specified.

The P3 parameter(P3-xxx)specifies
the new size(a multiple of 2) of partition 3. The number(xxx) cannotbe less
than 8 (if other than zerolor greaterthan the sizeof main
storageminusthe sum of the sizesof the supervisor,
partit i o n 1 , p a r t i t i o n2 , a n dt h e f i l e s h a r ea r e a .

The PUNCHparameter,
when usedwith AUTWT, specifies
whetherthe punchwriter is to automaticallystartwheneveroutput is availableon the punch queue.Whenoutput
is not availableon the queue,the punchwriter waitsfor
output without issuinga message
or requiringoperator
i nteraction.
lUofe.'Punchautostart(// AUTST PUNCH-YES)is valid
only if readerautostartis not in effect.

ConfigurationRecord Program-$CNFIG

4-23

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
Bv TNL: GN21-5674

RATIO Parameter(FSHARE)

(OCOPY)
ROPTY Parameter

Whenan IPL is performedor the file shareareasizeis set
v i aa n O C Cc o m m a n dt,h e s h a r ea r e ai s i n i t i a l i z e d
according
to the followingspecifiedratio.

The ROPTYparameter(ROPTY-Othrough5) specifies
the
priority limit of the iobs placedon the activespoolfile
readerqueueby $OCOPY. (Thisparameteris effective
only when$OCOPYis executedundercontrol of CCP.)
The HIPTY OCCcommandcan be usedto temporarily
overridethis parameter.For more informationabout
readerqueuepriority. refer to the Spool File Copy program

Share
Area
Size
(K bytesl

Ratio

2

3

Number
of
SDTF
Blocksl

2
4
6
8

2
3
3
4

3
5
9
9

24
52
83
108

4
6
8

2
5
7
9

3
1
1
7

24
47
73
93

9
7
6
113

19
42
68
88

9
3
119
145

19
37
58
78

2

2

3
4
6
I

4

Number
of
FSOEs

2
4
6
8

6
8

3
8

' Referto File
Sharingfor a descriptionof SDTFsand
FSOES.
Note: lf the RATIO parameteris not specified,a ratio of
1 is assumed.

$oceY).
S E O U E N C E P A T A M E I E( P
T R IO R I T Y )
T h e S E O U E N C E p a r a m e t e rs p e c i f i e st h e p r i o r i t y o f t h e
p a r t i t i o n sa n d s p o o l .
The order of the code parametersspecifiesthe priority.
The leftmost code parameter has the highest priority;the
rightmost code parameter has the lowest. Two or more
t a s k sh a v e e q u a l p r i o r i t y i f a n e q u a l s i g n ( = ) o r a h y p h e n
(-) is specified between the parameters.
The following rules apply to the code parametersthat can
b e s u p p l i e dw i t h t h e S E O U E N C E k e y w o r d .
o

Each code parameter can be specified only once.

r

S P O O L ( S P ) i s a n i n v a l i d c o d e p a r a m e t e ri f s p o o l i n gi s
not supported.

o All code parametersmust be specified; there are no
defaults.
The following examples illustrate these rules:
SE O U E N C E . ' P 1 , P 2 , P 3 , S P '
S E O U E N C E - ' P 1, P 2 , P 3 '
SEOUENCE-'P1=P2=P3'
SEOUENCE.'P1-P2.P3'
P, P 3 '
S EO U E N C E - ' S P , P 2 . 1
S E O UE N C E - ' P 1, P 2 = P 3 - S P '

(AUTSTI
READ Parameter
T h e R E A D p a r a m e t e(rR E A D - Y E So r R E A D - N O )s p e c i f i e s
whetherthe spoolreaderis automaticallystartedwhen an
IPL is performed.This option relievesthe operatorof
havingto initiallyentercertainoperatorcontrol commands
whenspoolingis specified.(Readerautostart(// AUTST
R E A D - Y E S i)s v a l i do n l y i f p u n c ha u t o s t a rits n o t i n
effect.)

(MESSAG)
R ETAIN Parameter
WhenRETAIN-NOis specified,l-type messages
areerased
from the systemconsolescreenat EJ. WhenRETAIN-YES
is specified,l-type messages
arenot erasedfrom the system
consolescreenat EJ.
4-24

o

Only one group of code parameterscan be equated.
For example:
S E O UE N C E - ' S P = P 3 . P 2 =1P'
is not valid,but
'
SEOU E NCE.'SP.P3-P2.P
1
ano
S E O UE N C E - ' S P , P 3 = P 2 =1P'
arevalid.

Page
of GC21-5162-1
lssued
1979
28 September
B yT N L : G N 2 1 - 5 6 7 4
SHARE Parameter(COt\lSOLl

The numberxx must not be greaterthan one-halfthe
n u m b e ro f t r a c k si n t h e S H A .

T h e S H A R Ep a r a m e t e(rS H A R E - Y E Ss)p e c i f i etsh a t t h e
consolecan be sharedby the partitionsasa systeminput
device.WhenSHARE-NOis specified,the consolecannot
be sharedby the partitions.

a warning
lf TRACKS-0is specified,the systemassumes
point of approximately50 4Gbyte SHA records.(There
are144 4O-byteSHA recordsper track.)

S H A R EP a r a m e t e(rF S H A R E )

TRACKSParameter(SPEXT)

T h e S H A R Ep a r a m e t e(rS H A R E - Y E S
or SHARE-NO)
specifies
whetherthe systemwill defaultto allow file
sharingbetweenpartitions.

T h e T R A C K Sp a r a m e t e(rT R A C K S - n nc)h a n g etsh e s i z eo f
the track groupswithin the spoolingdisk area.nn canbe
1 , 2 , 4 , 5 . o r 1 0 . T h e S T A R T c o m m a n dc a no v e r r i d et h i s
d e fi n i t i o n .

(SlZEl
SYS Parameter
(SPDSK)
UNIT PATAMEIET
The SYS parameter(SYS-xxx)specifies
the new main
storagesizefor the system.Possible
valuesfor xxx are:
Group 1

Group 2

96
128
160
192
224
256

384
512

T h e U N I T p a r a m e t e(rU N | T - c o d es)p e c i f i etsh e n e w m a i n
codesare
dataareato be usedfor the spoolfile. Possible
D
3
,
D
3
1
,
D
3
2
,
D
3
3
,
D
3
4
,
D
4
,
D
4
1
,
D
42,D43,
Dl,D2,
D44.
and

C O N S I D E R A T I O NASN D R E S T R I C T I O N S
r

This programmust be executedon a dedicatedsystem
exceptwhen printingthe configurationrecord.

The configurationrecordprogramwill issuean error messagewhen a valueis specifiedthat is not within the same
groupasthe currentsystemsize. This is because
group 1
and group2 requiredifferentmodulesto be includedin the
generated
supervisor.Therefore,a systemgenerationis requiredwhen it is necessary
to changethe systemsizeto a
valuethat is not within the samegroupasthe current
systemsize.

The changesare not effectiveuntil an IPL is performed.

(SHA)
TRACKS Parameter

of 5444
All restrictionsthat apply to the assignment
u n i t c o d e sa n ds i m u l a t i o na r e a sd u r i n gs y s t e mg e n e r a ,e
t i o n a l s oa p p l yf o r $ C N F l G . F o r t h e s er e s t r i c t i o n s e
AssigningSimulationAreas in Part 3 of this manual.

T h e T R A C K Sp a r a m e t e(rT R A C K S - O
t h r o u g h1 0 ) d e f i n e s
t h e S H A w a r n i n gp o i n t . T h e x x v a l u es p e c i f i etsh e n u m b e r
of tracksthat remainin the SHA betweenthe warning
point and the first unprintedentry. Whenxx tracksremain and HALT-YESis specifiedon the SHA statement,
the systemstopsand a message
is displayed.Whenxx
tracksremainand HALT-NO is specifiedon the SHA
statement,the systemis not stoppedand no message
is
displayed.Whenxx tracksremain(xx must not be 0) and
HALT-CCPAUTOis specifiedon the SHA statement,the
. or
$ H A C C Pp r o g r a mi s i n v o k e d( i f C C Pi s e x e c u t i n g ) F
informationaboutthe $HACCPprogram,referto the IBM
System/3 CommunicationsControl Program SystemReferenceManual, GC21-7620.

The new configurationrecordremainsin effectuntil
anothersystemgenerationor until it is changedby
$ C NF I G .
The ASSIGNOCL statementcan be usedto temporarily
reassign
the 5444 unit codes(the configurationrecordis
not changed).

a r e a si n c l u d e d
O n l y t h e 5 4 4 4u n i t c o d e sa n ds i m u l a t i o n
All other prein the control statementarereassigned.
v i o u sa s s i g n m e nrtesm a i nt h e s a m e .

Configuration Record Program-$CNFIG

4-24.1

OCL CONSIDERATIONS
The followingOCL statements
areneededto load the con.
figurationrecordprogram:

The codeyou supplydependson the locationof the simu_
lation areacontainingthe configurationrecordprogram.
PossibfecodesF
a r1e. R 1 , F 2 , R 2 .

4-24.2

Pageof GC21-5162-1
lssued28 September1979
ByTNL: GN21-5674

EXAMPLES
Figures4-7 through4-14.2areexamplesof the control
statements
neededfor various$CNFIG functions.

Explanation:

Explanation:

o All informationalmessages
that appearon the system
whenthey areenteredinto the
consolearetime-stamped
a n dr e p l y
s y s t e mh i s t o r ya r e a( l - Y E S ) .D e c i s i o n
(D-NO).
messages
and responses
are not time-stamped
dr assumed.
T h e D - N Op a r a m e t ecra n b e s p e c i f i e o
Figure 4-9. Time-Stamp Only Informational Type Messages

o The 5444 unit codesare reassigned
for partition2
(ASNP2).
.

The 5444 unit codesare reassigned
for partition 1
( A S N P)l .

o The 5444 unit codesarereassigned
for partition3
(ASNP3).
Figure 4-7. ReassignAll 5444 Unit Codes for Three Partitaons

Explanation:
o

and
No informational, decision, or reply messages
responsesare time-stamped when entered into the system
h istory area.

are Time$tamped
Figure4-10, No Messages
or Responses

Explanation:
T h e c u r r e n t c o n f i g u r a t i o nr e c o r d i s p r i n t e d ( P R I N T ) .
The 5444 unit code F2 is reassignedto simulation area
D2C |F2-D2C) for partition 2 (ASNP2).
o

The revisedconfiguration record is printed (PR INT).

Figure4-8. Print the Current Conf iguration Record (PRlNTl,
Reassigna Single 5444 Unit Code in Partition 2
(ASNP2), and Print the Revised Configuration Record
(PRINT)

Explanation:
.

to simulationarea
The 5444 unit code R2 is reassigned
D2D (R2-D2D)for partition3 (ASNP3).

o T h e P A C K - N O N Ep a r a m e t esrp e c i f i etsh a t c a t a l o g i nigs
n o t a l l o w e dt o a s i m u l a t i o na r e ab e i n gu s e da sa p r o g r a m
p a c kf o r a n o t h e rp a r t i t i o n .
Figure 4-11. Reassigna 5444 Unit Code and Change the Support
for Cataloging to a Program Pack

C o n fi g u r a t i o n R e c o r d P r o g r a m - $ C N F I G

4-25

Explanation:
o The PACK-CCP
parameterspecifiesthat catalogingis
allowedto a CCPprogrampack.
Figure 4-12, Change the Support for Cataloging to a program pack

Explanation:
.

T h e s y s t e m i n p u t d e v i c ef o r p a r t i t i o n 2 ( S Y l N 2 ) w i l l b e
t h e 3 7 4 1 D a t a S t a t i o n( D E V I C E 3 7 4 1 ) .
N o s y s t e mp u n c h d e v i c e( D E V I C E - N O N E )w i l l b e
a s s i g n e dt o p a r t i t i o n 2 ( S Y P C 2 ) .
T h e l o g d e v i c ef o r p a r t i t i o n 2 ( L O G P 2 ) w i l l b e t h e 3 2 8 4
P r i n t e r ( D E V I C E 3 2 8 4 ) . T h e p r i n t e r p a g ew i l l n o t e j e c t
( N O E J E C T )a t e n d o f s t e p a n d e n d o f j o b .

o W i t h I D E L E T E - Y E S ,H A L T N O , a n d E X T E N D E D - Y E S ,
t h e s y s t e mo p e r a t o r i s n o t r e q u i r e dt o r e s p o n dt o a l l
s y s t e mm e s s a g e s .
Explanation:
o T h e s y s t e mp u n c h d e v i c ef o r p a r t i t i o n 1 ( S Y P C 1 )w i l l b e
t h e 5 4 2 4 s e c o n d a r yh o p p e r ( D E V I C E - MF C U 2 ) .
Cardtype 96C will be the spooldefault.
T h e s y s t e md a t e i s t o b e e n t e r e di n t h e f o r m a t 2 4 O 8 " 7 7
(24 August 1977).
T h e s y s t e mp r i n t d e v i c ef o r p a r t i t i o n 1 ( S Y P R 1 ) w i l l b e
the 3284 Printer(DEVtCE-3294).
Form type STN will be the spool default.
o T h e s y s t e mw i l l n o l o n g e r h a l t w h e n t h e s y s t e mh i s t o r y
a r e ai s f u l l .
Figure4-13. Reassign
SystemDevicesand Output Media
for Partition1

4-26

Figure4-14. Reassign
Systemand Log Devices
for Partition2 and
Do Not RequireOperatorIntervention

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

Explanation:
Explanation:
o T h e i n p u ts p o o l i n gr o u t i n e( R E A D - Y E Sa) u t o m a t i c a l l y
startsduringan IPL (operatorcontrol commandsare
n o t r e q u i r e d )T
. h e p u n c hw r i t e r ( P U N C H - N Oa)n dt h e
print writer (PRINT-NO)will not start until the operator
control commandsareentered.
o The punchwriter (PUNCH-YES)
and the print writer
(PRINT-YES)automaticallystart (without operaror
control commands)whenthere is output on the queues.
o OCOPYinformationthat is enteredat a terminalunder
CCPis not erasedfrom the terminalscreen(ERASE-NO).
.

A u t h o r i z a t i o n( A U T H O R I Z E - Y E Si s) r e q u i r e df o r t h o s e
userswho execute$OCOPYundercontrol of CCP. The
priority limit (ROPTY-2)of jobs placedon the active
spoolfile readerqueueby $OCOPYis 2 ($OCOPYmust
be executedundercontrol of CCP).

o The numberof cylindersassigned
to the spoolfile is
25 (CYL-25).
o The spoolfile is locatedon the main dataareacoded
D3 (UNIT-D3).

r

The page/card
count and the form/cardtype are included
in the spooltime messages
that areenteredin the system
h i s t o r ya r e a( M - Y E S ) .

o The consolecannotbe sharedas a systeminput device
a m o n gp a r t i t i o n s( S H A R E - N O ) .
o All l-type messages
on the systemconsoleat end of job
w i l l b e d e l e t e d( R E T A I N - N O ) .
o Message
a sr en o t d i s p l a y e o
d n t h e c o n s o l ew h i l e E N T E R
R E A D E RD A T A o r E N T E RD A T A a r ep r o m p t e do n
t h e c o n s o l e( M E S S A G
E-NO).
o The priority of the partitionsand spool is asfollows:
p a r t i t i o n1 ( P ' l) h a st h e h i g h e spt r i o r i t y ,p a r t i t i o n2
( P 2 ) ,p a r t i t i o n3 ( P 3 ) ,a n dS P O O L( S P )a l t h a v ee q u a l
priority.
o T h e s y s t e mw i l l i n v o k e$ H A C C P( H A L T - C C P A U T O )
when 1 track remainsin the systemhistoryarea
( T R A C K S - 1b) e f o r eu n p r i n t e de n t r i e sa r eo v e r l a i d .
Figure 4-14,2. Change Console Sharing as System Input Device,
System Messages,System Task Priority, and SHA
Halt Status

T h e m a i ns t o r a g e
s i z eo f t h e s y s t e mi s 5 1 2 K ( S Y S . 5 1 2; )
p a r t i t i o n1 s i z ei s 1 9 6 K ( P 1 - 1 9 6 )f;i l e s h a r ea r e as i z ei s
4K (FS-4); partition3 sizeis zero(P3-0). Partition2 is
not specifiedand remainsunchanged.
The SHA warningmessage
is issuedand the systemhalts
(if the systemis in halt SHA mode)when 2 tracksremain in the systemhistoryareabeforeunprintedentries
areoverlaid.
Figure 4-14.1. Change Spooling Status, OCOPV Optiom, System
and Partition Sizes,and SHA Warning Point

Configuration Record Program-$CNFIG

4-26.1

T h i s p a g ei n t e n t i o n a l l yl e f t b l a n k .

4-26.2

Copy/DumpProgram-$COPY

COPYPACK

P R O G R A MD E S C R I P T I O N

T h e C O p y p A C Kf u n c t i o nc o p i e st h e c o n t e n t so f a m a i n
dataareato anothermain dataareaor copiesa simulation
areato anothersimulationarea.

The copy/dumpprogramhasthe followingfunctions:
o C o p ya n e n t i r em a i nd a t aa r e ao r s i m u l a t i o na r e a

COPYFILE
o Copy a datafile
T h e C O P Y FI L E f u n c t i o n s :
o C o p ya n d p r i n t a d a t af i l e
o C o p ya d a t af i l e , b u t p r i n t o n l y a p a r t o f t h e f i l e
o Print an entiredatafile
o Print only a part of a data file
o Print and copy a part of a data file

o P r o c e sas s i n g l ei n p u t f i l e a n dw r i t e a s i n g l eo u t p u tf i l e
i n o n ee x e c u t i o no f t h e p r o g r a m .
o C o p y a f i l e f r o m a s i m u l a t i o n o r m a i n d a t a a r e at o
a n o t h e r s i m u l a t i o n o r m a i n d a t a a r e a . S e q u e n t i a lf i l e s
can be copied consecutivelyand an index created, thus
e f f e c t i v e l yc o p y i n g a s e q u e n t i a fl i l e t o a n i n d e x e d f i l e .
A l s o , a s e q u e n t i a fl i l e c a n b e c o p i e d a n d a d i r e c t f i l e
created.

o B u i l d a n i n d e x e d f i l e f r o m a s e q u e n t i a fl i l e
o Copv a f ile to or from magnetic tape, cards, or diskette.
o B u i l d a d i r e c t f i l e f r o m a s e q u e n t i a fl i l e
o
.

R e c o v e ra f i l e

P r i n t a l l o r p a r t o f a f i l e w h e t h e r i t i s b e i n gc o p i e d t o
a n o t h e rf i l e o r n o t .

This programperformsonly one function duringone execution.

o Print and/orcopy selectedrecordsfrom a file basedon
eitherthe relativerecordnumberor a key value.

The input file must be describedin an OCL FILE statement
exceptwhenthe file recoveryfunction is used. The name
t h a t y o u s u p p l yw i t h t h e N A M E k e y w o r di n t h e F I L E
s t a t e m e nm
t u s tb e C O P Y I N( N A M E - C O P Y I N )L. i k e w i s e ,
the output file (exceptprinteroutput) must be described
i n a n O C L F I L E s t a t e m e n tT
. h e n a m et h a t y o u s u p p l y
with the NAME keywordmust be COPYO(NAME-COPYO).
T h e o u t p u tf i l e f o r t h e I B M 1 4 0 3P r i n t e rd o e sn o t r e q u i r e
a n O C L F I L E s t a t e m e n tH
. o w e v e ri,f t h e o u t p u t i s p r i n t e d
o n a n I B M 3 2 8 4 P r i n t e ry, o u m u s ts u p p l ya n O C L F I L E
s t a t e m e n tT. h e n a m eo f t h e f i l e m u s tb e C O P Y P{ N A M E COPYP}.

.

Recovera file by usingthe physicaladdressobtained
from the VTOC listing.

o C o p Va f i l e a n dc h a n g et h e o u t p u tf i l e r e c o r dl e n g t h .

Copy/DumpProgram*$COPY

4-27

The selectionof input and output deviceis asfollows:

Output
D i s kF i l e
Input

Tape

seq. I n d . D i r .

Fil;o

C a r dF i l e
M F C U l M F C U 2 M F C M l M F C M 2 1442

Diskette
File

PrinterFile
(1403,3284)

D i s kF i l e
Sequential

X

I ndexed

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

1

X

X

X

X

X

X

X

otrect@

TapeFlteO

X

X

X

X@

X

X

X

X

X

DisketteFiteO

X

X

X

X

X

X

X

X

X

MFCUl

X

X

X

X

MFCU2

X

X

X

X

MFCMl

X

X

X

X

MFCM2

X

X

X

X

1442

X

X

X

X

X

X

X

X

2501

X

X

X

X

X

X

X

X

X

C a r dF i l e

X
X
X
X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

\7 Tapecan be 7- or 9-track;200,556, g00, or 1600 bpi.
/i

V'/ A directfile is considered
a sequential
file; therefore,the sequential
disk file

considerations
appty.

/l

\i/ The output tapefire must be on a differentdrivethan the input tapefire.
\!,/ Recordlengthcan be from 1 to 128 bytesbut must be the samefor
all recordsin the file.

CONTROL STATEMENT SUMMARY
The control statementsyou must supply depend on the desired results.

FunctionsO

ControlStrtr."ntrO

Copy an EntireArea

/ / C O P Y P A C KF R O M - c o d e , T O - c o d e [ . P A C K I N - p a c k n[ ,aPmAeC] K O - p a c k n a m e ]
// END

Copy a Data File

// copyF,'.3U+;l+ 5l!l}
EoR"}:, }o
{
}{
{ff if]' },position,character,,R
{
[ ,L E N G T H - n u m b e r ]

// END
Copy and Print a
Data File

rr=
// copyF

{3U+:l+.}

rotr,

{ffi*lt

REoRG.y
ESO
}'position,character',

[,LENGTH-number]
// END
C o p ya D a t aF i l e ,
B u t P r i n tO n l y a
Partof the File

// copyF|,-r 3UI;l+. rotr, 3 ;,t"* -}'position,character"
REoRG-yESo
{
}
{
-l
[,LENGTH-number]

//sELECT
{5il} {i5il;:.'',}
LI:;i;l;.,] |::l:ru,?:,".'

//SELECT
RECORD,
T|5:YJJJ"'}[IRJil1H,.;I
Iff.:::J."'''-'
// END
P r i n ta n E n t i r e
D a t aF i l e

//coPYF,
" {3U+:l+.}
",*'
// END

P r i n tO n l y a P a r t
o f a D a t aF i l e

/t coPYFt'.
{!U]!l+.
}'*'*'

//sELEcr
{5iJ} {;3?H:.,'}
[H"ff];.,]
REcoRD.
// sELECT
{i|:y#J"'}[l:;illii,.]

O n l y o n eS E L E C T
statementfor
e a c hC O P Y F I L E
statement

// END

P r i n ta n d C o p y a
Partof a Data
File

// copyF,r.{!UIil+.t{
r,REoRG.yESl
' ||+ },.rr*.rr.nu,o",.rO
( enrrrrr)

//'ELECT
{llJ} {i8:x;:;''}F:;ff:;.,]
I $La,,a,eme
yES
REC'RD,
:il:l'lfoPYF'L
{i5:y#J'"'}[l:;il1ii0.,]''LE
:i'J.'
_.|
11
B u i l da n l n d e x e d
F i l ef r o m a
S e q u e n t i aFl i l e

copyF,'.{BU1;l+.
} { Bi* } r,LENGrH.numberl
K E Y L E N G T H - n u m b eLr .O C A T I O N - n u m b e r
END

Copy/DumpProgram-$COPY

4'29

Functions

Control Statements

B u i l da D i r e c t
F i l ef r o m a
S e q u e n t i aFl i l e

il copyF,l-,{BUTil+:}
,,..*o,*numberl
, r - r{5i::
( s o r H} )
// OUTDMDATAMGMT.DI
RECT
// END

File Recovery
from Physical
,r't
Address-Simulation
(aOTH)
Area
// AccEssFRoM-unit,cYLlNDER-number,sECToR-number,Dlsp-number,RECL-number

// copyF,"{3UI;l+:}
numberl
{!i:i },,|-,*o,r

// SELECT
RECORD,FROM-number,TO-number,Fl
LE-YES
// END
File Recovery
from Physical
Address- Main
Data Area

Changethe
O u t p u tF i l e
Record Length

F,..
// copy
r,LENGrH.numberl
{!U]!l+.'}({Bii!:
O T H})
// ACCESSFROM-unit,CYLlNDER-number,TRACK-number,SECTOR-number,DlSP-number,
RECL-number
/ / S E L E C TR E C O R D , F R O M - n u m b e r , T O - n u m bLeEr -, F
t S
yE
// END

copyF,,-'
number
{3UI|l+.} { BIT}'ENGrH
END

O

fh" programusesincludethe possiblecombinationsof copyingand printingfiles.

@ fo, eachuse,the programrequiresthe controlstatementsin the orderthey are listed: COpypACK, END;
C O P Y F I L EE, N D ;C O P Y F T L E , S E L E C T , ECNO
Dp; y F t L E , K E y , E N Da ;n dC O p y F t L E , S E L E C T , K E y , E N D .
O

Apptiesonly to indexedfiles. WhenOUTPUT-BOTHis specified,REORG-YESis required.

O

lef,f Cf H parameteris not valid if OUTPTX-PRINTor OUTPUT-PRINTis specified.

4-30

PARAMETER
SUMMARY
Description

Parameter
COPYPACKStatement
FROM-code

Locationof the areato be copied. Possiblecodesare R 1. F 1, R2, F2, and
thosefor the main data areas.

TO-code

codesare R'l, F1, R2,F2,
Locationof the areato containthe copy. Possible
and thosefor the maindataareas.

PACKIN-packname

Nameof the areato be copied,optionallyprovidedto checkfor pack lD.
Verify that correctpack is mounted.

PACKO-packname

Nameof output area,optionallyprovidedto checkfor pack lD. Verify that
correct pack is mounted.

C O P Y F I L ES t a t e m e n t
OUTPUT.FILE

Copy the file to the device(tape,cards,diskette,or disk) definedin the
C O P Y OF I L E s t a t e m e n t . O

OUTPUT.DISK

S a m ea sO U T P U T - F I L E( a l l o w e df o r M o d e l s1 0 a n d 1 2 c o m p a t i bi tfV l . O

OUTPUT.PRINT

Print the entiref ile or only part of tne tlte.O

O
OUTPUT.BOTH

Copy the file from one deviceto anotheror from one locationto another
Also print the entiref ile or only part of it.
locationon the samearea.O

(rte )

ourPrx
lS|][r[

values.
Printedoutput is to be displayedin hexadecimal

(eorH )

DELETE-'position,
character'
or
OMIT-'position,
character'

Theseparameters
areoptional. All recordswith the specifiedcharacterin
deletedrecords
the specifiedrecordpositionare deleted. DELETE causes
to be printed;DELETE cannotbe usedwith direct files. lf OMIT is used,
deleterecordsare not printed. Positioncan be any position in the record
(the first positionis 1, second2, and so on). The maximumpositionis
65535.

REORG.NOO

lndexedfiles only. Copy recordsasorganizedin the originalfile (the file
from which the recordsare copied).

REORG.YESOO

the recordsso that the recordsin the data
Indexedfilesonly. Reorganize
portion of the file are in the sameorder astheir keysare listedin the index.

LENGTH-number

Usedto specifythe lengthof the output file record(s).Lengthvaluemay be
any numberfrom 1 through65535.

Copy/DumpProgram-$COPY

4-31

Parameter

Description

SELECTStatement
{5.!I}.t*oM-,kev,
(l'KY,

I n d e x e df i l e so n l y . P r i n to r c o p y o n l y t h e p a r t o f t h e f i t e f r o m t h e r e c o r d
k e yt h a t i ss p e c i f i e d
i n t h e F R O M p a r a m e t et ro t h e e n d o f t h e f i l e .

KEYl
I
rn-,uo,,,
IPKY,

I n d e x e df i l e so n l y . P r i n to r c o p y o n l y t h a t p a r t o f t h e f i l e f r o m t h e f i r s t r e c o r d
keyto the keyspecified
in theTO parameter.
I n d e x e df i l e so n l y . P r i n to r c o p y o n l y t h e p a r to f t h e f i l e b e t w e e nt h e t w o

(PKY''ro;..v;''
l;:'J.li,.T,*ili:.'rr"lHi#:.:lii:H?ff.;HJn:H*:l:

{5.5J}.trgM-,kev,

the FROM and TO recordkeysthe same.
RECORD,FROMnumber

P r i n to r c o p y o n l y t h e p a r t o f t h e f i l e f r o m t h e r e l a t i v er e c o r dn u m b e rs p e c i f i e d
in the FROM parameterto the end of the file.

RECORD,TO-number

P r i n to r c o p y o n l y t h a t p a r t o f t h e f i l e f r o m t h e f i r s t r e c o r dt o t h e r e l a t i v er e c o r d
n u m b e rs p e c i f i e d
in theTO parameter.

RECOiD,FROMnumber,TO-number

P r i n to r c o p y o n l y t h e p a r t o f t h e f i l e b e t w e e nt h e r e l a t i v er e c o r dn u m b e r s
indicatedby the parameters
{includingthe recordsindicatedby the parameter).
To print only one record,the FROM and TO relativerecordnumbersshould
be the same.

FILE-YES

Only selectedrecordsarecopiedto the files namedin the COPYOFILE
statement.

FILE-NO

O n l y s e l e c t e rde c o r d sa r ep r i n t e d . l f c o p y i n ga, l l r e c o r d sa r ec o p i e d .
O U T P U T - P R I N oTr O U T P U T - B O T H
m u s tb e s p e c i f i e di f F I L E - N Oi s
specified.lf OUTPUT-PRINTis specified,selectedrecordsare printed.
lf OUTPUT-BOTHis specified,selectedrecordsare printedand the entire
f i l e i s c o p i e dt o t h e f i l e n a m e di n t h e C O P Y OF I L E s t a t e m e n t W
. h e na K E y
statementis used,the output will be an indexedfile if the deviceon the
COPYOF I LE statementis a main dataarea.

KEY Statement

4-32

LENGTH-number

l d e n t i f i e tsh e l e n g t ho f t h e k e y f i e l d . K e y l e n g t hm a y b e 1 _ 2 9 .

LOCATION-number

T h e s t a r t i n gl o c a t i o ni n t h e i n p u t r e c o r df r o m w h i c ht h e k e y f i e l d i s t o b e e x t r a c t e d
L o c a t i o nm a v b e f r o m 1 t o 6 5 5 3 5 .

Parameter

Description

OUTDM Statement
DATAMGMT-DlREcr

Specifiesthar the output file is to be a directfile.

ACCESSStatement
FROM-unit

Specifiesthe simulationareaor main dataareathat containsthe file to be
recovered.

CYLINDER'number

l d e n t i f i e tsh e c y l i n d e rn u m b e r( 1 - 2 0 2 1
for the beginnino
gf the file. Fora
simulationarrea,
the numberis the quotientobtainedby dividingthe file
location(frornthe $LABEL VTOC printout) by 2. For a maindataarea,
the numberi:igivenin the file location.

SECTOR-number

For a simulationarea,the numbercan be 0-47. For a main dataarea,the
numbercan be 1-48.

DISP-number

Specifies
the displacement,
in bytes,from the start of a sectorto the beginning
of a recordin the samesector. Numbercan be 0-255.

TRACK-number

For a main dataarea. This numbercan be G19.

RECL-number

Recordlengtlrof file to be recovered.

you indicatewhich file is to be copiedor plinted. For files beingcopied,you must
@ tn tfre OCL loadsequence,
alsoindicatewhetherthe file is beingcopiedfrom one deviceto anotheror from one locationto anotheron the
samearea,usingthe COPYINand COPYOFIL.Estatements.
@ neOnC-NO is assumedif you omit the REORIGparameter.WhenOUTPUT-BOTHis usedfor indexedfiles,
REORG-YES
isrequired.
/i

\9

lf message
UC3CCSoccurs,indicatingthat thereis not enoughmain storageavailable
to executethe job, consider
the following:
o l f y o u h a v eO U T P U T - B O T Hc,h a n g et o O U T P U T - D I S K
or OUTPUT-FlLE.
o l f y o u h a v eR E O R G - Y E Sc,h a n g et o R E O R G - N O .
o Set a largerpartitionsizeif possible.

Copy/DumpProgram-$COPY

4-33

PARAMETERDESCRIPTIONS

(COPYPACK)
PACKIN and PACKOParameters

(COPYPACKI
FROM and TO Parameters

fhese two optionalparameters
areusedif you want tne
systemto checkthe volumelabelof the areas.Eitherone
or both may be specified.They areusefulif you want to
verify that the correctarea(s)are beingused.

The FROM and TO parameters
areusedwhen the copy/
dump programis copyingthe entirecontentsof one areato
another. They indicatethe locationsof the two areas.
The FROM parameter(FROM-code)indicatesthe location
of the areayou arecopying. The TO parameter(TO-code)
indicatesthe locationof the areathat is to containthe
copy. The F ROM and TO codesmust be for the sametype
o f a r e a{ s i m u l a t i o o
n r m a i nd a t a } . Y o u c a n n o tc o p y a
simulation
a r e af r o m o r t o a m a i nd a t aa r e a .
P o s s i b lceo d e sa r e R l , F 1 , R 2 , F 2 , a n dt h o s ef o r t h e m a i n
d a t aa r e a sl D 1 , D 2 , D 3 o r D 3 1 , D 3 2 , D 3 3 , D 3 4 , D 4 o r D 4 1 .
D42, D43, D44l'.

CopyingEntire Area
Whencopyingan area,the copy/dumpprogramtransfers
the contentsof the areato anotherarea. The contentsof
the two areaswill be the same,exceptfor the volumelabels
a n da l t e r n a t e
t r a c ki n f o r m a t i o nw. h i c hm a y b e d i f f e r e n t .

COPYPACKConsiderations
The followingconsiderations
apply when you usethe
COPYPACKstatement:
o l f y o u a r ec o p y i n gf i l e sf r o m a m a i nd a t aa r e ao n a 3 3 4 4
to a main dataareaon a 3340, an lS message
occursif
f i l e sa r ea l l o c a t e d
o n c y l i n d e r s1 6 7 - 1 8 6 o f t h e 3 3 4 4 .
O n l y c y l i n d e r s0 - 1 6 6 a r ec o p i e dt o t h e 3 3 4 0 .
o l f y o u a r ec o p y i n gf i l e sf r o m a m a i nd a t aa r e ao n a 3 3 4 0
t o a m a i nd a t aa r e ao n a 3 3 4 4 ,o n l y c y l i n d e r s0 - 1 6 6 a r e
copied to the 3344.
o $COPYcannotcopy an areathat hasactivefiles unless
they arefiles beingaccessed
for input only.

OUTPUTParameter(COPYFILE)
T h e a r e ay o u a r ec o p y i n gc a nc o n t a i nl i b r a r i e o
s r d a t af i l e s
or both. The areathat is to containthe copy must not
c o n t a i nl i b r a r i e st ,e m p o r a r yd a t af i l e s ,o r p e r m a n e ndt a t a
files.
U n t i l t h e c o n t e n t so f t h e a r e aa r ec o m p l e t e l yc o p i e d ,
portionsof the new areaarechangedto preventaccidental
u s a g eo f a p a r t i a l l yf i l l e da r e a .T h e r e f o r ei ,f t h e c o p y i n g
p r o c e siss s t o p p e db e f o r ei t i s c o m p l e t e dt ,h e a r e ai s u n usable.You can restartthe copyingprocessby reloading
the copy/dumpprogram,or you can restorethe areaby
r ei ni t i a l i zi n g .
After a successful
copy, the copy programprintsa message:
C O P Y P A C KI S C O M P L E T E
N o t e : l f y o u c o p y a s i m u l a t i o na r e ac o n t a i n i n g
anactive
c h e c k p o i n t ,h a t c h e c k p o i nw
t i l l e x i s to n b o t h t h e F R O M
and TO simulationareas.Whenone of the two activecheckpointsis utilizedto restartthe checkpointedprogram,care
must be taken to ensurethat the iob is not restarteda
s e c o n dt i m e . l t i s r e c o m m e n d et dh a t y o u p e r f o r ma n I P L
a n d l o a d R e s t a r (t $ $ R S T R f) r o m t h e p a c kc o n t a i n i n g
the
secondactivecheckpoint. lf you then selectthe controlled
canceloption when the Hbnn message
occurs(nn is the last
requested
checkpointnumber),the checkpointwill be
deactivated.

4-34

The OUTPUTparameteris usedwhen the programis copyi n ga n d p r i n t i n gc a r d ,t a p e ,d i s k e t t eo, r d i s kd a t af i l e s . l t
indicateswhetheryou want the programto copy, print, or
copy and print a file. The OUTPTXparametercan be used
t o d i s p l a yp r i n t e do u t p u t i n h e x a d e c i m a
va
l lues.
T h e p a r a m e t eOr U T P U T - D I S K
o r O U T P U T - F I L Ei s u s e dt o
c o p y t h e f i l e ; O U T P U T - P R I N iTs u s e dt o p r i n t t h e f i l e ; a n d
OUTPUT-BOTHis usedto copy and print the file.

Copying Files

Printing Files

The copy/dump program can copy a file from one device to
another. These devicescan be disk, tape, card, or diskette.
The copy/dump program can also copy a file from one locat i o n t o a n o t h e r l o c a t i o n o n t h e s a m ev o l u m e .

The program can print all or part of a data file. To print
only part, the program needsa SELECT control statement.
(Seethe description of the SELECT control statement

T h e O C L l o a d s e q u e n c ef o r t h e c o p y / d u m p p r o g r a m i n d i c a t e s( 1 ) t h e n a m e a n d l o c a t i o n o f t h e f i l e b e i n g c o p i e d , a n d
(2) the name and location of the copy being created. (See
OCL Considerationsin this section.)
In copying a file. the program can omit records. (Seethe
d e s c r i p t i o no f t h e D E L E T E p a r a m e t e r f o r m o r e i n f o r m a tion.)
I n c o p y i n g a n i n d e x e df i l e , t h e p r o g r a m c a n r e o r g a n i z e
records in the data portion such that they are in the same
order as their keys are listed in the index. (Seethe descript i o n o f t h e R E O R G p a r a m e t e rf o r m o r e i n f o r m a t i o n . )

p a r a m e t e r si n t h i s s e c t i o n . ) l f y o u d o n o t u s e a S E L E C T
statement, the entire f ile is printed.
l f t h e o u t p u t i s t o b e p r i n t e d o n t h e 3 2 8 4 P r i n t e r ,a
COpYp FILE statement must be entered. lf the Copyp
FILE statement is not entered, the output will be printed
on the 1403 Printer.
l f y o u u s e S E L E C T K E Y ( P K Y ) , o r R E O R G - Y E S ,r e c o r d s
f r o m i n d e x e df i l e s a r e p r i n t e d i n t h e o r d e r t h e i r k e y s a p p e a r
i n t h e i n d e x p o r t i o n o f t h e f i l e ; o t h e r w i s e ,t h e y a r e p r i n t e d
a s t h e y a p p e a ri n t h e f i l e . F o r e a c h r e c o r d ,t h e p r o g r a m
prints the record key followed by the contents of the
record.

I n c o p y i n g a n i n d e x e df i l e , t h e c o p y / d u m p p r o g r a m w i l l :

R e c o r d sf r o m s e q u e n t i a a
l nd direct filesareprinted in the
o r d e r t h e y a p p e a ri n t h e f i l e . F o r e a c h r e c o r d ,t h e p r o g r a m
prints the relative record number followed by the contents

r

of the record.

CopV the data and the entire index intact if you supply
o n l y t h e C O P Y F I L E c o n t r o l s t a t e m e n ta n d o n l y t h e
p a r a m e t e rO U T P U T - D I S K o r O U T P U T - F l L E .

o CopY the data and create a new index if you supply
m o r e t h a n o n e c o n t r o l s t a t e m e n t( C O P Y F I L E m u s t b e
i n c l u d e da n d R E O R G - N O s p e c i f i e do r a s s u m e d ) .
o Copv the data and create a new index if you supply only
t h e C O P Y F I L E c o n t r o l s t a t e m e n ta n d t h e f o l l o w i n g

p a r a m e t eO
r sU: T P U T - D IoSrK
OUTPUT-FlLE,
c a nb es u p p l i eodr a s s u m e d
R E O R G - N(O
a )n,do n eo r
m o r e p a r a m e t e r st h a t a r e a p p l i c a b l et o t h e C O P Y F I L E
statement.
lf you suspectthat a problem exists with an index and the
p r o b l e m c a n b e c o r r e c t e db y t h e C O P Y F I L E c o n t r o l
statement, you should code the control statement(s)so that
the desiredfunction is performed.

T h e p r o g r a m u s e sa s m a n y l i n e sa s i t n e e d st o p r i n t t h e
contents of a record. Appendix A lists the hexadecimal
representationfor charactersin the standard character set.
T h e f o l l o w i n g i s a n e x a m p l eo f t h e w a y t h e p r o g r a m p r i n t s
hexadeciman
l u m b e r su s i n gO U T P T X :
ABCDE

GH I J 1,2345

C C C C C B C C C DFFF F F 4 4 4 4 4 4 4
1,23456l B9112345OOO0OOO
The hexadecimal number 86 representsa character that has
no print symbol.
A f t e r p r i n t i n g t h e l a s t r e c o r d ,t h e p r i n t e r t r i p l e s p a c e sa n d
prints the following message:
( n u m b e r )R E C O R D SP R I N T E D

Copy/DumpProgram-$COPY

4-35

D E L E T E P a r a m e t e r( C O P Y FI L E )

L E N G T H P a r a m e t e r( C O P Y F IL E I

I n c o p y i n g a d a t a f i l e , t h e c o p y / d u m p p r o g r a mc a n o m r t
r e c o r d so f o n e t y p e . T h e D E L E T E p a r a m e t e ri d e n t i fi e s t h e

This parameter is used to specify the length of the output
r e c o r d sw h e n a f i l e i s c o p i e d o r t h e f i l e t y p e i s c h a n g e d .

t y p e o f r e c o r d . U s e o f t h e D E L E T E p a r a m e t e ri s o p t i o n a l .
l f y o u d o n o t u s e i t , n o r e c o r d sa r e d e l e t e d . D E L E T E c a n n o t b e u s e dw i t h d i r e c t f i l e s .

T h e r e s u l t i n gr e c o r d sw i l l c o n t a i n b l a n k s o r b e t r u n c a t e d o n
t h e r i g h t . T h i s p a r a m e t e rc a n n o t b e s p e c i f i e di f t h e o u t p u t
is only printed.

T h e f o r m o f t h e p a r a m e t e ri s D E L E T E - , p o s i t i o n , c h a r a c t e r , .
Position is the position of the character in the recoros.
Character is the character, except for apostrophes,blanks,
o r c o m m a s ,t h a t i d e n t i fi e s t h e r e c o r d . F o r e x a m p l e ,w i t h
r E L E T E - ' 1 0 0 , R ' a l lr e c o r d sw i t h a n R i n
the parameteD
p o s i t i o n 1 0 0 a r e d e l e t e d . B y s p e c i f y i n gt h e h e x a d e c i m a l
c o d e f o r t h e c h a r a c t e r ,y o u c a n u s e a n y c h a r a c t e r( i n c l u d i n g
a p o s t r o p h e sb, l a n k s ,c o m m a s ,a n d p a c k e d d a t a ) t o i d e n t i f y
t h e r e c o r d st o b e d e l e t e d . F o r e x a m p l e ,w i t h t h e p a r a m e t e r
D E L E T E ' 1 0 0 , X 4 0 ' ,a l l r e c o r d sw i t h a b l a n k ( h e x a d e c i m a l
4 0 ) i n p o s i t i o n1 0 0 a r e d e l e t e d .
D e l e t e dr e c o r d sa r e a l w a y sp r i n t e d . l f y o u a r e b o t h c o p y i n g a n d p r i n t i n g a d a t a f i l e , d e l e t e dr e c o r d sa r e p r i n t e d w i t h
t h e o t h e r r e c o r d st h a t a r e p r i n t e d . T h e d e l e t e dr e c o r d sa r e
p r e c e d e db y t h e r v o r d D E L E T E D .
T h e O M I T k e y w o r d c a n b e u s e d i n s t e a do f D E L E T E . T h e
d e l e t e dr e c o r d sa r e n o t p r i n t e d i f O M I T i s u s e d .

KEY and PKY Parameters(SELECT)
T h e S E L E C T K E Y a n d S E L E C T P K Y p a r a m e t e r sa p p l y t o
s e l e c t i n gp a r t o f a n i n d e x e d f i l e . T h e S E L E C T P K Y p a r a m e t e r a p p l i e st o s e l e c t i n gp a r t o f a n i n d e x e d f i l e t h a t c o n t a i n s
p a c k e d k e y s . T h e p a r a m e t e r sa r e F R O M a n d T O .
T h e F R O M p a r a m e t e r( F R O M ' k e y ' ) g i v e st h e k e y o f t h e
first record to be selected. The TO parameter (TO-'key')
givesthe key of the last record to be selected. The record
k e y s b e t w e e nt h o s e t w o i n t h e f i l e i n d e x i d e n t i f y t h e
r e m a i n i n gr e c o r d st o b e s e l e c t e d . l f y o u w a n t t o s e l e c to n l y
t h e o n e r e c o r d ,u s e t h e s a m e r e c o r d k e y i n b o t h t h e F R O M
and TO parameters.
F o r e x a m p l e ,t h e p a r a m e t e r sF R O M - ' 0 0 0 1 0 0 ' a n d
T O - ' 0 0 0 1 9 9 ' m e a n t h a t r e c o r d si d e n t i f i e d b y k e y s 0 0 0 1 0 0
through 0001 99 are to be selected.

T h e r e c o r d sa r e d e l e t e do n l y f r o m t h e c o p i e d f i l e . T h e
o r i g i n a lf i l e i s n o t a f f e c t e d .

l f t h e f i l e i n d e x d o e s n o t c o n t a i n t h e k e y y o u i n d i c a t ei n a
F R O M p a r a m e t e r ,t h e p r o g r a m u s e st h e n e x t h i g h e r k e y i n
the index.

) a r a m e t e r( C O P Y F I L E )
R E O R G ( R e o r g a n i z eP

l f t h e k e y i n t h e F R O M p a r a m e t e ri s h i g h e r t h a n t h e h i g h e s t
k e y i n t h e i n d e x e d f i l e , t h e h i g h e s tk e y a n d r e c o r d i n t h e
file will be printed (print"onlyfunction). For example,

I n c o p y i n g a n i n d e x e d f i l e , t h e p r o g r a mc a n r e o r g a n i z et h e
f i l e s o t h a t t h e r e c o r d si n t h e d a t a p o r t i o n a r e i n t h e s a m e
o r d e ra s t h e i r k e y s i n t h e f i l e i n d e x . T h e R E O R G p a r a m e t e r i n d i c a t e sw h e t h e r t h e f i l e s h o u l d b e r e o r g a n i z e d .l f y o u
w a r r t a f i l e r e o r g a n i z e du, s e R E O R G - Y E S . O t h e r w i s e ,u s e
R E O R G ' N O . R E O R G N O i s a s s u m e di f v o u o m i t t h e
parameter.
l f R E O R G Y E S i s s p e c i f i e dt,h e r e o r g a n i z a t i oanp p l i e st o
t h e c o p y o f t h e f i l e r a t h e r t h a n t h e o r i g i n a lf i l e . T h e
o r i g i n a lf i l e i s n o t a f f e c t e d .
R e o r g a n i z a t i o n( R E O R G Y E S ) i s r e q u i r e dw h e n y o u a r e
b o t h c o p y i n ga n d p r i n t i n ga n i n d e x e df i l e ( O U T P U T - B O T H ) .

4-36

a s s u m et h e f o l l o w i n g s t a t e m e n t :
// SELECT KEY,FROM"'7OOO"TO-'7OOO'
l f t h e h i g h e s tk e y i n t h e i n d e x e d f i l e i s 6 9 5 5 , t h e n r e c o r d
6955 is printed.
lf the TO parameter is omitted, the program assumesthat
the lastkey in the index is the TO key.
l f t h e F R O M p a r a m e t e ri s o m i t t e d , t h e p r o g r a m a s s u m e s
that the first recordkey is the FROM key.

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued 28 September 1979
By TNL: GN21-5674

You can usefewercharacters
in the FROM or TO parameter
than arecontainedin the actualkeys;when keysarepacked,
however,you must usethe samenumberof characters
as
containedin the actualkeys. lf you usefewercharacters,
the programignoresthe remainingcharacters
in the record
key. The numberof characters
usedin the FROM and TO
parameters
neednot be the san:e.
For example,assumethat the followingareconsecutive
r e c o r dk e y si n a n i n d e x : A 1 0 0 0 ,A 1 1 1 9 , A 1 2 7 5 ,A l g 0 0 ,
4 1 9 9 5 , A 2 O 7 5a, n d 9 9 9 9 9 . T h e p a r a m e t e rFsR O M - ' A I '
a n dT O - ' A 1 9 9 ' r e f etro r e c o r dk e y sA 1 0 0 0t h r o u g hA 1 g g b .

Duringa singleexecutionof $COPY,the recordsof an
i n d e x e df i l e c a n n o tb e b o t h r e o r g a n i z e(dR E O R G )a n d
selectedby relativerecordnumber(SELECT).
F I L E P a r a m e t e(rS E L E C T I
This parameterallowsonly selectedrecordsto be copiedto
a d i s k ,t a p e ,c a r d sd, i s k e t t eo, r p r i n t e r .

(KEY)
LENGTHand LOCATION Parameters

For example,assumethat four consecutive
recordkeysin
a n i n d e xb e g i nw i t h t h e s ec h a r a c t e r sA: 1 , A 2 , A 8 , a n d 8 1 .
T h e p a r a m e t e rFsR O M - ' A 3 ' a n dT O - ' A 9 ' r e f e rt o k e y s
beginningwith the characters
A8.

The KEY statementis usedwhen the programis to build an
i n d e x e df i l e f r o m a s e q u e n t i af ill e . T h e L E N G T Hp a r a m e t e rs p e c i f i etsh e l e n g t h( 1 - 2 9 ) o f t h e k e y f i e l d . T h e
LOCATIONparameterspecifies
the startinglocation
( 1 - 6 5 5 3 5 )o f t h e k e y f i e l d i n t h e i n p u t r e c o r d .W h e nt h e
KEY statementis used,the file describedin the COPYO
F I L E s t a t e m e nm
t u s t b e a d i s kf i l e a n d O U T P U T - D l S K ,
m u s tb e s p e c i f i e idn t h e
O U T P U T - F l L Eo, r O U T P U T - B O T H
C O P Y FI L E c o n t r o ls t a t e m e n tA
. $ l N D E X 4 5o r $ l N D E X 4 0
w o r k f i l e c a nb e i n c l u d e di f t h e K E Y s t a t e m e nits u s e d .

(SELECTI
RECORDParameters

DATAMGMT Parameter(OUTDM)

T h e S E L E C TR E C O R Dp a r a m e t e rcsa na p p l yt o a n y f i l e
b u t a r en o r m a l l yu s e df o r s e q u e n t i aaln dd i r e c tf i l e s . T h e s e
parameters
userelativerecordnumbersto identify the
recordsto be selected.

T h i sp a r a m e t ear l l o w st h e c r e a t i o no f a d i r e c tf i l e ( d i s k )
f r o m s e q u e n t i ai nl p u t ( c a r d t, a p e ,d i s k .d i s k e t t e ) .

l f n o n eo f t h e k e y si n t h e f i l e i n d e xb e g i nw i t h t h e c h a r a c t e r sy o u i n d i c a t ei n a F R O Mp a r a m e t e trh, e p r o g r a mu s e s
the key beginningwith the next highercharacters
in the
F R O Mp a r a m e t e r .

FROM Parameter(ACCESS)
Relativerecordnumbersidentify a record'slocationwith
respectto other recordsin the file. The relativerecord
numberof the first recordis 1, the numberof the second
r e c o r di s 2 , a n d s o o n .
T h e S E L E C TR E C O R Dp a r a m e t e rasr eF R O Ma n dT O .
T h e F R O Mp a r a m e t e(rF R O M - n u m b egr )i v e st h e r e l a t i v e
recordnumberof the f irst recordto be selected.The TO
parameter(TO-number)givesthe numberof the last record
to be selected.Recordsbetweenthosetwo recordsin the
f i l e a r ea l s os e l e c t e d .
F o r e x a m p l et,h e p a r a m e t e rFsR O M - 1a n dT O - 3 0m e a n
t h a t t h e f i r s t 3 0 r e c o r d s( i - 3 0 ) i n t h e f i l e w i l l b e s e l e c t e d .
lf the TO parameteris omitted,the programassumes
that
t h e n u m b e ro f t h e l a s tr e c o r di n t h e f i l e i s t h e T O n u m b e r .
l f t h e F R O Mp a r a m e t ei rs o m i t t e d ,t h e p r o g r a ma s s u m e s
t h a t t h e f i r s t r e c o r di n t h e f i l e i s t h e F R O Mn u m b e r . l f y o u
want to selectonly one record,usethe samenumberin the
F R O Ma n dT O p a r a m e t e r s .
s ,R O Ma n dT O , a r er e q u i r e dw h e nt h e
B o t hp a r a m e t e r F
ACCESSstatementis specified.

T h i sp a r a m e t eird e n t i ife st h e a r e a( s i m u l a t i o on r m a i nd a t a )
that containsthe file to be recovered.Possible
unit codes
a r eR 1 , F 1 , R 2 , F 2 . a n dt h o s ef o r t h e m a i nd a t aa r e a s .

CYLINDER Parameter(ACCESS)
T h ec y l i n d e rn u m b e rs p e c iife d i n t h i s p a r a m e t ei rn d i c a t e s
the startinglocationof the f ile. For a simulationarea,the
numbercan be 1-2O2 andis the quotientobtainedby dividi n gt h e f i l e l o c a t i o n rb y 2 . F o r a m a i nd a t aa r e a t, h e
n u m b e rc a n b e 1 - 1 6 6 ( 1 8 6 f o r 3 4 4 4 1a n d i s i n d i c a t e db y t h e
f i l e l o c a t i o n.r

SECTORParameter(ACCESSI
This parameterspecifiesthe sectorthat containsthe f irst
recordto be copied(recovered).For a simulationarea,the
n u m b e rc a n b e 0 - 4 7 . F o r a m a i nd a t aa r e a t. h e n u m b e r
can be 1-48.
'File location
is obtained from the $LABEL printout of the VTOC

Copy/DumpProgram-$COPY

4'37

Pageof G C21-5162-1
lssued 28 September 1979
By TNL: GN21-5674

(ACCESS)
TRACK Parameter

MaintainingCorrect RelativeRecordNumbers

This parameteris usedfor a maindataarea. The number
c a nb e 0 - 1 9 a n d i s s p e c i f i e b
dy thefile locationr.

To maintaincorrectrelativerecordnumberswhencopying
onevolumeof a multivolumedirectfile, you must keepthe
sizeof the output volumethe sameasthe sizeof the input
volume. (lf you want to increase
the sizeof a file, you
mustcopy the entirefile.) lf you copy the f irst volumeof
a two-volumefile and increase
the numberof recordson
that volume,you arealsoincreasing
relativerecordnumbers
of all the recordson the next volume. Therefore,to maintain the correctrelativerecordnumbers,output and input
volumeextents(recordsor tracks)must be equalif you are
c o p y i n go n l y o n ev o l u m eo f a m u l t i v o l u m e
d i r e c tf i l e .

RECL Parameter(ACCESS)
This parameteridentifiesthe recordlengthof the data in
the file to be recovered.

DISPParameter(ACCESS)
This parameterspecifies
the displacement
from byte 0 of a
sectorto the first byte of a record. Displacement
is counted
in bytes from the first byte (byte 0) of the sector. Because
a sectorcontains256 bytes,the displacement
number
must be 0-255.

C O P Y I N GM U L T I V O L U M EF I L E S
W h e ny o u c o p y m u l t i v o l u m e
f i l e s ,t h e f i r s tv o l u m eo f t h e
i n p u tf i l e h a st o b e o n l i n ew h e nt h e j o b i s i n i t i a t e d .T h e
o u t p u tf i l e m u s tb e a n e w f i l e . l f e i t h e rc o n d i t i o ni s n o t
satisfied,
a message
occurs.

MaintainingProperVolumeSequence
Numbers
To maintainpropervolumesequence
numberswhencopyi n ga m u l t i v o l u m e
f i l e ,y o u m u s te i t h e rc o p y a l l t h e v o l u m e s
of the file in one run or copy only one volumefor eachrun
of $COPY. For example,if you copy a three-volume
file
o n ev o l u m ea t a t i m e ( v o l u m e1 i n t h e f i r s tr u n ,v o l u m e2 i n
t h e s e c o n dr u n , a n dv o l u m e3 i n t h e t h i r d r u n ) ,t h e v o l u m e s
will retaintheir originalsequence
numbersin the output
f i f e . O r i f y o u c o p y a l l t h e v o l u m e s1 1, 2 , a n d3 ) i n t h e
samerun, the volumesequence
numbersin the new file will
be the sameas in the originalfile. However,if you copy
onfy volumes2 and3 in one run, their volumesequence
n u m b e r sw i l l b e c h a n g e d
t o 1 a n d2 i n t h e o u t p u t f i l e .
$ C O P Ye n s u r etsh a t a l l v o l u m e so f a m u l t i v o l u m e
f i l eh a v e
t h e s a m ed a t ei n t h e f o l l o w i n gm a n n e r .l f o n l y o n ev o l u m e
of a multivolumefile is copiedfor eachrun of gCOpy, the
new file will assumethe samedateasthe input file. lf all
volumesor, as in the exampleabove,volumes2 and 3 of a
t h r e e - v o l u mf e
i l e a r ec o p i e di n a s i n g l er u n , t h e n e w f i l e
will assumethe currentpartitiondate.

'File

4-38

location is obtained f rom the $LABEL printout of the VTOC.

Direct File Attributes
l f y o u c o p y a n e n t i r em u l t i v o l u m e
d i r e c tf i l e i n o n e r u n ,
the output file will be givensequential
attributesin the
volumetableof contents(VTOC). However,this doesnot
affectfile processing.A file with eithersequentialor direct
attributescan be accessed
by a consecutive
or random
access
method. lf only one volumeis copied,the direct
a t t r i b u t ew i l l b e m a i n t a i n e d .

CopyingMultivolumeIndexedFiles
l f y o u w a n t t o c o p y a n i n d e x e dm u l t i v o l u m ef i l e , R E O R G Y E S m u s tb e s p e c i f i e d
i n t h e C O P Y F I L Es t a t e m e n tS
. ince
anunordered
l o a dt o a m u l t i v o l u m ei n d e x e df i l e i s n o t
permitted,a REORG-NOcauses
a systemmessage
to be
issued.lf you would prefernot to reorganize
the file it
must be copiedone volumeat a time. Whenyou arecopyi n go n ev o l u m ea t a t i m e ,t h e H I K E Y o n t h e o u t p u tv o l u m e
m u s tb e t h e s a m ea st h e H I K E Y o n t h e i n p u t v o l u m e . l f
they arenot equal,a systemmessage
occurs. Makingthe
HIKEYsthe sameensuresthat both the input and output
volumesarethe samelengthand no recordswill be lost.
W h e ny o u a r ec o p y i n go n ev o l u m eo f a m u l t i v o l u m e
i n d e x e df i l e ,e i t h e rB E O R G - Y E S
o r R E O R G - N Om a y b e
specified.

Pageot GC21-5'162-1
lssued
1979
28 September
B yT N L : G N 2 1 - 5 6 7 4
T A P EF I L E C O N S I D E R A T I O N S

D I S K E T T EF I L E C O N S I D E R A T I O N S

Whencopyingor printingtapedatafiles.you must describe
the tapefile beingcopiedor printedand describethe file
beingcreated.The varioustaperecordformatsand labels
aresupported.

Whencopyingor printingdiskettedatafiles,you must
describethe diskettefile beingcopiedor printedand the
file beingcreated. (SeeF/tF StatementIDevice lndependent Filesl .l

$COPYsupportssinglevolumetapef iles,multivolumetape
f i l e s ,a n d m u l t i f i l et a p ev o l u m e s .F o r a d e t a i l e dd e s c r i p t i o n
of the FILE statementparameters,
seethe appropriate
F I L E s t a t e m e ni tn P a r t1 o f t h i s m a n u a l .

The RECL parameteridentifiesthe recordlengthfor the
d i s k e t t ef i l e a n d i s a n y n u m b e rf r o m 1 t o 1 2 8 . l f t h i s
p a r a m e t e(rR E C L )i s n o t u s e d t, h e d e f a u l ti s 9 6 .

The tapefile can be ASCII or EBCDIC. Defaultfor record
f o r m a t ( R E C F M )i s f i x e d l e n g t h .O n a n o n l a b e l etda p e ,
r e c o r dl e n g t h( R E C L )a n d b l o c kl e n g t h( B L K L ) m u s tb e
specified.
$COPYwill not copy any datarecordsfrom a null file to
an unlabeledtape. Therefore,when filesareaddedto a
multifiletapeand a null file is detected,the sequence
numberfor the next file(s)addedto the tape is 1 lessthan
the valuespecified.SeeNull FilesOn Tapetor additional
information.
You must be carefulwhen copyinga tapefile with variable
lengthrecordsto disk or tape. The resultingfile will
containfixed lengthrecordswith a recordlengthequalto
the longestrecordlengthof the file copiedfrom. Records
copiedwith short recordlengthswill haveinvalidinformation in the unusedportion of the output record.

Whenthe 3741 is usedasan input or output device,the
numberspecifiedin the RECL parametermust be equalto
the recordlengthin the dataset labelon the disketteand
may be any numberfrom 1 through128.
Whenthe 3741 is usedfor output and the input is from
d i s k ,c a r d ,o r t a p e ,t h e n u m b e rs p e c i f i e d
in the RECL
parameter
can be any numberfrom 1 to 128 regardless
of
the recordlengthof the disk,card,or tapefile being
copied. However.if the recordlengthfrom disk,card,or
tapeis lessthan the recordlengthspecified,the remainder
of the recordis filled with blanks(X'40'). lf the record
lengthfrom disk.card,or tape is greaterthan the record
lengthspecifiedin the RECL parameter,
the recordis
truncatedon the right.
Note: The followingcard input considerations
alsoapply
for the3741.

Copy/DumpProgram-$COPY

4'39

C A R D I N P U TC O N S I D E R A T I O N S
F o r c a r di n p u t f i l e s ,e n d - o f - f i l ies d e t e r m i n e b
dy t h e p r e s enceof a cardwith /* in columns1 and2, and with the
r e m a i n i n cgo l u m n sb l a n k . T h i sa l l o w sa c a r di n p u tf i l e t o
c o n t a i n/ * c a r d sa. s s u m i ntgh a t a t l e a s to n ep u n c hi s i n
c o l u m n s3 - 8 0 o r 3 - 9 6 . A l & o r l . i s h a n d l e dt h e s a m ea sa
l* card,unlessthe input deviceis the systemreader.
The followingchartshowsthe resultsobtainedfrom having
a c a r dw i t h a 1 " , l & . o r / . i n c o l u m n s1 a n d 2 .

Input Device
Card
Not
Columns Partition Partition
1and2
Reader
Reader

Spooled

Not
Spooled

CardHas
Gomments

Card Does
Not Have
Comments

Card is processedas a data card
End of file occurs
Card is processedas a data card

X
X
X

End of file occurs
Card is processedas a data card
End of file occurs
Card is processedas a data card

X

X

/&

X

t&
l&
l&

/&
/&
t&
l&

X

End of file occurs
Card is acceptedas data but end
of f ile occurs (additional
data cards are not processed)

X

X

End of file occurs
Card is acceptedas data but end
o f f i l e o c c u r s( a d d i t i o n a l
data cards are not processed)

X

X

X

X
X

X

X
X

X

&ote.' Readingfrom the spoolreaderqueuethat is not the
partitionreaderis not recommended.

440

Results

End of file occurs
Card is acceptedas data card
End of file occurs
Card is acceptedas data card
End of file occurs
Card is acceptedas data but end
o f f i l e o c c u r s( a d d i t i o n a l
data cards are not processed)
End of file occurs
Card is acceptedas data but end
o f f i l e o c c u r s( a d d i t i o n a l
data cards are not processed)
End of file occurs
Card is acceptedas data card
End of file occurs
Card is acceptedas data card
End of file occurs

Pageof GC21-5162-1
lssued28 September1979
BvTNL: GN21-5674

C A R D O U T P U TC O N S I D E R A T I O N S

OCLCONSIDERATIONS

lf the input recordsize(in bytes)is greaterthan the sizeof
the card (80 or 96 columns),the input recordwill be
truncated.Only the first 80 or 96 positionsof the record
will be punched. lf the input recordsizeis lessthan the
sizeof the card,the unusedpart of the cardwill contain
blanks. lf the input f ile contains60-byterecords,the card
w i l l b e b l a n ki n c o l u m n s6 1 - 8 0 o r 6 1 - 9 6 . W i t h p u n c h e d
output, the entirecardcontainsuserdata;control information is not punched.

areneededto loadthe copy/
The followingOCL statements
dump program,if you areusingthe programto copy an
entirearea:

F IL E R E C O V E R YC O N S I D E R A T I O N S

are neededto do COPYFILE
The followingOCL statements
functions:

areusedto
The ACCESSand SELECT control statements
recoverindexed,direct,and sequentialfiles. lnformation
regarding
the recordcount, recordlength,file location,and
startof data (indexedfiles only) for eachfile to be recoveredis obtainedfrom the current VTOC printout. For
informationregardingthe VTOC printout. referto File and
Volume Label Display Program-$ LA 8E L.
record
The methodfor determiningthe first recoverable
l o c a t i o ni s g e n e r a l ltyr i a l a n de r r o r . Y o u s h o u l da l w a y s
attemptto recoverthe first recordof the file. lf unsuccess'
ful, proceedto the next record. Repeatthis procedure
recordis found.
until the first recoverable
Whenrecordsareaddedto a sequentialdisk file, the VTOC
i s u p d a t e d a t e n d o f j o b w i t h a n e w e n d - o f - f i l e p o li fn, t e r .
for somereason,the programaddingthe recordsis abnormally terminated,the VTOC is not updatedand the added
recordsare lost. However,you can usethe copy/dump
programto retrievethe addedrecordsasfollows:

// LOAD $COPY,code
// RUN
The codeyou supplydependson the locationof the simula'
tion areacontainingthe copy/dumpprogram.Possible
c o d e s a rRe 1 , F 1 , R 2 , F 2 .

ll LOAD $COPY,code
llF|LE NAME-COPYlN,parameters(requiredexcept
whenthe
ACCESSstatement is used)
ll FILENAME-COPYO,parameters(optional
statementl
// FILE NAME-COPYP,parameters(optional
statement)
// RUN
see
For informationon the FILE statementparameters.
in Part 1 of this manual.
OCL Statements
TheUNlTparameterisrequiredoneachenteredFlLE
statement.The allowableUNIT codesare:
FILE Statement
Unit Code

o Usethe ACCESScontrol statementto specifythe beginn i n go f t h e f i l e ,a n d
o Usethe SELECTcontrol statementto specifythe
n u m b e ro f r e c o r d si n t h e o r i g i n afl i l e p l u st h e n u m b e r
of addedrecords.
This procedurecausesthe originalrecordsplusthe retrieved
recordsto be copiedto a new file and a new VTOC entry
created.
N o t e : D o n o t i n c l u d ea F I L E s t a t e m e nwt i t h N A M E COPYINspecifiedwhen the ACCESSstatementis used.
For informationabout how to copy a file index or createa
new file index, refer to CopyingF/es under Copy/Dump
Program.

3741
MFCUl
MFCU2
MFCMl
MFCM2
1442
2501
1403
3284
R 1 ,F l , R 2 , F 2
D 1 , D 2 ,D 3 o r D 3 1
D32, D33, D34
D4 or D41
D42, D43, D44
T 1 , T 2 ,T 3 , T 4

COPYIN

COPYO

X
X
X
X
X
X
X

X
X
X
X
X
X

COPYP

X
X
X
X
X
X
X
X

X
X
X
X
X
X

luofe; Duringexecutionof $COPY,the 3741 or 1442 can'
both input and output.
not be assigned
Copy/DumpProgram-$COPY

441

EXAMPLES
Figures4-15 through4-2Oareexamplesof the OCL statementsand control statementsneededto copy an entire
a r e ac, o p y a f i l e f r o m o n e a r e at o a n o t h e ra r e a a
, n dp r i n t
part of a file.
Figures4-21 through 4-37 areexamplesof the OCL statementsand control statementsneededto:

Explanation:

o Copy a file from disk to tape

The copy/dumpprogramis loadedf rom F 1.

.

C o p ya f i l e f r o m t a p et o d i s k ,p r i n t i n gp a r t o f t h e f i l e

Figure 4-15. OCL Load Sequence for Copying an Entire Area

.

Copy a file from tapeto tape,selectingrecordsto be
copied

o Copy a cardfile to tape
o Copy a disk file to cards
o Copy a disk file to diskette
o Copy a tapefile to diskette,printingpart of the f ile
.

C o p ya n d p r i n t a p o r t i o no f a f i l e f r o m d i s k e t t et o d i s k

o C o p ya c a r df i l e t o a d i s k e t t ep, r i n t i n gt h e e n t i r ef i l e
o Copy and print a portion of a file from disketteto cards
r

Copy a cardfile to anothercardfile

o P r i n ta d i s kf i l e o n t h e 3 2 8 4
o Copy a cardfile to a disk file and changethe output
recordlength
r

B u i l da d i r e c td i s k f i l e f r o m s e q u e n t i at al p ei n p u t

o R e c o v ear d i s kf i l e f r o m a s i m u l a t i o n
area
o Recovera disk file from a main dataarea
o C o p ya s e q u e n t i af ill e f r o m a s i m u l a t i o na r e at o a m a i n
dataareaand createan indexedoutput file

442

Explanation:
The COPYPACKstatementcopiesthe contentsof simula_
t i o n a r e aF 2 ( F R O M - F 2 w
) i t t rv o l u m ei d e n t i f i c a t i o n
F 2 F 2 F 2( P A C K I N - F 2 F 2 F 2o)n t o s i m u l a t i o n
a r e aR 2
(TO-R2)with volumeidentificationR2R2RZ(pACKO_
R2R2R2).
Figure 4-16. Control Statemonts for Copying
an Area

Explanation:
o C o p y / d u m pp r o g r a mi s l o a d e df r o m F 1 .
o I n p u t f i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e fsi l e
isMASTER
(LABEL.MASTER).
- M a i nd a t aa r e aD 1 c o n t a i n s
t h e f i l e ( U N I T - D 1 ) .l t s
n a m ei s A 1 ( P A C K - A 1 ) .
.

O u t p u tf i l e ( O C Ls e q u e n c e ) :
- The nameto be written
to identify the file is BACKUp
(LABEL-BACKUP}.
- The areathat is to contain
the file is the main data
a r e aD 2 ( U N I T - D 2 ) .T h e p a c kn a m ei s B 2 ( p A C K _ 8 2 ) .
- T h e f i l e i s t o b e p e r m a n e n(tR E T A I N - p ) .
- T h e s i z eo f t h e f i l e i s 5 0
t r a c k s( T R A C K S - S 0 ) .

Figure 4-17. OCL Load Sequence for eopying a
Filo from One Ar€a
to Another

Copy/DumpProgram-$COPY

443

Explanation:
The COPYFILEstatementtellsthe programto createthe
output file usingall the datafrom the input file. The outp u t f i l e i s a c o p y o f t h e i n p u tf i l e .
Figure 4-18. Control Statemonts for Copying a File from One Area
to Another

Explanation:
o C o p y / d u m pp r o g r a mi s l o a d e df r o m F 1 .
o l n p u t f i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i ife st h e f i l e i s B A C K U P
(LABEL.BACKUP).
- T h e a r e at h a t c o n t a i n st h e f i l e i s t h e m a i nd a t aa r e a
o n d r i v e1 ( U N I T - D l ) . l t s n a m ei s B 2 ( P A C K - 8 2 ) .
Figure 4-19. OCL Load Sequence for Printing Part of a File

Explanation:
o T h e f i l e i s b e i n gp r i n t e d( C O P Y F I L Es t a t e m e n t ) .
o T h e f i l e i s a n i n d e x e df i l e . T h e p a r t b e i n gp r i n t e di s
identifiedby the recordkeysfrom ADAMS to BAKER
i n t h e i n d e x( S E L E C Ts t a t e m e n t ) .
Figure 4-2O. Control Statements for Printing part of a File

444

Explanation:
C o p y / d u m pp r o g r a mi s l o a d e df r o m F l .
I n p u t f i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e tsh e f i l e i s M A S T E R
( L A B EL - M A S T E
R) .
- The areathat containsthe file is the main
dataarea
o n d r i v e1 ( U N I T - D l ) .l t s n a m ei s D l D l D l
(PACK-D1D1D1).
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- The nameto be written on tapeto identify
the f ile is
B A C K U P( L A B EL - B A C K U P ) .
- T h e t a p eu n i t t h a t i s t o c o n t a i nt h e f i l e i s t a p e
unit 1
( U N I T - T 1 )l.t s n a m ei sT 1 T t T 1 ( R E E L - T t T 1 T 1 ) .
- The recordformat usedis fixed length,unblocked
r e c o r d s( R E C F M - F ) .T h e r e c o r dl e n g t hi s 8 0
( RE C L - 8 0 ) .
C o n t r o ls t a t e m e net x p l a n a t i o:n
T h e e n t i r ef i l e n a m e dM A S T E Ri s c o p i e dt o t a p eu n i t 1
{ O U T P U T .IFL E ) .
Figure 4-21. OCL and Control Statements to Copy a Disk File to a
Tape File

Copy/DumpProgram-$COPY

445

Explanation:
.

Copy/dumpprogramis loadedfrom F1.
I n p u t f i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e tsh e f i l e o n t a p ei s B A C K U P
(LABEL-BACKUP).
- T h e t a p et h a t c o n t a i n st h e f i l e i s t a p eu n i t 1
( U N I T - T 1 ) l.t sn a m ei sT 1 T 1 T 1( R E E L - T 1 T 1 T 1 ) .
- The recordformat of the file is fixed length,unb l o c k e dr e c o r d s( R E C F M - F ) .
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- The nameto be written to identify the file is
M A S T ER ( L A B EL . M A S T ER ) .
- T h e a r e at h a t i s t o c o n t a i nt h e f i l e i s t h e m a i nd a t a
areaon drive2 (UNIT-D2). lts nameisD2D2D2
(PACK.D2D2D2).
- T h e f i l e i s t o b e p e r m a n e n(tR E T A I N - P ) .
- T h e s i z eo f t h e f i l e i s 3 0 t r a c k s( T R A C K S - 3 0 ) .

o Controlstatementexplanation:
- The entirefile is copiedfrom tapeto disk
(OUTPUT-BOTH}.
- T h e r e c o r d s1 0 t h r o u g h1 0 0 a r ep r i n t e d( R E C O R D ,
F R O M - 1 0T. O - 1 0 0 ) .
Figwe 4-22. OCL and Control Stat€ments to Copy a Tape File to a
Disk File and Print a Part of the File

Explanation:
C o p y / d u m pp r o g r a mi s l o a d e df r o m F 1 .
I n p u tf i l e ( O C Ls e q u e n c e ) :
- The tapethat containsthe f ile is tape unit 1
(UNIT.T1}.
- The tape beingcopiedis an unlabeledtape
( REEL - NL ); t h e r e f o r er,e c o r df o r m a t ( RE C F M - FB ) .
r e c o r dl e n g t h( R E C L - 9 6 )a, n d b l o c k l e n g t h
( B L K L - 9 6 0 )a r es p e c i f i e d .
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e t a p eu n i t t h a t i s t o c o n t a i nt h e f i l e i s t a p eu n i t 2
(UNIT-T2).
- N o l a b e li s u s e do n t h e o u t p u tt a p e( R E E L - N L ) .
- The recordformat is fixed length,unblocked
(RECFM.F).
o Controlstatementexplanation:
- Records20 to 200 arecopied(F ILE-yES).
- N o r e c o r d sa r ep r i n t e d( O U T P U T - F I L E ) .
Figure 4-23. OCL and Control Statements to Copy a Tape File to a
Tape File and Select Records to b€ Copid

Copy/DumpProgram-$COPY

441

Explanation:
T h e c o p y / d u m pp r o g r a mi s l o a d e df r o m F 1 .
I n p u tf i l e ( O C Ls e q u e n c e )
The primaryhopperof the 5424 M FCU containsthe
i n p u tf i l e ( U Nl T - MF C U l) .
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- The nameto be written on tapeto identify the file is
B A C K U P( L A B E L . B A C K U P ) .
- T h e t a p eu n i t t h a t w i l l c o n t a i nt h e f i l e i s t a p eu n i t 1
( U N I T - T 1 )l.t s n a m ei sT 1 T 1 T l ( R E E L - T l T 1 T 1 ) .
- The recordformat usedis fixed length,blocked
r e c o r d s{ R E C F M - F B } T
. h e r e c o r dl e n g t hw i l l b e 9 6
( R E C L - 9 6 )t;h e b l o c kl e n g t hw i l l b e 9 6 0 ( B L K L - 9 6 0 ) .
Controlstatementexplanation
:
T h e e n t i r ec a r df i l e w i l l b e c o p i e dt o t a p eu n i t 1
( O U T P U T .IFL E } .
Figure 4-24. OCL and Control Statements to Copy a Card File to a
Tape File

Explanation:
The copy/dumpprogramis loadedfrom F1.
I n p u t f i l e ( O C Ls e q u e n c e ) :
- The namethat identifiesthe file is MASTER
(LABEL.MASTER),
- T h e a r e at h a t c o n t a i n st h e i n p u tf i l e i s R 1 ( U N I T - R 1 ) .
T h ea r e an a m ei s R 1R l R 1 ( P A C K - RR1 1R 1 ) .
O u t p u tf i l e ( O C Ls e q u e n c e ) :
T h e 1 4 4 2w i l l c o n t a i nt h e o u t p u tf i l e ( U N I T - 1 4 4 2 ) .
Controlstatementexplanation
:
The entiredisk file namedMASTERwill be punched
i n t o c a r d sb y t h e 1 4 4 2( O U T P U T - F I L E ) .
Figure 4-25. OCL and Control Statements to Copy a Disk File to a
Card File

Copy/DumpProgram-$COPY

449

Explanation:
The copy/dumpprogramis loadedfrom F 1.
I n p u tf i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e tsh e f i l e i s M A S T E R
(LABEL-MASTER).
- T h e a r e at h a t c o n t a i n st h e f i l e i s D 1 ( U N I T - D l ) .
lts
n a m ei s D l D l D l ( P A C K - D t D 1 D 1 ) .
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e o u t p u tf i l e i s c o n t a i n e do n d i s k e t t e( U N I T - 3 7 4 1 ) .
- The recordlengthspecifiedin the 374,l
dataset label
i s 1 0 0( R E C L . 1 0 0 ) .
Controlstatementexplanation
:
T h e e n t i r ed i s kf i l e n a m e dM A S T E Rw i l l b e c o p i e dt o
t h e 3 7 4 1 d i s k e t t e( O U T P U T . F
tLE).
Figure 4-26. OCL and Control Statements to Copy a Disk File to a
3741 Diskette

4-50

Explanation:
o The copy/dumpprogramis loadedfrom F1.
I n p u t f i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e tsh e f i l e o n t a p ei s M A S T E R
(LABEL.MASTER}.
- The tapethat containsthe f ile is tapeunit 1
( U N I T - T I ) . l t s n a m ei s P A Y R O L( R E E L . p A y R O L ) .
- The recordformat of the file is fixed length,
u n b l o c k e dr e c o r d s( RE C F M - F ) .
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e o u t p u tf i l e i s c o n t a i n e do n d i s k e t t e( U N I T - 3 7 4 1 ) .
- The recordlengthspecifiedin the 3741 dataset label
i s9 6 ( R E C L - 9 6 ) .
.

Controlstatements
explanation:
- The entirefile is copiedfrom tapeto the 3741
(OUTPUT-BOTH).
- Records4 through 12Oareprinted
( RE C OR D , FR O M - 4 , T O1-2 0 ) .

Figure 4-27. OCL and Control Statements to Copy a Tape File to a
Diskette File and print a part of the File

Copy/DumpProgram-$COPY

4-51

Explanation:
.

The copy/dumpprogramis loadedfrom F1.
I n p u tf i l e ( O C Ls e q u e n c e ) :
- T h e i n p u t f i l e i s c o n t a i n e do n d i s k e t t e( U N I T - 3 7 4 1 ) .
- The recordlengthspecifiedin the 3741 dataset label
is50 (RECL-50).
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e n a m eo f t h e o u t p u tf i l e i s S A L E S
(LABEL.SALES).
- The areathat is to containthe file is main dataarea
o n d r i v e2 ( U N I T - D 2 ) .l t s n a m ei s D 2 D 2 D 2
(PACK-D2D2D2).
- T h e f i l e i s t o b e t e m p o r a r y( R E T A I N - T ) .
- T h e s i z eo f t h e f i l e i s 1 5 t r a c k s( T R A C K S - 1 5 ) .
Controlstatements
explanation:
R e c o r d s5 t o 2 5 0 a r ec o p i e d( F I L E - Y E S a) n dp r i n t e d
(OUTPUT.BOTH).

Figure 4-28. OCL and Control Statements to Copy a Diskette File
to a Disk File and Print Only the Copied Records

Explanation:
o Copy/dumpprogramis loadedfrom F1.
o I n p u tf i l e ( O C Ls e q u e n c e ) :
The primaryhopperof MFCU (5424]rcontainsthe input
f i l e( U N I T - M F C U 1 ) .
o Output file (OCL statement)
:
- T h e o u t p u tf i l e i s c o n t a i n e do n d i s k e t t e( U N I T - 3 7 4 1 ) .
- The recordlengthspecifiedin the 3741 dataset label
is96 (RECL-96).
o Controlstatementexplanation:
The entirecardfile from the MFCUl is copiedto the
3 7 4 ' l a n d p r i n t e d( O U T P U T - B O T H ) .
Figure 4-29. Control Statemont to Copy a Card File to a Diskette
and Print the Entire File

Copy/DumpProgram-$COPY

4-53

Explanation:
Copy/dumpprogramis loadedfrom Fl.
I n p u tf i l e ( O C Ls e q u e n c e ) :
- T h e i n p u t f i l e i s c o n t a i n e do n d i s k e t t e( U N I T - 3 7 4 1 ) .
- The recordlengthspecifiedin the 3741 dataset label
i s 1 2 8( R E C L . 1 2 8 ) .
O u t p u tf i l e ( O C Ls e q u e n c e ) :
T h e 1 4 4 2c o n t a i n st h e o u t p u tf i l e ( U N I T - 1 4 4 2 ) .
Control statementexplanation
:
R e c o r d s1 6 t h r o u g h6 7 a r ec o p i e d( F I L E - y E S )t o t h e
1 4 4 2a n dp r i n t e d( O U T P U T . B O T H ) .
Figure 4-30. Control Statomonts to Copy and print a portion of a
File on a Diskotto to a Card Device

4-il

Explanation:
o Copy/dumpprogramis loadedfrom F1.
o I n p u t f i l e ( O C Ls e q u e n c e ) :
T h e 1 4 4 2c o n t a i n st h e i n p u t f i l e ( U N I T - 1 4 4 2 ) .
o O u t p u tf i l e ( O C Ls e q u e n c e ) :
The secondaryhopperof the MFCU containsthe output
file(UNIT-MFCU2).
o Controlstatementexplanation:
T h e e n t i r ef i l e i s c o p i e dt o t h e M F C U 2 .
Figure 4-31. Controt Statomont to Copy a Card File to Another
Card File

Copy/DumpProgram-$COPY

4-55

Explanation:
The copy/dumpprogramis loadedfrom FL
I n p u tf i l e ( O C Ls e q u e n c e ) :
- The namethat identifiesthe file is MASTER
(LABEL-MASTER).
- The areathat containsthe file is
the simulationarea
R l ( U N I T - R 1 )l.t s n a m ei s R 1 R 1 R 1
(PACK.R1R1R1).
O u t p u tf i l e ( O C Ls e q u e n c e ) :
The unit that will containthe file is the 32&4

(uNrT-3284).

o Controlstatementexplanation:
T h e e n t i r ed i s kf i l e n a m e dM A S T E Rw i l l b e p r i n t e do n
u n i t 3 2 8 4 ( O U T P U T - PtRN T ) .
Figure 4-32. OCL Control Statemont to print a Disk File on the
3284

Explanation:
T h e c o p y / d u m pp r o g r a mi s l o a d e df r o m F 1 .
I n p u tf i l e ( O C Ls e q u e n c e ) :
T h e 1 4 4 2c o n t a i n st h e i n p u tf i l e ( U N I T - 1 4 4 2 ) .
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- The nameto be written to identifv the file is SALES
(LABEL-SALES}.
- The areathat is to containthe file is the simulation
a r e aR 1 ( U N I T - R 1 )l.t s n a m ei s R 1R l R l
(PACK-R1R1R1).
- T h e f i l e i s t o b e p e r m a n e n(tR E T A I N - P ) .
- T h e s i z eo f t h e f i l e i s 1 0 t r a c k s( T R A C K S - 1 0 ) .
:
Controlstatementexplanation
The entirefile will be copiedto disk and printed
(OUTPUT-BOTH)
and the output recordlengthwill be
. i t h o u tt h e l e n g t hp a r a m e t e r ,
9 6 ( L E N G T H - 9 6 )W
output recordlengthwould be 80 (sameasfor 1442l..
Figure 4-33. OCL and Control Stat€ments to Copy a Card Fil€ to a
Disk File and Specify an Output Record Length

Copy/DumpProgram-$COPY 4-57

Explanation:
o C o p y / d u m pi s l o a d e df r o m F l .
I n p u tf i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e tsh e f i l e
o n t a p ei s B A C K U p
(LABEL.BACKUP).
- T h e t a p et h a t c o n t a i n st h e f i l e i s
o n t a D eu n i t 1
( U N I T - T l )i;t sn a m ei sT 1 T t T l ( R E E L - T 1 T 1 T 1 ) .
- The recordformat of the file is fixed
length,
u n b l o c k e dr e c o r d s( RE C F M - F l .
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- The nameto be written to identify
the file is
M A S T E R( L A B EL - M A S T ER ) .
- T h e a r e at h a t i s t o c o n t a i nt h e f i l e i s
m a i nd a t aa r e a
D 1 ( U N I T - D 1 i)t;sn a m ei s D 1 D t D 1( P A C K - D 1 D . t D 1 ) .
- T h e f i l e i s t o b e p e r m a n e n(tR E T A I N - p ) .
- T h e s i z eo f t h e f i l e i s 3 0 t r a c k s( T R A C K S _ 3 0 ) .
.

Controlstatementexplanation:
- The entirefile will be copiedfrom tape
to disk and
p r i n t e d( OU T P U T - B O T)H.
- T h e o u t p u tf i t e w i i l b e d i r e c t( D A T A M G M T _ D t R E C T ) .

Figure 4-34. OCL and Control Statem€nts to Buitd a Dirsct Disk
File from Sequential Tap€ Input

Explanation:
o The copy/dumpprogramis loadedfrom F1.
o O u t p u tf i l e ( O C Ls e q u e n c e ) :
- The nameto be written to
identify the file ts
CUSTMAST( LABEL.CUSTMAST}.
- T h e a r e at h a t i s t o c o n t a i n
t h e f i l e i s s i m u l a t i o na r e a
R 1 ( U N I T - R 1i)t ;sn a m ei s R 1 R 1 R 1
(PACK-RtR1R1).
- T h e f i l e i s t o b e p e r m a n e n(tR E T A I N _ p ) .
- T h e s i z eo f t h e f i l e i s 1 0 t r a c k s( T R A C K S _ 1 0 ) .
o C o n t r o ls t a t e m e net x p l a n a t i o n :
- T h e f i l e w i l l b e c o p i e df r o m
c y l i n d e r2 0 2
( C Y L I N D E R - 2 0 2s) ,e c t o r0 ( S E C T O R - 0t)h; e
record
lengthof the input file is 256 bytesper record
( R E C L - 2 5 6 )t ;h e f i l e i s o n s i m u l a t i o n
a r e aR 2
( F R O M - R 2 )a, n dt h e r e c o r ds t a r t sw i t h t h e f i r s t
byte
o f t h e s e c t o r( D l s p - O ) .
- Records1 through25 will
be copiedand printed
( F R O M - 1 , T O - 2F5I,L E _ Y E S ) .
Figure 4-35. OCL and Control Statements to Recover
a Disk File
from a Simulation Ar€a

Copy/DumpProgram-gCOpy

4-S9

Explanation:
o The copy/dumpprogramis loadedfrom
F 1.
.

O u t p u tf i l e ( O C Ls e q u e n c e ) :
- Nameto be written to identify
the file is MASTER
(LABEL.MASTER).
- The main dataareathat is to
containthe file is on
. h e a r e an a m ei s D 1 D 1 D 1
d r i v e1 ( U N I T - D 1 ) T
(PACK_D1D1D1).
- T h e f i l e i s t o b e t e m p o r a r y( R E T A I N _ T ) ,
- T h e s i z eo f t h e f i l e i s 1 0 0t r a c k s( T R A C K S _ 1 0 0 ) .

o Controlstatementexplanation:
- T h e f i l e w i l l b e c o p i e df r o m
c y l i n d e r1 6 0
( C Y L I N D E R - 1 6 0 t)r, a c k 1 ( T R A C K _ I t h e
record
).
t e n g t ho f t h e f i t e i s g 0 b y t e s( R E c L _ 9 0 )t.h e f i l e i s
r e c o v e r efdr o m m a i nd a t aa r e aD 2 ( F R O M _ D 2 )a,n d
the recordstartswith the first byte of sectorI
( S E C T O R . 1D, I S P . O ) .
- R e c o r d s1 t h r o u g h1 0 0 0w i l l
b e c o p i e d( F R O M - 1 ,
T O . 1 0 0 0F. t L E - Y E S ) .
Figure 4-36. OCL and Control Statements to Recover
a Disk File
from a Main Data Area

4€0

Explanation:
.

C o p y / d u m pp r o g r a mi s l o a d e df r o m F 1 .
I n p u tf i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e tsh e f i l e i s C O N S V F
(LABEL.CONSVF).
- T h e a r e at h a t c o n t a i n st h e f i l e i s s i m u l a t i o na r e aR 1
( U N I T - R 1 )l t. sn a m ei s R 1 R 1 R 1
(PACK.R1R1Rt).
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e n a m eo f t h e o u t p u tf i l e i s I N D S V F
(LABEL.INDSV
} .F
- T h e a r e at h a t i s t o c o n t a i nt h e f i l e i s t h e m a i nd a t a
a r e ao n d r i v e1 ( U N I T - D 1 ) .l t s n a m ei s D 1 D 1 D 1
(PACK.D1D1D1).
- T h e s i z eo f t h e f i l e i s 1 0 0t r a c k s( T R A C K S - 1 0 0 ) .
Workfile
$ l N D E X 4 5i s a w o r k f i l e t h a t m a y d e c r e a seex e c u t i o n
t i m e i f a l a r g ei n d e x e df i l e i s b e i n gc r e a t e d .F o r p e r formancereasons,
the work file shouldnot be on the
s a m ed i s kd r i v ea st h e o u t p u tf i l e .
T h e C O P Y F I L Es t a t e m e ntte l l st h e p r o g r a mt o c r e a t ea n
i n d e xf o r t h e o u t p u tf i l e u s i n ga l l t h e d a t af r o m t h e
i n p u tf i l e .

o The KEY statementtells the programto createan index
for the output file consistingof 23-bytekeys
( L E N G T H - 2 3t)h a t a r el o c a t e d1 2 8 b y t e si n t o t h e
r e c o r d( L O C A T I O N -218 ) .
Figure 4-37. OCL and Control Statements to Copy a Sequential
File From a Simulation Aroa to a Main Data Area and
Create an Indexed Output File

Copy/DumpProgram-$COPY

4-61

Dump/RestoreProgram-$DCOPY
P R O G R A MD E S C R I P T I O N
The dump/restoreprogramhasthe followingfunctions:
Dump the entirecontentsof a main dataareaor simula.
tion areaonto magnetictape,or dump the entire
contentsof a simulationareaonto diskette.
Restorethe main dataareaor simulationareato its
originalcontentsby transferringinformationbackfrom
the tapeor diskette.
lmportantareas,suchasthosecontaininglibrariesand
permanentdatafiles,are normallycopied. The tapeor
diskettecontainsa copy of all tracksand servesasa backup
copy in casesomethinghappensto the informationon the
disk.
A n a c t i v es p o o lf i l e i n t h e i n p u t a r e ai s d u m p e dt o t a p e .
However,duringthe restoreoperation,the spoolfile is
deleted.

C O N T R O LS T A T E M E N TS U M M A R Y
you must supplydependon the
The control statements
desiredresults.

Functions

ControlSt.t"."nt, O

Copy an entirearea
to tapeor diskette;or
restorean areafrom
tapeor diskette.

// coeveRcp{n;nl.o"},,,o"K.namer
[r"*," {#;}] [,,o.*r,{Ht}]
ENDO
//

O Controtstatements
are requiredin the orderthey are listed.
@ tf,"r. can be only one COPYPACKstatementin a program.
O

4$2

EruOstatementmust appearonly once in a programsinceit is a delimiterindicatingend of job.

PARAMETER
SUMMARY

P A R A M E T ER D E S C RI P T I O N S

COPYPACK
Statement

(COPYPACK)
FROM and TO Parameters

Parameter

Meaning

FROM-code

Locationof areato be copied.
P o s s i b lceo d e sa r e F 1 , R 1, F 2 , R 2 ,
and thosefor the main dataareas.

TO-code

Locationof areato receivethe
c o p y . P o s s i b lceo d e sa r eF 1 , R1 ,
F 2 , R 2 , a n dt h o s ef o r t h e m a i n
dataareas.SeeFigure4-38 for
r e l a t i o n s h ioof F R O Ma n dT O
locations.

PACK-name

Nameof the main dataareaor
s i m u l a t i o na r e ab e i n gu s e d .

SYSTEM-NO

The SYSTEM-NOparameterdoes
n o t a l l o wc y l i n d e r0 I P L a r e a st o
be dumpedor restored.

SYSTEM-YES

that the
SYSTEM-YESspecifies
I P L a r e a so n c y l i n d e r0 a r et o b e
dumpedor restoredalongwith
the specifiedsimulationarea.

SYSTEM-code

D u m p t h e I P L a r e a sf r o m c y l i n d e r
0 of the main dataareaalongwith
the simulationareaspecifiedby
. ossible
t h e F R O M p a r a m e t e rP
codesarethosefor the main data
areas.

The COPYPACKstatementis usedto copy information
from disk to tape,tapeto disk,disk to diskette,or diskette
to disk.
) d i c a t etsh e l o c a t i o n
T h e F R O M p a r a m e t e(rF R O M - c o d ei n
of the areabeingcopied. The TO parameter(TO-code)
indicatesthe locationof areato receivethe copy.
P o s s i b lceo d e sf o r t h e F R O Ma n dT O p a r a m e t e rasr e R 1 ,
F 1 , R 2 , F 2 , a n dt h o s ef o r t h e m a i nd a t aa r e a s .
SeeFigure4-38 for the relationshipof F ROM and TO
locations.

BACKUP-TAPE TheBACKUP-TAPEparameter
that magnetictape
specifies
( 3 4 1 0 - 3 411) i s t o b e u s e df o r
dump/restore.
B A C K U P - 3 7 4 1 B A C K U P - 3 714s p e c iife st h a t
diskettesareto be usedto dump
or restorethe specifiedsimulation
area.

Dump/RestoreProgram-$DCOPY

4-63

S i m u l a t i o na r e a
(Possible
codesare
Fl. R1,F2,R2l

Main dataarea
(Possible
codesarethose
for the main dataareas)

3410/341
1 tape
( T 1 , T 2T, 3 ,o r T 4
asindicated
on FILE
statement)
or 3741
diskette

and

3410/341
1 tape
(T1,T2,T3, or T4
a s i n d i c a t e do n F I L E
statementl

Notes:
W h e ny o u c o p y d i s kt o t a p e( d u m p ) ,y o u m a y s p e c i f ya n y s i m u l a t i o na r e ao r m a i nd a t aa r e aa s i n p u t ,
1.
i n c l u d i n gt h e s y s t e ms i m u l a t i o n
a r e ao r p r o g r a ms i m u l a t i o na r e a .

2.

Whenyou copy tapeto disk (restore),the TO codemust not specifythe systemsimulationarea,the
programsimulationarea,or anothersimulationareacontaininglibraries,temporarydatafiles.or permanent
datafiles.

3.

The areareceivingthe restoredcopy must be the sametype (simulationor main data area)asthe original
area.

Figure 4-38. Relationship of Disk to Tape Drives When Using $DCOPY

(coPYPAcK)
PACKParameter

(copypAcK)
BAcKUpparameter

The pack name specified is checked againstthe actual name
of the main data area or simulation area. A halt occurs if
t h e y a r e n o t t h e s a m e . l f t h e p a r a m e t e ri s n o t u s e d ,n o
c h e c k i n go c c u r s .

The BACKUP parameter specifieswhich device (tape or
diskette) is to be used for backup. Tape may be used to
b a c k u p a m a i n d a t a a r e a .a s i m u l a t i o na r e a .a n d c y l i n d e r 0 .
D i s k e t t e sc a n b e u s e d o n l y t o b a c k u p a s i m u l a t i o na r e aa n d
cylinder0. Also, the 3741 dataset must be setfor 128-byte
records.

SYSTEM Parameter (CoPYPACK)
The SYSTEM parameter is an optional parameter used to
s p e c i f yw h e t h e rc y l i n d e r 0 I P L i n f o r m a t i o n i s t o b e d u m p e d
or restored with the specified simulation area. SYSTEMY E S a l l o w s c y l i n d e r 0 t o b e d u m p e d o r r e s t o r e dt o e i t h e r
t a p e o r d i s k e t t e . S Y S T E M - c o d ea l l o w s t h e c y l i n d e r 0 l p L
a r e a so f t h e u n i t s p e c i f i e db y t h e c o d e a l o n g w i t h t h e s i m u l a t i o n a r e as p e c i fi e d i n t h e F R O M p a r a m e t e rt o b e d u m p e d
t o e i t h e r t a p e o r d i s k e t t e . S Y S T E M - N Od o e sn o t a l l o w
cylinder 0 to be dumped or restored. The default is
SYSTEM-NO.
l f S Y S T E M - Y E S i s s p e c i f i e df o r t h e d u m p , S Y S T E M - Y E S
must also be specified for the restore.

4-64

P a g eo f G C 2 1- 5 16 2 - 1
l s s u e d2 8 S e p t e m b e r 1 9 7 9
By TNL: GN21'5674

D U M P / RE S T O RE C O N S I D E R A T I O N S

O C LC O N S I D E R A T I O N S

W h e n y o u d u m p a m a i n d a t a a r e ao n a 3 3 4 0 t o t a p e a n d
t h e n r e s t o r et h e t a p e t o a m a i n d a t a a r e ao n a 3 3 4 4 , o n l v
c y l i n d e r s0 - i 6 6 a r e c o p i e d t o t h e 3 3 4 4 .

T h e $ D C O P Y s y s t e ms e r v i c ep r o g r a m r e q u i r e st h e f o l l o w i n g
OCL statements:
LOAD $DCOPY,code

W h e n y o u d u m p a m a i n d a t a a r e ao n a 3 3 4 4 t o t a p e a n d
t h e n r e s t o r et h e t a p e t o a m a i n d a t a a r e ao n a 3 3 4 0 , o n l y
c y l i n d e r s0 - 1 6 6 a r e c o p i e d t o t h e 3 3 4 0 .

ll

FILE parameters

rr RUN
$ D C O P Y c a n c o p y a r e a sw i t h a c t i v ef i l e s i f t h e a c t i v ef i l e s
a r e i n p u t o n l y . A r e a sc a n n o t b e c o p i e d i f t h e y c o n t a i n
a c t i v ef i l e st h a t a r e b e i n gm o d i fi e d .
A ' W F ' m e s s a g e o c c u r s i f a n a t t e m p t i s m a d e t o r e s t o r ea
m a i n d a t a a r e ao n a 3 3 4 0 f r o m a t a p e t h a t c o n t a i n sa d u m p
f r o m a m a i n d a t a a r e ao n a 3 3 4 4 t h a t h a s f i l e s a l l o c a t e do n
c y l i n d e r s1 6 7 - 1 8 6 . O n l y c y l i n d e r s0 - 1 6 6 c a n b e c o p i e d

T h e c o d e i d e n t i f y i n gt h e l o c a t i o no f t h e $ D C O P Y p r o g r a m
canbe R1, F1, R2,or F2.

F I L E S t a t e m e n tC o n s i d e r a t i o n s
o T h e n a m e o f t h e f i l e m u s t a l w a y sb e B A C K U P .

to the 3340.
D u r i n g t h e r e s t o r ef u n c t i o n , p o r t l o n s o f t h e n e w a r e a
( s i m u l a t i o no r m a i n d a t a ) a r e c h a n g e dt o p r e v e n ta c c i d e n t a l
u s a g eo f a p a r t i a l l y f i l l e d a r e au n t i l t h e c o n t e n t so f t h e t a p e
o r d i s k e t t e sa r e c o m p l e t e l y c o p i e d t o t h e n e w a r e a . T h e r e f o r e , i f t h e c o p y i n g p r o c e s si s s t o p p e d b e f o r e i t i s
c o m p l e t e d ,t h e a r e a i s u n u s a b l e . Y o u c a n r e s t a r tt h e c o p y i n g p r o c e s sb y r e l o a d i n gt h e d u m p / r e s t o r ep r o g r a m ,o r y o u
c a n r e s t o r et h e a r e ab y r e i n i t i a l i z i n g .

o W h e n a 7 - t r a c kt a p e i s u s e df o r t h e d u m p / r e s t o r e
p r o g r a m ,C O N V E R T - O N m u s t b e s p e c i fi e d .
.

T h e r e c o r d f o r m a t i s a l w a y sf i x e d l e n g t h .

o T h e E N D p o s i t i o n o f t h e t a p e a f t e r p r o c e s s i n ga l w a y s
d e f a u l t st o U N L O A D .
o D u r i n g a r e s t o r eo p e r a t i o n ,t h e d e n s i t y p a r a m e t e rm u s t
b e t h e s a m e n u m b e r a s s o e c i fi e d f o r t h e d u m p .

B e f o r ey o u d u m p a m a i n d a t a a r e af r o m a 3 3 4 4 , y o u s h o u l d
1.

D e t e r m i n ei f a n a c t i v ef i l e ( s ) e x i s t so n c y l i n d e r s ' l6 7
t h r o u g h 1 8 6 ( i f n e c e s s a r ye, x e c u t e$ L A B E L ) . l f s o ,
y o u s h o u l d e x e c u t et h e F i l e C o m p r e s sP r o g r a m
( $ F C O M P )t o m o v e t h i s f i l e ( s )w i t h i n c y l i n d e r s1
t h r o u g h 1 6 6 ( t h i s o c c u r so n l y i f s u ff i c i e n t s p a c e

o T h e r e c o r d l e n g t h , i f s p e c i f i e d ,i s i g n o r e db e c a u s e
$ D C O P Y m a k e st h e r e c o r d l e n g t h e q u a l t o t h e b l o c k
length.
o T h e F I L E s t a t e m e n ti s n o t r e q u i r e dw h e n t h e p r o g r a m
iscopying f rom disk to diskette.

e x i s t so n t h e s ec v l i n d e r s ) .
.
2.

E x e c u t et h e D u m p / R e s t o r eP r o g r a m( $ D C O P Y ) .
T h i s p r o g r a mt h e n c o p i e s( d u m p s )o n l y c y l i n d e r s0
throuqh166.

$ D C O P Y s u p p o r t ss i n g l ev o l u m e t a p e f i l e s , m u l t i v o l u m e
t a p e f i l e s ,a n d m u l t i f i l e t a p e v o l u m e s . F o r a d e t a i l e d
d e s c r i p t i o no f t h e F I L E s t a t e m e n tp a r a m e t e r ss, e et h e
a p p r o p r i a t eF I L E s t a t e m e n ti n P a r t 1 o f t h i s m a n u a l .

Dump/RestoreProgram-$DCOPY 4-65

StatementEntries

Messages
for DUMP/RESTORE

StatementEntry

Consideration

Message

Meaning

// LOAD

None

C O P Y P A C KI S
COMPLETE

$DCOPY

N a m e o f d u m p / r e s t o r ep r o g r a m .

This message
indicatesthat the area
hasbeendumpedto tapeor the
tapehasbeenrestoredto disk.

code

L o c a t i o n o f s i m u l a t i o na r e ac o n taini ng dump/restore program.
P o s s i b l ec o d e sa r e R 1 , F 1, R 2 , o r

N T R A C K SN O T
RESTORED
AT

This message
indicatesthe tracks
that havenot beenrestoredon the
simulation
a r e ao r m a i nd a t aa r e a .
N = the numberof tracksnot
restored.CC/SSis the address
for a
s i m u l a t i o na r e a .C C C / H H / R Ri s
the address
for a main dataarea.

F2.
// FILE

None

NAME-filename

F i l e n a m ee n t r y m u s t b e B A C K U P .

BL K L - b l o c k
length

Block length and record length
must be equaland one of the
following values:
Note: Ihe tape record created is
2 bytes longer than specified
becausea 2-byte logical record
number is appended to the tape
r e c o r d . D e f a u l t sa r e u n d e r l i n e d .

// RUN

Length

Number

in
Disk

Bytes

of
Tracks

Simufation
area

3072
6M4
12288

112 track
1 track
2 tracks

Main
data
area

3072
6144
12288
24576

114track
112track
1 track
2 tracks

None

F o r a d e t a i l e dd e s c r i p t i o on f t h e O C L s t a t e m e n t s .e ep a r t
o f t h i sm a n u a l .
Note: The remainingF ILE statementparameters
are
d e s c r i b eidn t h e t a p ef i l e O C L s t a t e m e nitn p a r t 1 .

4-66

{ cc/ss

t

<
)
tccc+ r Hr nn
)

N N T A P EE R R O R S
OCCURRED
P A C KI S N O T
COMPLETE
LY
RESTOR
ED.

This message
indicatesthat tape
errorshaveoccurredor the
restored
a r e ah a sm i s s i n g
data.
N N = t h e n u m b e ro f t a p ee r r o r s .
Seepreviousmessages
for location
of tracksnot restored.

EXAMPLES
T h e p a r a m e t e rosf t h e F I L E s t a t e m e nvta r yd e p e n d i nugp o n
whetherthe copy is to or from the tape.
Figures4-39 through4-44 show the OCL and control statementsto dump from disk to tape,restorefrom tapeto disk,
a n dd u m p f r o m d i s k t o d i s k e t t e .

FILE Statement: From Disk to Tape

Control Statements

Only requiredparameters
are includedin this example.See
OCL Considerationsfor a listing of possibleparameters.
8

1

2

1

6

2

0

2

4

2

8

Explanation:
o The COPYPACKstatementtellsthe programto copy an
entireareato tape.
Explanation:
o The dump/restoreprogramis loadedf rom F 1.
o T h e f i l e n a m ei s a l w a y sB A C K U P( N A M E - B A C K U P ) .
o T h e c o p y g o e st o t a p eu n i t 2 ( U N I T - T 2 ) .

o T h ec o p y i s f r o m F 1 ( F R O M - F 1 ) .
o F I X E D l i s t h e n a m eo f t h e s i m u l a t i o na r e ab e i n gu s e d
( P A C K - F l X E D)l . T h e p r o g r a mv e r i f i e st h a t t h e a r e ah a s
t h e v o l u m el a b e lF I X E D1.
Figure 4-40. Control Statement to Dump from Disk to Tape

o Tapeunit 2 is a 9-trackdrive.
Figure 4-39. LOAD and FILE Statements to Dump from Disk to
Tape

Dump/RestoreProgram-$DCOPY

457

FILE Statement: From Tapeto Disk

Explanation:
o The dump/restoreprogramis loadedfrom Rl.
T h e f i l e n a m ei s a l w a y sB A C K U p .
Tapeunit 2 containsthe areacopy.
T a p eu n i t 2 i s a 7 - t r a c kd r i v e .
T A P E 2i s t h e l a b e lo f t h e t a p ev o l u m e .
K E E P Si s u s e di n t h e h e a d e lra b e l .
T h e d a t ei s M a r c h1 1 , 1 9 7 6 .
B l o c kl e n g t hi s 6 1 4 4 .
CONVERT-ONindicatesdataconversion.
.

E N D ,P A R I T Y ,a n dT R A N S L A T Ep a r a m e t e rgsi v e na r e
the sameasthe defaultvalues.

Figure 4-41 . LOAD and FILE Statements to Restore from Tape
to
Disk

4€8

Explanation:
.

The COPYPACKstatementtellsthe programto copy an
e n t i r et a p et o F 1 ( T O - F1) .
T h e p r o g r a mr e s t o r ecsy l i n d e r0 I P L r e c o r d sa l o n gw i t h
F1 (SYSTEM-YES).
F I X E D l i s t h e n a m eo f t h e s i m u l a t i o na r e ab e i n gu s e d
( P A C K - F l X E D l ) .T h e p r o g r a mv e r i f i e st h a t t h e a r e ah a s
t h e v o l u m el a b e lF l X E D l .

o

B a c k u p m e d i u m i s m a g n e t i ct a p e .

Figure4-42. Control Statementto Restorefrom Tapeto Disk

Control Statement: From Disk to Diskette

Explanation:
The dump/restore program is loaded from F1.
The COPYPACK statement tells the program to copy the
s i m u l a t i o n a r e aF 2 ( F R O M - F 2 ) t o t h e 3 7 4 1
(BACKUP.3741}.
Approximately 1 1 diskettes are needed to contain the
c o p y f r o m s i m u l a t i o na r e a F 2 .

o The recordlengthon the 3741 diskettemust be 128.
Figure 443.

LOAD and Control Statements to Dump from Disk to
Diskette

Dump/RestoreProgram-$DCOPY

4€9

Control Statement: From Disk to Tape

Explanation:
The dump/restoreprogramis loadedfrom Fl.
The COPYPACKstatementtellsthe programto copy the
s i m u l a t i oanr e aF 1 ( F R O M - F)l .
The programcopiescylinder0 lpL recordsfrom D3.l
a l o n sw i t h F t ( S Y S T E M - D 3 1 ) .
F I X E D I i s t h e n a m eo f t h e s i m u l a t i o na r e ab e i n gu s e d
( P A C K - F l X E D l ) .T h e p r o g r a mv e r i f i e st h a t t h e
a r e ah a s
t h e v o l u m el a b e lF l X E D l .
.

B a c k u pm e d i u mi s m a g n e t i tca p e( B A C K U P - T A P E ) .

Figure 4{{.

Load and Control Statements to Dump from Disk to
Tape

ProgrammingConsiderations
Whendumpingfrom one of the simulationareasto diskette,
p u t t h e 3 7 4 1 o n l i n ei n m o d e3 . ( M o d e s1 , 2 , a n d5 r e s u l t
in
extenterror conditionsat the end of eachdiskette.)See
note.
Whenrestoringfrom disketteto one of the simulationareas,
p u t t h e 3 7 4 1 o n l i n ei n m o d e3 o r m o d e5 . l f t h e 3 7 4 1 i s
p u t o n l i n ei n m o d e 1 , $ D C O p y g o e st o e n d o f j o b a t t h e
e n d o f t h e f i r s t d i s k e t t e .l f t h e 3 7 4 1 i s p u t o n l i n ei n m o d e2 ,
the operatormust put the 3741 onlineafter eachdisketteis
read(seenote).
The COPYPACKlS COMpLETEmessage
indicatesthe
successful
completionof $DCOpy. lf this message
is not
loggedafter restoringto disk,the simulationareacopiedto
will not beusable.
Note: Reier to IBM System/3 3741 ReferenceManual,
G C 2 1 - 51 3 ,f o r f u r t h e re x p l a n a t i o nosf t h e 3 7 4 1 m o d e so f
operation.

4-70

File DeleteProgram-$DE
LET

FreeingSpaceon an Area

P R O G R A MD E S C R I P T I O N

Whena programcreatesa new file on an area,spacefor the
file is allocatedwhen the programis loaded.At the end of
the program,the VTOC on that areais updatedto reflect
the creationof the new f ile.

The file deleteprogramhasthe followingfunctions:
o R e m o v ea l l f i l e i n f o r m a t i o nf r o m t h e V T O Ca n d t h e
datafrom an area.
o Removef ile informationby namefrom the VTOC and
the datafrom an area.
o Removef ile informationin the volumetableof contents
(VTOC)only. This freesthe spaceit occupiesfor useby
new files but doesnot removethe datafrom an area.
o Freespacethat hasbeenallocatedbut, due to abnormal
doesnot actuallycontaindata.
circumstances,

suchaspowerfailureor
Undervery unusualcircumstances.
re-lPLwhile the programis running,the systemmay be
prevented
from updatingthe VTOC eventhoughspacehas
alreadybeenallocatedfor the new file. lf this happens,
the file deleteprogrammay be usedto free this space.
to a halt with an
Merelycancelinga programor responding
immediatecanceloption doesNOT causethis problemto
the systemin this casefreesup the unused
occurbecause
space.

DeletingFiles
The programmay be usedfor temporaryand permanent
files. To deletepermanentfiles,you must usethe f ile
deleteprogram.You can deletetemporaryf ilesby using
the f ile deleteprogramor by changingthe f ile designation
from temporaryto scratch(usingthe OCL keyword
R E T A I N )w h e ny o u u s et h e f i l e .
Whena REMOVEstatementis used,file informationis
erasedfrom the VTOC. The REMOVEstatementcan also
be usedto erasedatafrom an area.
To be compatiblewith System/3Models8, 10, and 12,
the SCRATCHstatement.However,
Model15 recognizes
all functionsare performedas if it werea REMOVEstatement.

Fife DeleteProgram-$DELET

4-71

CONTROLSTATEMENTSUMMARY
The control statements
you mustsupplydependon the
desiredresults.
Functions

Control Statements@

m";;:j:j,-

pACK-name,
// REMovE
uNrr-code,
LABEL.vro.ooro-{}3,
I

;,"Jffi:ilJrth

pACK-name,
// REMovE
UNrr.code,
LABEL.{lnil..,,}
DArE-date
[,r*^ {}pr}]

an area

Freeatt attocated
spacenot containing files.libraries,
or systemareas

, ,Ortor9NlT-code,
// END

pACK-name

\l/ l-or eachuse,the programrequiresthe control statementsin the orderthey are
listed: REMOVE,END. Defaults
are underlined.
@ u'" this form of the REMoVE statementwhen two or more files havethe samename
and you want to delete
one of them.
O

u'" this control statementwhen you suspectthat a systemfailureor an inadvertent
re-lpL may haveleft space
allocatedbut not actuallybeingused.

P A R A M E T E RS U M M A R Y
Parameter

Description

PACK-name

Nameof the area.

UNfT-code

Locationof the area. Possible
codesare R1, F1, R2, F2, and thosefor the
main dataareas.

LABEL-VTOC

R e m o v ea l l f i l e i n f o r m a t i o nf r o m t h e V T O C .

LABEl-filename

R e m o v eo n l y t h e V T O C i n f o r m a t i o nf o r t h e s p e c i f i e fdi l e .

LABEL-'filename,filename,...

Removeonly the VTOC informationfor the specifiedfiles.

DATE-date

Date on the file being deleted. Date must be a six-digit number.

-l
I
_J

U s en a m e st h a t
i d e n t i f yf i l e si n
VTOC. O

E x a m p l e : D A T E - 0 6 0 7 7 6 m e a n sJ u n e 7 , 1 9 7 6

DATA-YES
N

Deletedataaswell as VTOC entry.
Do not deletethe data;deleteonly the VTOC entry.

@ th"r. arethe namesyou gavethe fileswhen you placedthem on an area.

F i l e D e l e t eP r o g r a m - $ D E L E T

4-73

P A R A M E T E RD E S C R I P T I O N S
PACK Parameter
The PACK parameter(pACK-name)tellsthe programthe
n a m eo f t h e a r e at h a t c o n t a i n st h e f i l e sb e i n gd e l e t e d .T h e
n a m ey o u s u p p l yi n t h i s p a r a m e t ei rs t h e o n e w r i t t e nb y t h e
d i s k i n i t i a l i z a t i opnr o g r a m .
Fora simulation
a r e a i, t i s t h e n a m ea s s i g n ebdy t h e s i m u l a _
tion areaprogram$COpy.
The f ile deleteprogramcomparesthe namein the pACK
p a r a m e t ewr i t h t h e v o l u m el a b e lt o e n s u r et h e y
match. In
t h i sw a y ,t h e p r o g r a me n s u r etsh a t i t i s u s i n gt h e r i g h ta r e a .

UNIT Parameter
T h e U N I T p a r a m e t e(rU N | T - c o d et)e l l st h e p r o g r a mt h e
l o c a t i o no f t h e a r e ac o n t a i n i n g
t h e f i l e sb e i n gd e l e t e d .
P o s s i b lceo d e sa r e R 1 , F l , R 2 , F Z ,a n d t h o s ef o r t h e m a i n
dataareas.

DATE Parameter
T h e D A T E p a r a m e t e rc a n b e u s e d o n l y w i t h
L A B E L - f i l e n a m e . T h e D A T E p a r a m e t e r( D A T E - d a t e )
a p p l i e st o t w o o r m o r e f i l e st h a t h a v e t h e s a m e n a m e . l t
tells the program the date of the f ile you want to delete.
E v e r y f i l e h a s a d a t e , w h i c h i s g i v e nt o t h e f i l e a t t h e t i m e
it
i s c r e a t e d . W h e n t w o o r m o r e f i l e s h a v et h e s a m e n a m e , t h e
d a t e sa r e u s e d t o d i s t i n g u i s ho n e f i l e f r o m a n o t h e r .
l f t h e a r e ah a s m o r e t h a n o n e f i l e w i t h t h e n a m e y o u l i s t i n
t h e L A B E L p a r a m e t e r ,t h e y w i l l b e d e l e t e du n l e s sy o u u s e
t h e D A T E k e y w o r d a n d p a r a m e t e rt o i n d i c a t ea p a r t i c u l a r
f i l e . l f t h e D A T E k e y w o r d i s u s e d ,o n l y o n e f i l e n a m ec a n
b e g i v e n i n t h e L A B E L p a r a m e t e rf o r t h e c o n t r o t s t a t e m e n t .
T h e d a t e i s a s i x - d i g i tn u m b e r i n t h e f o r m m m d d y y o r
d d m m y y ( d - d a y ,m - m o n t h , y - y e a r ) B e s u r e t o s p e c i f y t h e
d a t e i n t h e f o r m s p e c i f i e dd u r i n g s y s t e mg e n e r a t i o n .
I n t h e D A T E p a r a m e t e r .b e s u r e t o s p e c i f y d a y , m o n t h , a n d
year in the same order as they were specified when you
c r e a t e dt h e f i l e .

LABEL Parameter
T h e L A B E L p a r a m e t ei rd e n t i ife st h e f i l e ( s )y o u w a n t t o
d e l e t ef r o m t h e a r e a . l t s f o r m d e p e n dos n t h e f i l e ( s )y o u
a r ed e l e t i n g :
Form

Files Deleted

LABEL-VTOC

AII of them.

L A B E L - fi l e n a m e

Only the f ile that is named. The name
can apply to more than one f ile. lf it
does, all of those files are deleted
unlessyou use a DATE parameter to
i d e n t i f y a p a r t i c u l a ro n e .

LABEL-'filename, Only the filesthat arenamed. A name
filename....'
can apply to more than one file. lf it
does, all of those f iles are deleted.
F i l e st h a t y o u w a n t t o d e l e t eu s i n g t h e
DATA parameter must be in separate
control statements. you can list as
m a n y f i l e n a m e sa s t h e s t a t e m e n tc a n
h o l d ; t h e s t a t e m e n tl e n g t h ,h o w e v e r ,i s
restricted to g0 or g6 characters.
A d d i t i o n a l R E M O V E s t a t e m e n t sm a y
b e u s e df o r a d d i t i o n a lf i l e n a m e s .

4-74

DATA Parameter
The DATA parameter allows you to erasethe file data as
well asthe VTOC entry.
l f Y E S i s c o d e d i n t h i s p a r a m e t e r ,t h e d a t a i n t h e f i l e
specified is removed and any referenceto it in the VTOC is
a l s o r e m o v e d . I n a d d i t i o n , t h e f o l l o w i n g i s i s s u e df o r e a c h
file removed,
,DATA

REMOVED FOR FILE XXXXXX
DATA OOOOOO'
D A T A - Y E S s h o u l d b e u s e do n l y i f f i l e s e c u r i t yi s r e q u i r e d .
The time neededto remove the data is much greater than
the time needed to remove only the VTOC entry.
l f N O i s c o d e d i n t h i s p a r a m e t e r ,o n l y t h e V T O C e n t r y f o r
t h e f i l e s p e c i f i e di s r e m o v e d . l f t h i s p a r a m e t e ri s n o t u s e d .
DATA-NO isassumed.

O C LC O N S I D E R A T I O N S
The followingOCL statements
are neededto loadthe file
d e l e t ep r o g r a m :
/ / L O A D$ D E L E T . c o d e
// RUN
The codeyou supplydependson the locationof the simulat i o n a r e ac o n t a i n i n g
t h e p r o g r a m .P o s s i b lceo d e sa r e R 1 ,
F l , R 2 ,F 2 .

EXAMPLES
DeletingOneof SeveralFilesHavingthe SameName
F i g u r e 4s - 4 5 , 4 - 4 6 , 4 - 4 7a, n d4 - 4 8s h o wt h e O C L s t a t e mentsand control statements
neededto deleteone of
s e v e r af li l e sh a v i n gt h e s a m en a m e .
Assumethat threef ileson a removabledisk havethe same
n a m e : I N V O l . T h e d a t e so f t h e s ef i l e sa r e6 1 1 6 / 7 6 ,
6 1 1 8 / 7 6a, n d 1 / 1 5 / 7 6 . Y o u w a n t t o d e l e t et h e v e r s r o n
d a t e d6 / 1 6 / 7 6 .

Explanation:
o T h e f i l e d e l e t ep r o g r a m i s l o a d e df r o m F 1 .
for File Delete
Figure445. OCL LoadSequence

File DeleteProgram-$DELET

4-75

Explanation:
o The area that contains the file being deleted is named
0 0 0 0 1 ( P A C K - 0 0 0 0 1i n R E M O V E s t a t e m e n t ) .
.

B e c a u s et w o o t h e r f i l e s h a v e t h e n a m e l N V O 1 , t h e d a t e
(061676) is neededto complete the identification of the
f i l e y o u w a n t t o d e l e t e( L A B E L - l N V O 1 a n d
DATE-061676).

o The main data area containing the file to be deleted is
D1 (UNIT.Dl).
Figure446. Control Statementto DeletaOne Versionof a File

Explanation:
The area that contains the file being deleted is named
0 0 0 0 1 ( P A C K - 0 0 0 0 1i n R E M O V E s t a t e m e n t ) .
B e c a u s et w o o t h e r f i l e s h a v et h e n a m e l N V O 1 , t h e d a t e
(061676) is needed to complete the identification of the
file you want to delete(LABEL-lNVO1 and
DATE-061676).
The main data area containing the file to be deleted is
D1 (UNIT-D1}.
.

The YES specification in the DATA parameter deletes
all data from the area containing information on the
s p e c i f i e df i l e .

Flgure4-47. Control Statementto DeleteOne Versionof a File
and lts Data

4-76

FreeingAllocated But UnusedSpaceon an Area
Figure4-48 showsthe FORMATcontrol statement.The
followingcontrol statementfreesany areason the simula'
tion areaR1 that havebeenallocatedbut arenot being
u s e d .T h i sc o n d i t i o nm a y e x i s tf o l l o w i n gt h e a b n o r m a l
t e r m i n a t i o n( s u c ha sa p o w e rf a i l u r eo r r e - l P L )o f a
programthat wascreatinga file,

Explanation:
o Freeany allocatedbut unusedspaceon the simulation
a r e aR 1 ( U N I T - R 1 )n a m e d0 0 0 0 1( P A C K - 0 0 0 0 1 ) .
Figure 448.

Control Statement to Freo Allocatod But Unused
Spact on a Simulation Area

Fife DeleteProgram-$DELET

4'17

P a s eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 g
By TNL: GN21-5674

File Compress
Program-$FCOMp

Copy Function

P R O G R A MD E S C R I P T I O N

The copy functioncopies(adds)the f ileson the maindata
a r e as p e c i f i e b
d y t h e F R O Mc o d et o t h e e x i s t i n gf i l e so n
the maindata areaspecifiedby the TO code.

T h ef i l e c o m p r e spsr o g r a mh a st h e f o l l o w i n gf u n c t i o n s :
o C o p yf i l e sf r o m o n e m a i nd a t aa r e at o a n o t h e rm a i n
data
a r e aw i t h o u ta l t e r i n gt h e f i l e si n e i t h e ra r e a .
o M o v ef i l e sw i t h i n t h e s a m em a i nd a t aa r e a .
o B a c ku p ( d i s kt o t a p e )a l l f i l e so r s e l e c t efdi l e sc o n t a i n e d
o n a m a i nd a t aa r e a ( s ) .
.

R e s t o r e( t a p et o d i s k )a l l f i l e so r s e l e c t efdi l e st o a m a i n
d a t aa r e a ( s ) .

The f ile compressprogramperformsonly one function
( c o p y ,m o v e ,b a c k u po, r r e s t o r ed) u r i n go n e e x e c u t i o n .

M O V E A N D C O P YF U N C T I O N S
T h ec o d ey o u s u p p l yi n t h e F R O Ma n dT O p a r a m e t e r s
d e t e r m i n ews h i c hf u n c t i o ni s p e r f o r m e d .l f t h e s a m em a i n
dataareacode is specifiedin eachof the parameters,
the
programperformsthe move (compress)
function. lf you
s u p p l yd i f f e r e n tm a i nd a t aa r e ac o d e si n t h e F R O Ma n d T O
parameters,
the programperformsthe copy function.

MoveFunction
Duringthe movefunction.the programremovesgapsfrom
betweenfiles by movingeachfile so that it occupiesdisk
s p a c ea d j a c e ntto t h e p r e v i o u fsi l e . l f C O M p R E S S _ Li O
s
s p e c i fe do r a s s u m e da,f t e rg F C O M pi s e x e c u t e d
t h e f i l e si n
the specified maindataareaoccupya contiguousspace
s t a r t i n ga t c y l i n d e r1 ; i f C O M p R E S S - Hi sl s p e c i fe d ,a f t e r
e x e c u t i o nt h e f i l e si n t h e s p e c i f i e m
d a i nd a t aa r e ao c c u p ya
contiguousspacethat endsat the highestnumberedavailable
c y l i n d e r( s e en o t e ) .

4-78

lf COMPRESS-H
i sls p e c i f i e ds,p a c ef o r t h e a d d e df i l e si s
allocated
b e g i n n i n fgr o m t h e h i g h e snt u m b e r e d
available
cylinder;otherwise,spacefor the addedf ilesis allocated
f r o m t h e b e g i n n i nogf t h e m a i nd a t aa r e a( c y l i n d e r1 ) .
Note: The file compressprogramattemptsto moveall
files into a contiguousspacethat eitherstartsat cylinder
1 o r e n d sa t c y l i n d e r1 6 6 ( 3 3 4 0 )o r c y l i n d e r1 8 6 ( 3 3 4 4 ) .
However,the file compressprogramwill not moveor copy
t h e $ S P O O Lo r t h e $ C C P D U M pf i t e ; i n a d d i t i o n i, f t h e
system'smeasurement
facility is active,the file compress
p r o g r a mw i l l n o t m o v ea $ M O N I T O Rf i l e . T h e r e f o r ei ,f a n
e x c e p t i o nf i l e ( $ S P O O L$, C C P D U M Po,r $ M O N t T O R )i s
encountered
duringthe movefunction,gapsmay exist
betweenthe lastrecord(f irst recordif COMPRESSHl is
specified)of the compressed
filesand the beginning(end
if COMPRESS-H
i sl s p e c i f i e do) f e a c ho f t h e e x c e p t i o n
fi les.

BACKUP
AND RESTORE
FUNCTIONS

RestoreFunction

The FROM or TO parameter.
which you specifyon a
control statement,determines
the function that is perf o r m e db y t h e p r o g r a m .l f y o u s p e c i f yt h e F R O Mp a r a m eter,the programperformsthe backupfunction;if you
specifythe TO parameter,
the programperformsthe restore
function. However,the programwill performonly one
functionduringone executionof the program. Therefore,
you cannotintermixcontrol statements
that haveFROM
and TO parameters.You can,however,specifya maximum
of 10 control statements
duringone executionof the
program.

Duringthe restorefunction,the file(s)is placedin the first
available
spacebeginningfrom cylinder1 (COMpRESS-LO),
Hnl d 3 3 4 0 ) ,o r c y l i n d e r1 g 6
c y l i n d e r1 6 6 ( C O M P R E S S - a
(COMPRESS-Hl
and 9344). The disk spaceallocatedto the
restoredfile is the sameamountthat wasallocatedto the
originalfile. Also.all characteristics
of the restoredfile
r.rxcept
locationand date arethe sameasthe originalfile.

BackupFunction
Duringthe backupfunction,the tape is createdasa multifile volume. The first block of informationon the tape
contains$FCOMPinformationabout the file. The
remainingblocksaredata blocks. The file(s)is blockedto
tapewith the blockingfactor specifiedon an OCL FILE
statement.

A parameteron the control statementenablesthe program
to selectany file on the tape. To locatethe file, the parameter usesthe file numberthat wasassigned
to the file during
the backupfunction. lf you omit this parameter,
the
programrestoresall the filesthat werecopiedduringthe
backupfunction.
After a file is restored,the FILE xxxxxxxx HAS BEEN
COPIEDFROM POSITIONzzzzON TApE message
is issued.
After a successful
restorefunction,the TAPE COpy lS
COMPLETEmessage
is issued.

Eachfile that is copiedis assigned
a number. This number
enablesthe programto locatethe file if you chooseto
restoreonly selectedfiles.
After a file hasbeencopied,the FILE xxxxxxxx HAS
B E E NC O P I E DT O P O S I T I O Nz z z zO N T A P E m e s s a gi e
s
issued.
After a successful
backupfunction,the TApE COpy lS
COMPLETEmessage
is issued.
The COMPRESS
keywordis ignoredif specifiedon the
backupfunction.

Fife Compress Program-$FCOMP

4-79

C O N T R O LS T A T E M E N TS U M M A R Y
The control statements
you mustsupplydependon the
desiredresults.
Functions

Control Statements

Copy filesfrom one
m a i nd a t aa r e at o
a n o t h e rm a i nd a t a
a r e ao
, r m o v ef i l e s
w i t h i nt h e s a m e
maindataarea

I / COPYFI LES F ROM-code.TO-code
[,PACKI N-name][,pACKO-name] ,coMPRESs{[I

B a c ku p a f i l e ( s )
from disk to tape
orrestoreafile(s)
from tapeto disk

// END

// TAPEFtLES
{f8ot}

// END

-cooet,r-eBEL-fitenamet
[,pACK-name]

[.orrr=r,{i;l
{*,,,.,,N
[,.o*,'

P A R A M E T E RS U M M A R Y
Parameter

Description

C O P Y FI L E S S t a t e m e n t
FROM'code

S p e c i f i e st h e l o c a t i o n o f t h e m a i n d a t a a r e at h a t c o n t a i n st h e f i l e s t o b e m o v e d
( c o m p r e s s e d ) o rt h e f i l e s t o b e c o p i e d . V a l i d c o d e sa r e t h o s e f o r t h e m a i n d a t a
areas.

TO-code

Specifiesthe location of the main data area that contains the files to be moved
(compressed)or receivesthe copied files. Valid codes are those for the main data
areas.

PACKIN-name

S p e c i f i e st h e n a m e o f t h e m a i n d a t a a r e at o b e u s e d a s t h e i n p u t a r e a ( c o p y f u n c t i o n ) o r t o c o n t a i n t h e m o v e d ( c o m p r e s s e df)i l e s ( m o v e f u n c t i o n ) .

PACKo-name

Specifiesthe name of the main data area to be used as the output area (copy
f u n c t i o n ) o r t o c o n t a i n t h e c o m p r e s s e df i l e s ( m o v e f u n c t i o n ) .

COMPRESS-LO

Allocates the first availablespacefor the file starting from the beginning of
the main data area(cylinderl).

COMPRESS-Hl

Allocates the first availablespacefor the file starting from the end of the
main data area (cylinder 166 for a 3340 or cylinder 186 for a33441.

Parameter

Description

T A P E F I L E SS t a t e m e n t
F ROM-code

Specifiesthe location of the main data area that contains the file(s) to be backed
u p . V a l i d c o d e sa r e t h o s e f o r t h e m a i n d a t a a r e a s .

TO-code

Specifiesthe location of the main data area to which the files are to be restored.
Valid codes are those for the main data areas.

LABEL-filename

S p e c i f i etsh e f i l e t h a t y o u c h o o s et o b a c ku p o r r e s t o r e .l f t h i s p a r a m e t ei rs
o m i t t e d ,a l l f i l e so n t h e m a i nd a t aa r e ao r t h e t a p ea r ec o p i e d .

PACK-name

S p e c i f i etsh e n a m eo f t h e m a i nd a t aa r e at h a t i s u s e da s i n p u t f o r a b a c k u pf u n c t i o n
or output for a restorefunction.

SEONUM-1

S p e c i f i etsh a t t h e f i r s t f i l e i s t o b e w r i t t e no n t a p ei m m e d i a t e lfyo l l o w i n gt h e
v o l u m el a b e l( b a c k u pf u n c t i o n ) .O r , s p e c i f i etsh a t a f i l e ( s ) s, t a r t i n gw i t h f i l e
number1 is to be readdurinothe restorefunction.

SEONUM-X

'
l f t h i s p a r a m e t ei rs s p e c i f i e od n t h e f i r s t c o n t r o ls t a t e m e n t h
, e program:
- W r i t e sf i l e n u m b e r1 o n t a p ei m m e d i a t e l fyo l l o w i n gt h e v o l u m el a b e l
( b a c k u pf u n c t i o n ) ;
- R e a d sa f i l e ( s )s t a r t i n gw i t h f i l e n u m b e r1 d u r i n gt h e r e s t o r ef u n c t i o n .
Whenthis parameteris includedon any control statementother than the first one,
the programincrementsthe file numberby 1 for eachfile processed.

SEONUM''number'

This parameterspecifies
the file numberwherefile processing
is to begin.

COMPRESS-LO

Allocatesthe first available
spacefor the file startingfrom the beginningof the
m a i nd a t aa r e a( c y l i n d e r1 ) .

COMPRESS-Hl

Allocatesthe first availablespacefor the file startingfrom the end of the main
d a t aa r e a( c y l i n d e r1 6 6 f o r a 3 3 4 0 o r c y l i n d e r ' 8
16 f o r a 3 3 4 4 ) .

F i f e C o m p r e s sP r o g r a m - $ F C O M P

4-81

P A R A M E T E RD E S C R I P T I O N

LABEL Parameter(TAPEFILESI

(COPYFILES)
FROM and TO Parameters

This optionalparameterspecifies
the nameof the file that
is to be backedup or restored.lf the programperformsthe
b a c k u pf u n c t i o na n d t h i s p a r a m e t ei rs o m i t t e d ,a l l f i l e so n
t h e m a i nd a t aa r e as p e c i f i e d
i n t h e F R O Mp a r a m e t earr e
copiedto tape (backedup).

T h e F R O Mp a r a m e t e(rF R O M - c o d es)p e c i f i etsh e m a i nd a t a
areathat containsthe filesto be movedor copied. The TO
parameterspecifies
the main dataareathat containsthe f iles
to be movedor receives
the filesspecifiedin the FROM
parameter.lf the FROM and TO parameters
arethe same,
the fileson the specified main dataareaare moved. lf the
parameters
aredifferent,the f ilescontainedin the main
dataareaspecifiedby the FROM parameterarecopiedto
the maindataareaspecifiedby the TO parameter.

lf the programperformsthe restorefunction and this
parameteris omitted,the programcopiesor attemptsto
copy all filesfrom the tapeto the maindataareaspecified
in the TO parameter(restore).lf the programcannotfind
sufficientdisk spacefor the f iles,a message
is issued.

PACKINand PACKOParameters
(COpyFlLESI

PACK Parameter(TAPEFILES)

Theseparameters
areoptional. They are usedto verify that
the correctdata moduleis onlineand/orthe correctmain
dataareahasbeenspecified.Eitherone or both parametersmay be supplied.

Thisoptionalparameterspecifiesthe nameof the main
dataareathat eithercontainsthe input filesfor the backup
function or receives
the output filesfor the restorefunction.

COMPRESS
Parameter(COPYFILES)

(TAPEFl LESI
SEONUM Parameters

This parameterdetermines
the locationthat the file(s)will
be movedor copiedto relativeto the beginning(cylinder1)
o r t h e e n d ( c y l i n d e r1 6 6f o r a 3 3 4 0o r c y l i n d e r1 g 6 f o r a
3344) of the maindataarea. The COMpRESS-LO
parameter causes
the file(s)to be movedto the availablespaceat
t h e b e g i n n i nogf t h e m a i nd a t aa r e a .T h e C O M p R E S S - H l
parameter
causes
the file(s)to be movedto the available
spaceat the end of the maindataarea.

D u r i n gt h e b a c k u pf u n c t i o n ,t h i s o p t i o n a lp a r a m e t e r
( S E O N U M - 1s)p e c i f i etsh a t t h e f i r s t f i l e p r o c e s s ef do r t h e
control statementis to be assigned
file number1 and written
to the first locationon tape. Duringthe restorefunction,
t h e f i r s t f i l e t h a t t h e p r o g r a mr e a d si s f i l e n u m b e r1 .

FROM Parameter(TAPEFILES)
The FROM parameter(FROM-code)servesa duarpurpose.
It tellsthe programto performthe backupfunction. lt
alsospecifies
the main dataareathat containsthe filesto
be backedup.

(TAPEFt LES)
TO Parameter
The TO parameter(TO-code)serves
a dual purpose.lt tells
the programto performthe restorefunction. lt alsospecifiesthe maindataareathat is to receivethe restoredfiles.

The optionalparameterSEQNUM-Xcauses
the programto
operatedifferentlydependingon whenthe control statement containingthe parameteris processed.lf you specify
this parameteron a singlecontrol statementor the first
control statementof a group,the programoperationis the
s a m ea sw h e ny o u s p e c i f yt h e p a r a m e t eSr E O N U M - l . l f
you specifySEONUM-Xon any control statementexcept
the first one,the programincrementsby 1 the file number
that wasassigned
to the lastfile processed
and assigns
the
updatednumberto the first file processed
for this control
statement.
D u r i n gt h e b a c k u pf u n c t i o n ,t h e o p t i o n a lp a r a m e t e r
S E O N U M - ' n u m b earl'l o w sy o u t o a s s i g tnh e f i r s t f i l e n u m ber and the locationto the first file orocessed
for the
control statement.
D u r i n gt h e r e s t o r ef u n c t i o n ,t h e S E O N U M - ' n u m b epra' r a m eterallowsyou to selectthe startinglocationof the file(s)
to be restored.

P a g eo f G C 2 1 - 5 ' 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r 1 9 7 9
By TNL: GN21-5674

TT
A P E F LI E S I
C O M P R E SP
S A T A M C I( E
T h e C O M P R E S pSa r a m e t ei rs i g n o r e df o r t h e b a c k u pf u n c t i o n . D u r i n gt h e r e s t o r ef u n c t i o n ,t h i s p a r a m e t esrp e c i f i e s
w h e r et h e f i l e i s t o b e l o c a t e dr e l a t i v et o t h e b e g i n n i n g
a n dt h e e n d i n gc y l i n d e r so f t h e m a i nd a t aa r e a . l f
C O M P R E S S - LiO
s s p e c i f i e dt h
, e f i l e ( s )w i l l b e l o c a t e di n t h e
f i r s t a v a i l a b lsep a c es t a r t i n ga t c y l i n d e r1 ; i f C O M P R E S S - H l
i s s p e c i f i e dt h
, e f i l e ( s )w i l l b e l o c a t e di n t h e f i r s t a v a i l a b l e
s p a c et o w a r dt h e e n d c y l i n d e ro f t h e m a i nd a t aa r e a .

o A $ S P O O L$, C C P D U M Po,r $ M O N I T O Rf i l e i s n o t
copiedif encounteredduringthe copy, move,or backup
f unction.
.

ment.
o $ F C O M P a t t e m p t s t o c o p y a l l f i l e s ( r e g a r d l e sosf t h e i r
s i z e ) ,o n e f i l e a t a t i m e , f r o m o n e m a i n d a t a a r e at o
a n o t h e r m a i n d a t a a r e a . l f a f i l e i s e n c o u n t e r e do n t h e
F R O M m a i n d a t a a r e at h a t w i l l n o t f i t i n t o t h e a v a i l a b l e

C O N SD
I ER A T I O N SA N D R E S T RI C T I O N S

s t o r a g es p a c eo n t h e T O m a i n d a t a a r e a ,t h e n $ F C O M P
i s s u e sa m e s s a g ea n d h a l t s . T h e m e s s a g ei d e n t i fi e s t h e
f i l e t h a t d i d n o t c o p y a n d i n f o r m s t h e o p e r a t o ro f t h e
a v a i l a b l eo p t i o n s . T h i s s i t u a t i o na p p l i e st o a l l f i l e s ,
r e g a r d l e s os f t h e i r l o c a t i o n ( c y l i n d e r s1 t h r o u g h 16 6 o n
a 3 3 4 0 , o r c y l i n d e r s1 t h r o u g h 1 8 6 o n a 3 3 4 4 1 .

o F i l ec o m p r e sps r o g r a mf u n c t i o n sa r ee f f e c t i v eo n l y f o r
m a i nd a t aa r e a s .
o

U n e x p e c t e dm e s s a g easn d a n u n u s a b l ef i l e c a n r e s u l t
f r o m c a n c e l i n gt h e p a r t i t i o n t h a t i s e x e c u t i n gt h e f i l e
compressprogram.

o O n l y t h e a c t u a l r e c o r d so f a f i l e a r e c o p i e d t o t a p e
( b a c k e du p ) . W h e n t h e l a s t r e c o r d o f a f i l e i s c o p i e d , t h e
p r o g r a m c o n s i d e r st h e f i l e c o m p l e t e l y c o p i e d , e v e n
t h o u g h t h e r e m a y b e m o r e s p a c ea l l o c a t e dt o t h e f i l e .

o A f i l e w i t h t h e s a m en a m e a n d d a t e a s a f i l e i n t h e T O
a r e ai s n o t c o p i e d .
o An indexedmultivolumef ile is not copied if two
i n d e x e d m u l t i v o l u m e f i l e s a l r e a d ve x i s t i n t h e T O a r e a .

.

o A m u l t i v o l u m e f i l e w i t h t h e s a m en a m e a s a n e x i s t i n o
f i l e i n t h e T O a r e ai s n o t c o o i e d .
o

.

o

When the backup function is used to copy one or more
d i s k f i l e s t o t a p e o r t h e r e s t o r ef u n c t i o n i s u s e dt o c o p y
one or more tape filesto disk,the entiremain data area
o n t h e d i s k i s d e d i c a t e dt o t h e p a r t i t i o n . l f a n y f i l e s
a r e a l l o c a t e do n t h e m a i n d a t a a r e a ,t h e p a r t i t i o n w i l l
issuea message.

A f i l e w i t h t h e s a m e n a m e a s a n e x i s t i n gm u l t i v o l u m e
f i l e i n t h e T O a r e ai s n o t c o p i e d .
T h e L O C A T I O N p a r a m e t e ro n t h e F I L E s t a t e m e n tm u s t
be changed after the file is moved.

F I L E S T A T E M E N TC O N S l D E R A T I O NASN D
R E S T R I C T I O N(SB A C K U PA N D R E S T O R E }
.

o

A l l m a i n d a t a a r e a c o d e sa r e v a l i d f o r t h e T O a n d F R O M
p a r a m e t e r so n t h e C O P Y F I L E S o r T A P E F I L E S s t a t e -

A f i l e i s n o t c o p i e d w h e n s p a c ei s n o t a v a i l a b l ei n t h e
TO area.
F i l e c o m p r e s sp r o g r a m c a n n o t e x e c u t e i f s p o o l i s a c t i v e
o n t h e p a c k s p e c i f i e di n t h e T O p a r a m e t e r . S t o p s p o o l
u n t i l $ F C O M P h a sf i n i s h e d .

o The location of the spacethat is allocated for an added
f i l e ( s ) i s d e t e r m i n e db y t h e s m a l l e s ta v a i l a b l es p a c et h a t
w i l l c o n t a i n t h e f i l e ( s ) . l t i s p o s s i b l ef o r a n a d d e d f i l e t o
b e l o c a t e dn e a r t h e l o w e n d o f t h e m a i n d a t a a r e ae v e n
t h o u g h C O M P R E S S - H li s s p e c i f i e d . L i k e w i s e ,a n a d d e d
f i l e c a n b e l o c a t e da t t h e h i g h e n d o f t h e m a i n d a t a a r e a
e v e n t h o u g h C O M P R E S S - L Oi s s p e c i f i e d .

C o n v e r s i om
n u s t b e s p e c iife dw h e n 7 - t r a c kt a p ei s u s e d .

o T h e r e c o r df o r m a t ( R E C F M ) e n t r yd e f a u l t st o f i x e d ( F )
e v e ni f a n o t h e rf o r m a t i s s o e c i fe d .
o l f a n E N D p a r a m e t eirs n o t s p e c iife d ,t h e d e f a u l ti s
U NL O A D .
o B A C K U Pm u s tb e s p e c i f i e a
d st h e N A M E p a r a m e t e r .
o T h e r e c o r dl e n g t hi s a l w a y se q u a lt o t h e b l o c kl e n g t h .
T h e v a l i db l o c k l e n g t h sa r e :
1536
3072
6144
12288
24576

1 / 8 - t r a c kt r a n s f e r( d e f a u l vt a l u e )
1 l4-tracktransfer
1|Z-tracktransfer
1-tracktransfer
2-track transfer

F i f e C o m p r e s sP r o g r a m - $ F C O M P

4-83

-5162-1
Page
of GC21
lssued
28 September
1979
B yT N L : G N 2 1 - 5 6 7 4
e A labeledtapemust be usedto ensurethat
the tapefile
sequence
can be displayedat a latertime. (A REEL
parametermust be specifiedon the FILE statement.)
o The SEONUMkeyworddefaultsto the
valuespecified
on the TAPEFILESstatement.
o The labelof the tapefor the file is the
sameasthe
headerlabel.

EXAMPLES
F i g u r e s4 - 4 9 , 4 - 5 0 , 4 - 5 1a,n d4 - 5 2s h o wt h e O C L a n dc o n _
trol statements
to copy and movefiles.
Figures4-53 through4-bg showthe OCL and control state_
mentsto backup and restorefiles.

o Multivolumetapefilesaresupported.

OCLCONSIDERATIONS
The followingOCL statements
are neededto load the file
compressprogram:
// LOADgFCOMp,code
// RUN
The codeyou supplydependson the locationof the simulationareacontainingthe program. possiblecodesare R1,
F l , R 2 ,F 2 .

Explanation:
T h ef i l e c o m p r e sps r o g r a mi s l o a d e df r o m F 1 .
Controlstatementexplanation
:
- T h ef i l e so n t h e m a i nd a t aa r e a
o n d r i v e2 ( F R O M - D 2 )
areadded(copied)to the existingfileson the main
dataareaD3 (TO-D3).
Figure 4-49. OCL and Control Sratements for Copying
Files

4-8r'.

Explanation:
o The f ile compressprogramis loadedfrom F 1.
o Control statementexplanation:
- The fileson the maindataareaon drive2 are
moved
( FR O M - D 2 , T O _ D 2 ) .
- T h e n a m eo f t h e m a i nd a t aa r e ao n d r i v e2 i s
v e r i fi e d
(PACKtN-D2D2D2l.
Figure 4-50. OCL and Control Statements for Moving Files

Explanation:
o T h e f i l e c o m p r e spsr o g r a mi s l o a d e df r o m F 1 .
.

Controlstatementexplanation:
- T h ef i l e so n t h e m a i nd a t aa r e ao n d r i v e1 ( F R O M - D 1 )
a r ea d d e d( c o p i e dt)o t h e e x i s t i n gf i l e so n t h e m a i n
dataareaon drive2 ITO-D21
.
- The filesareaddedto the high end of the main
data
a r e ao n D 2 ( C O M P R E S S - H t ) .

F i g u r e 4 - 5 1 . C o p y F i l e sf r o m a M a i n D a t a A r e a t o t h e H i g h E n d
of Another Main Data Area

F i l e C o m p r e s sP r o g r a m - g F C O M P

4-85

Explanation:
o T h ef i l e c o m p r e sps r o g r a mi s l o a d e df r o m F 1 .
o Controlstatementexplanation:
- The fileson the main dataareaon D2 are moved
toward the beginningof the main dataarea
(COMPRESS-LO).
Figure 4-52. Move Files toward the Beginning of th€ Main Data Ar6a

Explanation:
The file compressprogramis loadedfrom F 1.
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e f i l e n a m ei s a l w a y sB A C K U P( N A M E - B A C K U P ) .
- T h ec o p y w i l l g o t o t a p eu n i t 2 ( U N I T - T 2 ) .
- The tapeunit is a 9-trackdrive.
- T h et a p ev o l u m el a b e li s O N E ( R E E L - O N E ) .
o Controlstatementexplanation:
- T h e f i l e sa r el o c a t e do n d r i v e3 ( F R O M - D 3 1 .
- The first filesarecopiedto the first positionon tape
(sEoNUM-1).
- The packnameon drive3 must be MASTER
(PACK.MASTER).
Figure 4-53. OCL and Control Stat€monts to Back Up Ail the Files
on a Main Data Area to Tape

4-86

Explanation:
o The file compressprogramis loadedfrom R
1.
.

l n p u t f i l e ( O C Ls e q u e n c e ) :
- T h e f i l e n a m ei s a l w a y sB A C K U P( N A M E _ B A C K U P ) .
- The backupfilesarecontained
on tapedrive 1
(UNIT.T1).
- T h e l a b e lo f t h e t a p ev o l u m ei s
BACKI
(REEL-BACKl).
- Tapeunit 1 is a 9-trackdrive.
- B l o c ka n d r e c o r dl e n g t h sa r e
6 1 4 4( B L K L _ 6 1 4 4 ) .

o Controlstatementexplanation:
* The backupfilesarecopied
to drive 2 (TO_D21.
- The files arecopiedstartingat
the f ifth position
( S E O N U M - 5o)n t h e t a p e .
Figure 4-54. OCL and Control Statements to Rostor€ tho
Filss
from a Specific File Numbor

F i l e C o m p r e s sP r o g r a m - g F C O M P

4-87

Explanation:
T h e f i l e c o m p r e spsr o g r a mi s l o a d e df r o m R 2 .
.

O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h ef i l e n a m ei s a l w a y sB A C K U P( N A M E - B A C K U P ) .
- T h e f i l e sa r ec o p i e dt o t a p eu n i t 4 ( U N I T - T 4 ) .
- T h e t a p eu n i t i s a 9 - t r a c kd r i v e .
- Block and recordlengthsare 12288(BLKL-122881
.
- T h e l a b e lo f t h e t a p ev o l u m ei s T A P E ( R E E L - T A P E ) .
- The tape remainsin the positionit wasin after the
l a s tr e c o r di s w r i t t e n ( E N D - L E A V E ) .

Figure 4-55. OCL and Control Statements to Back Up Selected Files

a C o n t r o ls t a t e m e net x o l a n a t i o n :
- T h ef i l e n a m e dP A Y R O L( L A B E L - P A Y R O Li s)
c o p i e df r o m d r i v e1 ( F R O M - D 1 t)o t h e f i r s t p o s i t i o n
o n t a p e( t h ed e f a u l to f t h e S E O N U Mp a r a m e t eirs
p o s i t i o n1) .
- T h ef i l e n a m e dH O U R W K( L A B E L - H O U R W Ki s)
c o p i e df r o m d r i v e2 ( F R O M - D 2t)o t h e s e c o n d
p o s i t i o no n t a p e .
- T h ef i l en a m e dM A S T E R( L A B E L - M A S T E Ri s)
c o p i e df r o m d r i v e3 ( F R O M - D 3t)o t h e t h i r d p o s i t i o n
on tape.
- T h ef i l e n a m e dB A C K U P( L A B E L - B A C K U P
i s)
(
F
R
O
M
D
4
)
f
r
o
m
f
o
u
r
t
h
copied
d r i v e4
to the
positionon tape.
- T h ef i l e sn a m e dP E R S O N EaLn dZ I P C O D E
(L A B E L - P E R S O N
L ,EL A B E L - Z I P C O D a
Er)ec o p i e d
f r o m d r i v e1 ( F R O M - D 1 t)o t h e f i f t h a n d s i x t h
positions.
- T h e f i l e sn a m e dF E D T A X ,S T A T A X ,F I L E A . a n d
F I L E Ba r ec o p i e df r o m d r i v e2 ( F R O M - D 2t)o t h e
s e v e n t he,i g h t h ,n i n t h ,a n d t e n t h p o s i t i o n s .
- T h e p a c kn a m ei s W O R K l o n d r i v e' l.
- T h e p a c kn a m ei s W O R K 2o n d r i v e2 .

Explanation:
o The file compressprogramis loadedfrom F2.
.

I n p u t f i l e ( O C Ls e q u e n c e ) :
- T h ef i l e n a m ei s a l w a y sB A C K U p( N A M E - B A C K U P ) .
- T a p eu n i t 3 c o n t a i n st h e b a c k u pf i l e s( U N I T - T 3 ) .
- T h e l a b e lo f t h e t a p ev o l u m ei s T A p E I
( RE EL - T A P E
1).
- Blockand recordlengthsare24576 (BLKL-24S76).
- T a p eu n i t 3 i s a 7 - t r a c kd r i v e( C O N V E R T - O N ) .
- CONVERT-ON
i n d i c a t edsa t ac o n v e r s i o n .

o C o n t r o ls t a t e m e net x p l a n a t i o n :
- T h ef i l e n a m e dM A S T E R( L A B E L . M A S T E Ri s)
c o p i e dt o d r i v e1 ( T O - D 1 )f r o m t h e t h i r d p o s i t i o no n
t a p e( S E Q N U M - 3 ) .
- T h e p a c kn a m em u s tb e W O R K l o n d r i v e1
( P A C K . W OKR1 } .
- T h ef i l e n a m e dP A Y R O L( L A B E L - P A Y R O Li s)
c o p i e dt o t h e l o w e n d ( C O M P R
E S S - L Oo) f t h e m a i n
d a t aa r e ao n d r i v e1 ( T O - D 1 )f r o m t h e f i f t h p o s i t i o n
o n t a p e( S E O N U M - 5 ) ,
- T h e f i l e n a m e dW O R K ( L A B E L - W O R Ki)s c o p i e d
to drive 2 (TO-D2\from the fourth positionon tape

(sEoNUM-4).
-

-

-

-

T h e p a c kn a m em u s tb e W O R K 2o n d r i v e2
(PACK-WORK2).
T h e f i l e n a m e dU P D A T E( L A B E L - U P D A T Ei )s
c o p i e dt o t h e h i g he n d ( C O M P R E S S - Holf) t h e m a i n
data areaon drive 2 (TO-D2lfrom the seventh
p o s i t i o no n t a p e( S E O N U M - 7 ) .
T h e f i l e n a m e dM A S T E R( L A B E L - M A S T E Ri )s
c o p i e dt o d r i v e3 ( T O - D 3 )f r o m t h e t h i r d p o s i t i o no n
t a p e( S E O N U M - 3 ) .
T h ef i l e n a m e dB A C K U P( L A B E L - B A C K U P
i s)
copiedto drive4 (TO-D4)from the secondposition
o n t h e t a p e( S E O N U M - 2 ) .
T h e p a c kn a m em u s tb e W O R K 4o n d r i v e4
(PACK.WORK4}.

Figure 4-56. OCL and Control Statements to Restoro S€lected Files

F i l e C o m p r e s sP r o g r a m - $ F C O M P

4-89

Explanation:
o The file compressprogramis loadedfrom F2.
o O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e f i l e n a m ei s a t w a y sB A C K U P( N A M E - B A C K U P ) .
- T h e b a c k u pf i l e sa r ec o p i e dt o t a p eu n i t 3 ( U N I T _ T 3 ) .
- The tape unit is a 9-trackdrive.
- The block and recordlengthsare 1536 (default
value).
- The labelof the tapevolumeis MASTER
( RE EL - M A S T E
R} .
a Controlstatementexplanation:
- T h e f i l e n a m e dM A S T E R( L A B E L - M A S T E R )
is
c o p i e dt o p o s i t i o nI ( S E O N U M - 1o)n t h e t a p e .
- The fileslocatedon drive 2 are copied
to the tape
s t a r t i n ga t p o s i t i o n2 ( S E O N U M _ 2 1 .
- The packnameon drive 2 must be pERSON
(PACK.PERSON).
Figure 4-57. OCL and Control Statements to Back Up Ono
Fil6
from a Main Data Area and All the Files from
Another Main Data Ar6a

4-90

Explanation:
.

The file compressprogramis loadedfrom F2.

o O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e f i l e n a m ei s a l w a y sB A C K U P( N A M E - B A C K U P ) .
- T h e f i l e sa r ec o p i e dt o t a p eu n i t I ( U N I T - T l
).
- The tapeunit is a 9-trackdrive.
- The block and recordlengthsare 1536 (defaulted).
- T h e l a b e lo f t h e t a p ev o l u m ei s T A p E ' l
( R E EL - T A P E)l .
o Controlstatementexplanation:
- T h e f i l e sl o c a t e do n d r i v e2 ( F R O M - D 2a) r ec o p i e d
t o t a p es t a r t i n ga t p o s i t i o n1 .
- T h e f i l e sl o c a t e di n d r i v e3 ( F R O M - D 3 a) r ec o p i e dt o
tape startingat the next availableposition.
Figure 4-58. OCL and Control Statements to Back Up All the
Files Containod on Two Main Data Areas

F i f e C o m p r e s sP r o g r a m - $ F C O M P

4-91

Explanation:
o The file compressprogramis loadedfrom F1.
o I n p u tf i l e ( O C Ls e q u e n c e ) :
- T h e f i l e n a m ei s a l w a y sB A C K U P( N A M E - B A C K U P ) .
- T h e b a c k u pf i l e sa r el o c a t e do n T 1 ( U N I T - T 1 ) .
- T h e l a b e lo f t h e t a p ev o l u m ei s T A P E ( R E E L - T A P E ) .
a Controlstatementexplanation:
- T h e b a c k u pf i l e sa r ec o p i e dt o d r i v e2 ( T O - D 2 ) .
- The copiedfilesarelocatedat the high end of the
m a i nd a t aa r e a( C O M P R E S S - H l ) .
Figure 4-59. Restore Backup Filos to the High End of the Main
Data Area

4-92

Pageof GC21 -5162-1
lssued 28 September 1979
By TNL: GN21-5674

SystemHistoryAreaDisplayProgram-$HIST
P R O G R A MD E S C R I P T I O N
The systemhistoryareadisplayprogramhasthe following
function:
Printand/orcopy to a deviceindependent
file a portion of
or the entiresystemhistoryarea(SHA).
The SHA is a specialareaon the systempack (the pack
f r o m w h i c ha n I P L w a sp e r f o r m e dt)h a t c o n t a i n st h e f o l l o w
i n gi n f o r m a t i o n :
o OCL statements
readby the system
.

The output of $HIST is an audit trail of systemactivity
that can be usedto debugprogramproblems.This output
will be copiedto a deviceindependentfile, for useby other
a u d i tp r o g r a m sb,y s u p p l y i n ga $ H I S T O R YF I L E s t a t e m e n t
( N A M E - $ H I S T O R Y )S. H A r e c o r d sw r i t t e nt o u n i t r e c o r d
devicesaretruncatedto the unit recordlength.
T h e S H A i s p r i n t e di f y o u s u p p l ya P R I N Tc o n t r o ls t a t e m e n t . T h eS H A i sc o p i e dn
, o t p r i n t e d ,i f y o u s u p p l ya n
OUTPUTcontrol statement.However,you must also
s u p p l ya F I L E s t a t e m e nwt i t h t h e O U T P U Tc o n t r o ls t a t e m e n t . T h e n a m eo f t h e f i l e m u s tb e $ H I S T O R Y .
You may choosenot to supplya control statement.lf so.
$ H I S Tw i l l p e r f o r mt h e f u n c t i o n so f t h e f o l l o w i n gc o n t r o l
:
statementand oarameter

O C L d i a g n o s t i ci s s u e d
/ / P R I N TH I S T O R Y . C U R R E N T

o Controlstatements
for systemserviceprogramsreadby
the system
o OCCenteredby the operator
o OCCdiagnostics
issued
o Systemmessages
issuecl

Note: The systemhistoryareacopy program($HACCP)
can be usedto copy the currentportion of the SHA to a
disk file. This programcan be automaticallyinvokedif
the communications
control program(CCP)is executing.
For informationabout the systemhistoryareacopy program ($HACCP),seethe IBM System/3Communications
Control Program SystemReferenceManual, GC21-7620.

Unit recordrestartmessages
Operatorresponses
to riystemmessages
Displayscreenimages

System History Area Display Program-$HIST

4-93

C O N T R O LS T A T E M E N TS U M M A R Y
The control statements
you supplydependon the desired
results.
Functions

Control Statement

P r i n tS H A e n t r i e s

PRr
NrHrsroRY.
| 3ih*.__|

Copy SHA entries
to a device
file
independent

ourpurHrsroRy.
I l.:k_rr, {

P A R A M E T E RS U M M A R Y
Parameter

Description

HISTORY.ALL

P r o c e sasl l e n t r i e si n S H A

H I S T O R Y - C URRE N T

Process
SHA entriesnot previouslyprintedand/or copied

P A R A M E T ER D E S C RI P T I O N S

OCLCONSIDERATIONS

HISTORYParameter

The followingOCL statements
are neededto loadthe
systemhistoryareadisplayprogram:

The HISTORYparameterallowsyou to selectwhich part
of the SHA that you wishto print and/orcopy. The entire
S H A i s p r o c e s s ei d
f H I S T O R Y - A L Li s s p e c i f i e d l.f
H I S T O R Y - C U R R E Ni T
s s p e c i f i e do,n l y t h o s ee n t r i e sn o t
previouslyprintedand/orcopiedare processed.lf the
PRINT or OUTPUTcontrol statementis omitted,
H fS T O R Y - C U
R RE N T i s a s s u m e d .

// LOAD $HlST,code
// RUN
The codeyou supplydependson the locationof the simulation areacontainingthe program.Possible
codesare R 1,
F l , R 2 ,F 2 .
The followingOCL statements
are neededto loadthe system historyareadisplayprogramand copy the output to a
devicesupportedby device-independent
data management:
// LOAD $HlST,code
/ l F I L E N A M E - $ H I S T O R Y , U N I T - c o .d.e.,
// RUN

4-94

Figure4-60 is a sampleprintout of the systemhistoryarea.
F o r a d d i t i o n ailn f o r m a t i o nr e g a r d i ntgh e e n t r i e si n t h e
P R I N T S Y S T E MH I S T O R YA R E A -

$HIST

ALL

systemhistoryarea,seethe appropriaterelatedpublication
listed in the Preface.

P A G EO ] , 3

DAlE L2/3\/15

T I I ' 1 E0 0 . 0 4 . 5 5

o l^
RooB
rpL
Ot
( , ) E N T E RS Y S T E M
DATE
.
( $ - $ rD 0D D], r
l a r a H O D U L ED 1 D ] , D 1r, s o N D l ,
I
l s - $ t D 0 D D 2 r
D A T AM O D U L E
D 2 D 2 D 2t s o N D 2
f-Dl {$
- s rDoDD3 I
D A T AM O D U L D
E 3 n 3 D 3r 5 0 N D 3
I
f i - $ r D O D D 4 r
\
D A T AM O D U L D
E 4 D 4 D 4I S O N D 4
o 1
ROos
rPL
rvD l l
|
1,2/3L/75
3 CT EJ
F], D1a rPLtD
(3
D
P R O G R AEMN D
\
- 2 cT EJ
F], D],A IPLFD
D
a- 5 ) { 2
P R O G R AEMN D
/
l, cr FJ
D
Fl DtA IPLED
1
' r 1i ,
P R O G R AEMN D
>/Tr.4 1,02738
Q)s SP
(\ - \ sP UT FA I
S P O O LF I L E S T A R T E -D N E !,,D] 4 , 5 0 , 4
I
l 1 - l S P U T 5 A t
s P 0 0 L r s A c T r v EP l ,
r- Dl 11
- t sPuT sA I
s e o o L r s A cr r v E p 2
f
- r sP uT sA r
I r
\^.
s P o o L I s A c T I V EP 3
. Q ) s- n
s lF cB
D L23
6Dls
Q r 5 t- s l , 4 4 2 R E S T A R T t D
s rF cB
D 7,23
6!Drs
1 4 4 2 N O TR E A D Y
( 1 2 ) DR o
( l r ) 1 1 s r , 4 4 2R E S T A R T E D
- (r)cru
"noaq
6\.r Y-- s sP uT Re r
\7 rn.
R D R QI S C A N C E L E D

^ 9 )-, l) n)-P

ur Kr I
S P O O L R D R T t R MI N A T E D
P\,L442
^Q9nua
1 CT EJ
Fl D],A
D
Q')I
( L / / t { A I N T J O B P A R T IT I O N - 1
/ / L O A D$ M A I N T , F I ,
^lL

(E)lJ
.v ,_.

I PLED

Q!J{t zz nuru

R -, F ] , , R E T AI N _ R , L I B R A R Y _ 0 N
, A M E _$ T R A C E
I 1 , / / C O P Y F R O I . , I _ R E A D TEO
\1, // END
- I CT ES
I
M
A
T
N
T
$MAIiJTOI,
r1
1 2 / 3 L / 7 5 ! 0 . 3 1 . 1 9 t O . 3 1. 2 5
^ I
( 1 1 ) <1 , / .
- | t i , c T E J
M A r N T
r
s r E p
\.
1,2/31,/15 LO.t.1"9
),O.3L.26
( L / /HI ST JOB PARTITION_],
t t C A L L A B ,F t
^\t
(9)1 r xxDH L0aD $Hr sT, Fl,

/r, xx RUN
\ l./ / RUN
(!)r ri

f;') i' // PRINT HISToRY-cURRENT
\7lt
// END
- 1 cT Es
I
HIST
DH
/r,
1 , 2 / 3 L / 1 51 0 . 3 1 , . 2 6t 0 . 3 1 . 3 7
^\
/'
@'tL
- 1, CT EJ
I
HIST
STEP
/1
\.
1 , 2 / 3 ' 1 , / 7 5L 0 . 3 1 , . 2 6 1 0 . 3 1 . 3 8

DH
a
AJs - s sP ur cF D ol, HrsT
\:/I
C H A N G T F O R M T o T Y . P EB B B
- t s p u r R ED t 3 J o B
sTrp
f' .D- . J_ lr
RDRQ rS EMPTY/HELD
g)s i, s sP uT cF D ol, HrsT
DH

/;i\l 5
\17t
(2 -

5 SP UT TM I
HIST
DH
L2/3L/75 Lo.32.02 10.32.53 pRT
2 Cr EJ
Ft DtA IPLED
D

lz //^

G\) 2 / /
\:/\2
//
lz tt
\2 //

JoB

LOAD $Hl ST,Fl,
RUN
catnlr HIsToRy-ALL
END

Figure 4-60 (Part 1 of 21. Printout of System History Area

System History Area Display Program-$HIST

4-95

@

ffris systeminformationmessage
indicateswhich
3 3 4 0d a t am o d u l e sa r eo n l i n ea t I P L t i m e .

(ES)and end of job (EJ) messages.
These
@ enOof step
message
a sr ei n f o r m a t i o n a(ll ) . T h e yd o n o t r e q u i r e
a r e s p o n s eJ.o b n a m ei s M A I N T . P r o g r a m
n a m ei s
j
o
b
n
u
m
b
e
r
i
s
S
t
e
p
0
1
.
T
h
e
s
t
e
p
w a se x e $MAlNT.
cutedon 12131
/75. The time of day when program
s t a r t e de x e c u t i n gw a s 1 0 . 3 1 . 1 9t;h e p r o g r a me n d e d
e x e c u t i o na t 1 0 . 3 1 . 2 5 .

o

oorr.,o|. response
to the dateprompt.

@

@

f nO of job messagefor each partition indicates IPL
is complete.

T h i sm e s s a gi e
s a r e s u l to f p r e s s i ntgh e P R O G R A M
LOADkey.

@ o.," prompt.

OCI statements
to call a procedure(AB) which loads
e
x
e
c
u
t
e
s
and
$HlST.

@ Corn.und to displaythe systemhistoryareaon the
d i s p l a ys c r e e n .

@ C o r . u n d t o s e tt i m e o f d a y . F o r m a ti s H H . M M . S S .
@ Corrnund to startspool.

for $HlST.
@ Controlstatements

@ Spootstatusinformationalmessages.

aresimilarto @ . Programnameis
@ Sytt.tn messages
(DH).
by stepname
replaced

Ci) Cor.and to startspoolreader.

that wasissuedby spoolinforming
@ Syrt.r message
the operator to change forms.

causedby a 1442not readycondition.
@ Syrt.r message
asa resultof unit recordrestart.
@ M.rrug. generated

informingthe operatorthat the input
@ Syra.r message
q u e u ei s e m p t y / h e l d .

r ueue.
@ C o r r . n d t o d i s p l a yr e a d e q

@

to @with a 1 option.
Operatorresponse

@ Corrund to cancelreaderqueue.

@

SPOOf- time recording optional messageindicating

@

OCf-and control statementsusedto obtainthis
sampleprintout of the systemhistoryarea.

@ Corrund to assignthe 1442asthe systeminput

t i m e r e q u i r e dt o p r i n t ( P R T )t h e o u t p u t o f j o b n a m e
H I S T ,s t e p n a m D
e H.

d e v i c ef o r p a r t i t i o n 1 .

@ Partition1 is started.
@

OCf- and control statementsto load and execute a

program.
Figure 4-60 (Part 2 of 2). Printout of System History Area

4-96

EXAMPLES
Figure4-61 showsthe OCL statementto loadthe system
historyareadisplayprogram. Figures4-62 through4-66
showthe OCL and control statements
to print and/orcopy
t h ES H A .

Explanation:
o The systemhistoryareadisplayprogramis loadedfrom
F1.
Explanation:

.

T h e S H A i s c o p i e dt o t a p e( U Nl T - T 1) .

o The systemhistoryareadisplayprogramis loadedfrom
F1.

o T h e S H A i s p r i n t e d( P R I N Ts t a t e m e n t ) .

Figure 4-61. OCL Statement to Load the System History Area
Display Program

o All entriesof the SHA arecopiedand printed
(HISTORY-ALL).
Figure 4-63. OCL and Control Statements to Copy and Print All
Entri€s in the System History Area

Explanation:
o T h e o u t p u t i s p r i n t e d( P R I N T ) .
o A l l e n t r i e sa r ep r i n t e d( H I S T O R Y - A L L ) .
Figure 4€2.

Control Statoments to Print ths Entire Contents of
the System History Area

System History Area Display Program-$HIST

4-97

Explanation:
o The systemhistoryareadisplayprogramis loadedfrom
F1.
o The Fl LE statementcauses
the output to be copiedto a
d i s kf i l e o n D l ( U N I T - D )l .
o O u t p u t i s n o t p r i n t e d( O U T P U Ts t a t e m e n t o
) ;n l y t h e
c u r r e n te n t r i e sa r ec o p i e dt o t h e d i s kf i l e
(HISTORY-CURRENT).
Figure 4-54. OCL and Control Statements to Copy the Current
Entriss to a Disk File Without Printing

Explanation:
o The systemhistoryareadisplayprogramis loadedfrom
F1.
o The currententriesin the SHA are printed. (A control
s t a t e m e nat n d p a r a m e t ei rs n o t s u p p l i e d . )
Figure 4-65. OCL Statements to Print the Current Entries in the
System History Aroa

4-98

Explanation:
The systemhistoryareadisplayprogramis loadedfrom
F1.
S i n c ea c o n t r o ls t a t e m e nits n o t s u p p l i e dt,h e $ H I S T
programfunctiondefaultsto the followingcontrol
statement:
/ / P R I N TH I S T O R Y . C U R R E N T
The currententriesin the SHA arecopiedto a disk file.
T h e n a m eo f t h e f i t e i s $ H t s T o R y ( N A M E _ $ H t s T o R y ) .
T h ef i l e i so n D 1 ( U N t T - D 1 ) .
o The currententriesin the SHA areprinted.
Figure 4-66. OCL Statements to print and Copy the Currenl
Entrios in the System History Area

System History Area Display Program-$HIST

4-gg

DiskInitialization
Program-$l
NIT

T Y P E SO F I N I T I A L IZ A T I O N

P R O G R A MD E S C R I P T I O N

T h e r ea r ef i v e t y p e so f i n i t i a l i z a t i o n :

T h e d i s k i n i t i a l i z a t i opnr o g r a mh a st h e f o l l o w i n gf u n c t i o n s :

o F O R C Ei s u s e dp r i m a r i l yt o i n i t i a l i zae n e wv o l u m e .
T h i st y p e o f i n i t i a l i z a t i oenr a s easl l f i l e so n t h e e n t i r e
volume{a main data areaand its associated
simulation
a r e a)s.

o Writetrack and recordaddresses.
o Checkfor defectivetracks(a processcalledsurface
a n ayl s i s ) .

.

C L E A R i n i t i a l i z eas m a i nd a t aa r e aw i t h o u t c h e c k i n g
for activefiles. The areamust havebeenpreviously
initialized.

.

P R I M A R Yi n i t i a l i z eas m a i nd a t aa r e ai f t h e r ea r en o
activefiles in that area.

o Assignalternatetracksto any defectivetracks.
o W r i t ea v o l u m el a b e lt o i d e n t i f ve a c hv o l u m e .
.

Formatthe volumetableof contents(maindataarea
only).

B e f o r ee x e c u t i n g
t h i s p r o g r a my, o u s h o u l db e f a m i l i a rw i t h
t h e v o l u m ef o r m a td e s c r i b e idn P a r t3 o f t h i s m a n u a r .
A l l v o l u m e sm u s tb e i n i t i a l i z e db e f o r eu s e . V o l u m e st h a t
h a v eb e e ni n i t i a l i z e d
n e e dn o t b e r e i n i t i a l i z eudn l e s sy o u
want to erasetheir contentsand renamethem.
T h i sp r o g r a mc a n i n i t i a l i z ea m a x i m u mo f f i v ev o l u m e s
d u r i n go n e e x e c u t i o n .

o C Y L 0 i n i t i a l i z eosn l y c y l i n d e r0 o f a m a i nd a t aa r e a .
T h i si s a f a s tw a y t o r e i n i t i a l i zae m a i nd a t aa r e at h a t
h a d b e e np r e v i o u s liyn i t i a l i z e d .
o R E N A M Ei s u s e dt o c h a n g et h e n a m e ,l D , a n d N A M E 3 6 0
of a main dataareawithout affectingthe contentsof that
a r e a .T h e a r e am u s th a v eb e e np r e v i o u s l iyn i t i a l i z e d .
Note: Exceptfor FORCE,all typesof initializationapply
o n l y t o t h e m a i nd a t aa r e a .T h e s i m u l a t i o n
a r e ap r o g r a m ,
with the
$SCOPY,is usedfor other functionsassociated
simulation
areas.
CAUTION
C L E A R a n d F O R C Ee r a s ea n y a c t i v ef i l e so n t h e a r e a ( s ) .
C L E A Re r a s efsi l e so n l y i n t h e m a i nd a t aa r e a . F O R C E
erases
fileson the entirevolume(a maindata areaand its
associated
simulationareas).CYL0 destroysany current
VTOC entriesin the main dataarea.

4-100

C O N T R O LS T A T E M E N TS U M M A R Y
The control statementyou must supplydependson the
desiredresults.
Type of lnitialization

Control StatementsO

FORCE

FoRcr@,r*'t :":t,,} *o$.
// uINrypE.
{+3r}]
[.
{
I I V O L P A C K - n a m[e, l D - c h a r a c t e r[s, N
] AME360-characters]
// END

PRIMARY@

Fy-numberl
utNrypE-pRtMARy,uNtr
{ Ll'.r, I l,uril
V O L P A C K - n a m[e, l D - c h a r a c t e r[s, N
] A M E 3 6 G c h a r a c t e[r,sO] L D P A C K - n a m e ]
END

CLEAR@

CYLOO

u I N ryp E-cLEAR,u N I r-

[,V ER I Fy-nu mber]
"*'."r,}
{
V O L P A C K - n a m[e, l D - c h a r a c t e r[s, N
] A M E 3 6 G c h a r a c t e [r.sO] L D P A C K - n a m e ]
END
V o l u m ep r e v i o u s l y
initialized
ll

u r NT Y P E - c Y L o . u N r r - { : ,t }o :
['codes'I

t/ VO L PACK-name[, I D-characters]
[, NAME360-characters]
[,OLDPACK-characters]
// END

RENAME@

// urNrypE-RENAME,uNTT{;'"t,,}
I I VOL PACK-name
[,NAME360-characters]
[,lD-characters]
[,OLDPACK-characters]
// END

N o t e : T h e c o n t r osl t a t e m e n t d e f a u l t s t o T Y P E - F O R C
t hEeidf a t a m o d u l e i s s t iilnl S y s t e m / 3 7 0 f o r m a t a n d
T Y P E - C L E A Ro r P R I M A R Yi n i t i a l i z a t i o h
n a sb e e ns p e c i f i e d l.f C Y L Oo r R E N A M Ei s s p e c i f i e a
d n dt h e d a t a
moduleis still in System/370format. the systemissues
an error message.
O

C o n t r o ts t a t e m e n tasr er e q u i r e di n t h e o r d e rt h e y a r el i s t e d : U l N , V O L , E N D .

O On. VOL statementis requiredfor eachmain dataarealistedin the UNIT parameterof the UIN statement.The
PACK parameterin the first VOL statementappliesto the first main dataareadisk listedin the UNIT parameter.
The PACK parameterin the secondVOL statementappliesto the secondmaindataarealistedin the UNIT
paramerer.
O tt ,r'. TYPE parameteris omitted,TYPE-PRIMARY is assumed.

D i s k I n i t i a l i z a t i o nP r o g r a m - $ l N l T

4-101

P A R A M E T E RS U M M A R Y
Parameter

Description

UIN (lnput Definition) Statement
TYPE-FORCE

lf the TYPE parameterFORCEis used,a main dataareaand its associated
simulationareasare initializedwithout a checkfor activefiles.

TYPE-PRIMARY

P r i m a r yi n i t i a l i z a t i o (nm a i nd a t aa r e ao n l y ) . T r a c k sa l r e a d yi n i t i a l i z e a
d r er e i n itialized.The programdoesnot initializediskscontainingtemporaryor
permanentdatafiles.

TYPE-CLEAR

C l e a ri n i t i a l i z a t i o (nm a i nd a t aa r e ao n l y ) . T r a c k sa l r e a d yi n i t i a l i z e a
dre
reinitialized.Activefile checkingis bypassed
and any dataon the tracksis
destroyed.

TYPE-CYL0

C Y L Oi s a n a b b r e v i a t eidn i t i a l i z a t i o ni n, i t i a l i z i n g
o n l y c y l i n d e r0 o n a m a i n
dataareathat hasbeenpreviouslyinitializedon a System/3.This includes
r e w r i t i n gt h e v o l u m el a b e l( P A C K ) t. h e l D , a n d N A M E 3 6 0e n t r i e sa, n d
deletingany VTOC entriesthat may be presenton the main dataarea.

TYPE-RENAME

R E N A M Ei n i t i a l i z a t i oanp p l i e so n l y t o t h o s ee n t r i e so n c y l i n d e r0 o f a m a i n
dataareathat containthe volumelabel(PACK),lD. and NAME360.
Defaultvaluesfor lD and NAME360areusedif the parameters
arenot
supplied.

UN lT-code

One main dataarea. Possible
codesarethosefor the main dataareas.

UN|T-'code,code'

Multiplemain dataareas(maximumof five). Possiblecodesarethosefor
the main dataareas.

VERIFY-number

S u r f a c ea n a l y s i sD
. o n et h e n u m b e ro f t i m e si n d i c a t e d( n u m b e cr a nb e 1 - 2 5 5 1 .
V E R I F Y - 1 6i s a s s u m eidf t h e p a r a m e t ei sr o m i t t e d . T h i s p a r a m e t ei sr o n l y
u s e df o r T Y P E - C L E A Ra n dT Y P E - P R I M A R Yi n i t i a l i z a t i o n .

trRAstr_JNO I,
IYESJ

TYPE-FORCEinitializationonly. lf you do not want to retestdefective
tracksuseERASE-NO.lf you want to retestdefectivetracks,useERASE-YES.

VOL (Volume) Statement
PACK-name

Nameof the main dataarea. Cancontainany of the standardSystem/3charactersexceptapostrophes,
leadingor embeddedblanks,and embeddedcommas@.
Its lengthmust not exceed6 characters.

lD-characters

Additionalidentification.Can containany of the standardSystem/3characters
exceptapostrophes.
leadingor embeddedblanks,and embeddedcommasO.
Its lengthmust not exceed10 characters.lf you omit this parameter,blanks
a r ew r i t t e ni n t h e l D f i e l d .

4-102

Parameter

Description

NAME360-characters

Additionalidentificationforthe main dataarea. The namewill be placedin
the System/360format 1 DSCB. Cancontainany of the standardSystem/3
leadingor embeddedblanks,and embedded
exceptapostrophes,
characters
commasO. ,at lengthmust not exceed44 characters.lf you omit this
parameter,
the programdefaultsto SYSTEM/3.DATA.

OLDPACK-name

Currentnameof the maindataareato be initialized.Namecan be any of the
leadingor embedded
exceptapostrophes,
standardSystem/3characters
blanks,and embeddedcommasO. lts lengthmust not exceed6 characters.

O

t n ' , i s d u e t o t h e i r d e l i m i t e rf u n c t i o n .

PARAMETERDESCRIPTIONS

CLEAB lnitialization

TYPE Parameter(UlNl

T h e r e s u l t so f a C L E A R i n i t i a l i z a t i oanr ef u n c t i o n a l l y
e q u i v a l e nt o
t P R I M A R Ye x c e p t h a t C L E A R i n i t i a l i z e s
maindata areascontainingtemporaryor permanentdata
fi les.

The TYPE parameterindicatesthe type of initializationyou
, L E A R ,C Y L 0 ,o r
, O R C EC
w a n tt o d o : P R I M A R Y F
R E N A M E . T h e t y p e o f i n i t i a l i z a t i odne t e r m i n ews h i c h
t r a c k sw i l l b e i n i t i a l i z e d .

CAUTION
All temporarydatafilesor permanentdatafilesarecompletelyerased.

PR I MA R Y ln itial ization
P R I M A R Yi n i t i a l i z a t i oanp p l i e st o m a i nd a t aa r e a sy o u
haveusedbut want to initializeagain. Tracksthat were
p r e v i o u s liyn i t i a l i z e d
a r ei n i t i a l i z e d
a g a i n .A n y d a t ao n t h e
t r a c k si s d e s t r o y e d Y
. o u c a nu s eP R I M A R Yi n i t i a l i z a t i o n
asoften asyou want. However,the programwill not initializemain dataareascontainingtemporaryor permanent
datafiles. You mustdeletethe files usingthe file delete
p r o g r a m$ D E L E T .

CYL0 lnitialization
C y l i n d e zr e r o( C Y L 0 )i n i t i a l i z a t i ocna nb e u s e di f y o u w a n t
t o r e i n i t i a l i zoen l y c y l i n d e r0 .

RENAME lnitialization

FORCE lnitialization

n a y b e u s e di f y o u w a n t t o c h a n g e
R E N A M Ei n i t i a l i z a t i om
P A C K ,l D , a n d N A M E 3 6 0p a r a m e t e r sD. e f a u l tv a l u e sa r e
u s e di f t h e l D a n d N A M E 3 6 0p a r a m e t e rasr en o t s u p p l i e d .

F O R C Ei n i t i a l i z a t i oanp p l i e st o v o l u m e st h a t a r en o t f o r mattedfor System/3. FORCEmay alsobe usedto reinitialize an entirevolumethat you haveused.

Note: lt an invalidSystem/3labelis found during
n u s tb e d o n ew i t h
R E N A M Ei n i t i a l i z a t i o na,r e i n i t i a l i z a t i om
F O R C EC
, L E A R ,P R I M A R Y o, r C Y L 0 .

rVote.'The simulationareaprogram.$SCOPY,must be used
a f t e ra F O R C Ei n i t i a l i z a t i otno r e f o r m a t h e s i m u l a t i o n
areas.

D i s k I n i t i a l i z a t i o nP r o g r a m - $ l N l T

4-103

UNIT Parameter
T h e U N I T p a r a m e t e(rU N I T - c o d ei)n d i c a t etsh e l o c a t i o no f
t h e v o l u m ey o u w a n tt o i n i t i a l i z e .T h e p r o g r a mc a n i n i t i a l i z eu p t o f i v ev o l u m e sd u r i n go n e p r o g r a mr u n .
T h e f o r m o f t h e U N I T p a r a m e t edre p e n d os n t h e n u m b e ro f
v o l u m e sy o u a r ei n i t i a l i z i n g :

T h e p a r a m e t eEr R A S E - N Om e a n sn o t t o r e t e s t .l f y o u t e l l
the programnot to retest.it testsonly thosetracksto which
no alternatetracksareassigned.Alternatetrackspreviously
assigned
remainassigned.
Defectivetracksare not retestedif the ERASEparameter
i so m i t t e d .

o F o r o n ev o l u m e u
, s eU Nl T - c o d e .

SurfaceAnalysis

o For two volumes,useUN lT-'code,code'.

Surfaceanalysisis a procedurefor testingthe conditionof
tracks. lt consistsof writing test dataon tracks,then readproperly.
i n gt h e d a t at o e n s u r et h a t i t w a sr e c o r d e d

Possible
codesarethosefor the maindataarea.
F o r a l l i n i t i a l i z a t i o nt h, e o r d e ro f c o d e sm u s tc o r r e s p o ntdo
t h e o r d e ro f V O L c o n t r o ls t a t e m e n t sl.f , f o r e x a m p l ey, o u
h a du s e dt h e p a r a m e t eUr N I T - ' D 1 , D 2 't,h e f i r s t V O L s t a t e m e n ta p p l i e st o t h e d a t am o d u l eo n d r i v e1 , a n d t h e s e c o n d
to the data moduleon drive 2.

VERIFY Parameter
r )s, e do n l y f o r
r ERIFY-numbeu
T h eV E R I F Y p a r a m e t e( V
C L E A Ra n d P R I M A R Yi n i t i a l i z a t i ocno n c e r n s u r f a c e
a n a l y s i sl.t e n a b l eyso u t o i n d i c a t et h e n u m b e ro f t i m e s
you want the programto do surfaceanalysison suspected
defectivetracksbeforejudgingwhetheror not tracksare
defective.The numbercan be from 1 to 255.

E R A S EP a r a m e t e(rU l N l
T h e E R A S Ep a r a m e t ecro n c e r nas l t e r n a t ter a c ka s s i g n m e n t .
I t a p p l i e so n l y t o v o l u m e st h a t h a v ea l r e a d yb e e ni n i t i a l i z e d
a n du s e d b
, u t w h i c hy o u a r er e i n i t i a l i z i nugs i n g
T Y P E - F O R CiE
n i t i ai lz a t i o n .
The conditionof trackson suchvolumeswastestedat least
o n c eb e f o r e( d u r i n gt h e p r e v i o u si n i t i a l i z a t i o na)n d t r a c k s
that werefound to be defectiveduringsurfaceanalysiswere
assigned
alternates.The ERASEparameter,
therefore,
enablesyou to indicatewhetheryou want the programto
(1) retestthe tracksto which alternatetracksarealready
assigned
or (2) leavethe alternatetracksassigned
without
retestingthe tracks.
T h e p a r a m e t eEr R A S E - Y E S
m e a n st o r e t e s t .l f y o u t e l l t h e
programto retest,it erases
any existingalternatetrack
assignments
and testsall tracks.

4-104

In judgingwhetheror not tracksaredefective,the program
d o e ss u r f a c e
a n a l y s itsh e n u m b e ro f t i m e sy o u s p e c i f yi n t h e
V E R I F Yp a r a m e t e rl .f y o u o m i t t h e V E R I F Y p a r a m e t e r ,
surface
a n a l y s iiss d o n e 1 6 t i m e s . T r a c k st h a t c a u s er e a d i n g
o r w r i t i n ge r r o r sa n y t i m e d u r i n gs u r f a c ea n a l y s ias r ec o n sidereddefective.Defectivetrackscan be assigned
altern a t e s .E a c hv o l u m eh a s4 0 a l t e r n a t ter a c k sa v a i l a b l el.f t h e
programfinds morethan 40 defectivetracks,it considers
it.
t h e d i s k u n u s a b l ae n d s t o p si n i t i a l i z i n g

Al ternate Track Assignment
an
Alternatetrack assignment
is the processof assigning
a l t e r n a t ter a c kt o a d e f e c t i v e
t r a c k . l f t h e d i s ki n i t i a l i z a t i o n
p r o g r a mf i n d sa d e f e c t i v e
t r a c kd u r i n ge x e c u t i o ni t a s s i g n s
an alternatetrack to the defectivetrack. The alternateis,
in effect,a substitutefor the defectivetrack. Any time a
programattemptsto usethe defectivetrack, it automatic a l l yu s e st h e a l t e r n a t ei n s t e a d .E a c hv o l u m eh a s4 0 a l t e r natetracks.
l f t r a c k sb e c o m ed e f e c t i v e
a f t e ra v o l u m ei s i n i t i a l i z e d ,
another program lseeAlternate TrackAssignmentPrograml
i s u s e dt o a s s i g n
alternate
t r a c k s .V o l u m e sn e e dn o t b e
r e i n i t i a l i z etdo a s s i g n
alternate
tracks.
y ' y ' o f eD. 'u r i n ga C L E A R o r P R I M A R Yi n i t i a l i z a t i o ns,u s pecteddefectivetracksmay be encounteredwithin an active
or IPLsimulation
a r e af o r t h e v o l u m eb e i n gi n i t i a l i z e d l. f
is issuedprior to end of job that suggests
so,a message
$ A L T b e r u n a g a i n stth e v o l u m ea f t e rt h e c o n d i t i o n tsh a t
causedthe message
havebeeneliminated.

PACK Parameter(VOLI

NAME360Parameter(VOLI

The PACK parameter(PACK-name)
appliesto all typesof
i n i t i a l i z a t i o nD
. u r i n gi n i t i a l i z a t i o nt h, e d i s k i n i t i a l i z a t i o n
programwritesa volumelabelon eachmaindataarea. lt
usesthe nameyou supplyin the corresponding
PACK
parameter.(OneVOL control statementcontaininga PACK
parameteris requiredfor eachunit.)

The NAME360parameter(NAME360-name)
is usedto
specifya filenamefor data interchange
with System/360Systeml370.System/360-System/370
can usedataon a
System/3data moduleby treatingit like a file. System/3
g i v e sa d e f a u l tf i l e n a m eo f S Y S T E M / 3 . D A T AT
. he
NAME360parametercan be usedif you would like to code
a f i l e n a m eo f y o u r o w n .

The namecan be any combinationof standardSystem/3
characters
exceptapostrophes,
leadingor embeddedblanks,
and embeddedcommas(because
of their delimiterfunction).
(SeeAppendixA for a list of standardSystem/3characters.)
Its lengthmust not exceed6 characters.Examplesof valid
v o l u m el a b e ln a m e sa r e0 , F 0 0 0 1, O 1 2 , A 1 8 9 ,a n d A B C .

NAME360can containany of the standardSystem/3
characters
exceptapostrophes,
blanks,and commas. lts
lengthmust not exceed44 characters.

OLDPACKParameter(VOL)
ln general
, volumenamesare usedfor checking.Beforea
programusesa volume,its nameis comparedwith a name
you supply (eitherin OCL statements
or control statements
requiredby the program). lf the namesdo not match,the
programhaltsand printsa message.In this way. programs
cannotusethe wrongvolumeswithout the operatorknowi n ga b o u ti t .

lD (ldentification)Parameter(VOL)

T h e O L D P A C Kp a r a m e t e(rO L D P A C K - n a m ies)u s e dt o
v e r i f yt h a t a s p e c i f i cv o l u m ei s o n l i n eb e f o r ei n i t i a l i z a t i o n
is started. lf the nameof the volumedoesnot matchthe
nameyou specify,the programhalts.
The specifiednamecan be any combinationof standard
leadingor emexceptapostrophes,
System/3characters
beddedblanks,and embeddedcommas. lts lengthmust
not exceed6 characters

T h e l D p a r a m e t e(rl D c h a r a c t e r sa)p p l i e st o a l l t y p e so f
i n i t i a l i z a t i o nl.t e n a b l e ys o u t o i n c l u d ea m a x i m u mo f 1 0
characters.
in additionto the volumelabelname,to further
identify a volume. The characters
can be any combination
(AppendixA) except
of standardSystem/3characters
apostrophes,
leadingor embeddedblanks,and embedded
c o m m a s( b e c a u soef t h e i rd e l i m i t e rf u n c t i o n ) .T h e i n f o r m a tion is strictlyfor your use;the systemdoesnot useit for
c h e c k i n g .l f y o u u s et h e f i l e a n d v o l u m el a b e ld i s p l a yp r o gramto print the name,that programwill alsoprint the
a d d i t i o n aild e n t i f i c a t i ofno r y o u .

D i s k I n i t i a l i z a t i o nP r o g r a m - $ l N l T

4-105

OCLCONSIDERATIONS
The followingOCL statements
are neededto loadthe disk
i n i t i a l i z a t i opnr o g r a m :
// LOAD$lNlT.code
i/ RUN
The codeyou supplydependson the locationof the simul a t i o na r e ac o n t a i n i n tgh e d i s k i n i t i a l i z a t i opnr o g r a m .
Possible
codesare R 1. F 1, R2, andF2.

EXAMPLES
PrimaryInitializationof Two Volumes
Figures4-67 and 4-68 areexamplesof OCL statements
and
controlstatements
neededfor the primaryinitializationof
two volumes.

Explanation:
The maindataareason two volumesare beinginitialized
( U N I T - ' D 1 , D 2i n' U I N s t a t e m e n t ) .
T h e m a i nd a t aa r e a( D 1 ) i s g i v e nt h e n a m e2 2 2 2
IPACK-2222in first VOL statement).
T h e m a i nd a t aa r e a( D 2 ) i s g i v e nt h e n a m eP A Y R O L
( P A C K - P A Y R OiLn s e c o n dV O L s t a t e m e n t )A
. dditional
identifyinginformation,120276,is to be written on
drive 2 llD-12O276!..
Figure 4-68. Control Statements for Primary Initialization of Two
Volumes

Explanation:
T h ed i s k i n i t i a l i z a t i opnr o g r a mi s l o a d e df r o m F l .
Figure 4-67. OCL Load Sequenco for Disk Initialization

4-106

MESSAGES
FOR DISKINITIALIZATION
Message

Meaning

I N I T I A L I Z A T I O NO N
ZZZCOMPLETE

This message
is printedwhen initializationof a volumeis complete.ZZZ
i n d i c a t etsh e u n i t ( f o r e x a m p l eD
, 3 1 ) o n w h i c ht h e i n i t i a l i z a t i oins c o m p l e t e

I N I T I A L I Z A T I O NO N
ZZZTERMINATED

This message
is printedwhen initializationof a volumemust b€ terminated
for one of the followingreasons:
o Cylinder0 head0 is defective.
o Morethan 40 tracksaredefective.
o Possible
disk hardwareerror exists.
After this message
is printed, systemmessage
33 occurs. ZZZindicrltesthe
u n i t ( f o r e x a m p l eD
, 1 ) o n w h i c ht h e i n i t i a l i z a t i oins t e r m i n a t e d .

**ALTERNATE

TRACKS

ASSIGNED**

Thesetwo messages
are printedwhen a primarytrack is defectiveand an
alternatetrack is assigned
to it. XXXX is the numberof the defective
primarytrack. YYYY is the numberof the assigned
alternatetrack.

P R I M A R YT R A C K X X X X
A L T E R N A T ET R A C K Y Y Y Y

ALTERNATE
TRACK
YYYY DEFECTIVE

This message
is printedwhen an alternatetrack is defective.YYYY is the
numberof the defectivetrack.

Messages
listedfor the alternatetrack assignment
program($ALT) may be issuedwhen executingTYPE-CLEARor
TYPE-PR
I M A R Y i n i t i ailz a t i o n .

D i s k I n i t i a l i z a t i o nP r o g r a m - $ l N l T

4-107

ChainCleaningProgram*$KLEAN

OCLCONSIDERATIONS

PROGRAMDESCRIPTION

The followingOCL statements
areneededto causea messageand loadthe chaincleaningprogram:

The chaincleaningprogramhasthe followingfunction:
Exercisethe IBM '1403Printerfor the purposeof
c l e a n i n tgh e p r i n t c h a i n( t r a i n ) .

s ber
/ / P R I N T E RD E V I C E - 1 4 0 3 , F O R M S N O - f onr m
um
// LOAD $KLEAN,code
// RUN

The print chainis cleanedaseachcharacteris printedon a
specialtype-cleaning
paper. (Seeyour local IBM repres e n t a t i v ree g a r d i ntgh e a v a i l a b i l i toy f t h i s s p e c i apl a p e r . )

The codeyou supplydependson the locationof the simulation areacontainingthe chaincleaningprogram.Possible
c o d e sa r e R l , F 1, R 2 , F 2 .

The chaincleaningprogramcan be executedin any partition.
However.beforethis programis executedor beforeprinting occursif the output is spooled,the 1403 printer ribbon
must be removedand the type-cleaning
paperinstalledin
p l a c eo f t h e c u r r e n tf o r m s . T h e f o l l o w i n gP R I N T E RO C L
statementshouldbe usedto causea message
for this
purpose:

After end of job for $KLEAN, the 1403 print ribbonshould
be re-installed,
the type cleaningpaperremoved,and the
properforms installed.

/ / P RI N T E R D E V I C E -410 3 , F O RM S N O - f o r mnsu m b e r
Note: An IMAGE statementmust be suppliedif the print
chainto be cleanedis differentthan the print chaincurrently installedon the printer. For more informationregarding
the IMAGE OCL statement,referto IMAGE Statementin
P a r t1 o f t h i s m a n u a l .

4-108

File and Volume Label Display Program-$LABEL

S T O R A G ER E O U T R E M E N T S

P R O G R A MD E S C R I P T I O N

T h e f i l e a n d v o l u m el a b e ld i s p l a yp r o g r a mr e q u i r e as n 8 K
p a r t i t i o ns i z et o d i s p l a ya s i m u l a t i o n
a r e aV T O C . T h e p r o g r a mr e q u i r e as 1 0 K p a r t i t i o ns i z et o d i s p l a ya m a i nd a t a
a r e aV T O C w i t h o u t s o r ta n d a 1 0 K t h r o u g h1 8 K p a r t i t i o n
sizewhen sort is used. The amountof storagerequired
w h e ns o r t i s u s e di s a f u n c t i o no f t h e n u m b e ro f e n t r i e si n
the VTOC. The amountof storagerequiredis asfollows:

T h e f i l e a n dv o l u m el a b e ld i s p l a yp r o g r a mh a st h e f o l l o w i n g
function:
D i s p l a yt h e v o l u m et a b l eo f c o n t e n t s( V T O C ) .
This programcan be usedto:
o Print the entirevolumetableof contents(VTOC)from
an area.
o Printonly the VTOC informationfor certaindatafiles.
In both cases,
the programalsoprintsthe nameof the area.
The printedVTOC informationis a recordof the contents
of the area. Thereare many reasons
why you might need
t h e i n f o r m a t i o n .F o r e x a m p l e :
.

Numberof
VTOC Entries

300
500
700
900
1000

StorageRequired
for programto
Executewith Sort

10K
12K
14K
16K
18K

B e f o r er e i n i t i a l i z i nagd i s k ,y o u w a n t t o c h e c ki t s c o n tentsto ensurethat it containsno libraries,permanent
d a t af i l e s ,o r t e m p o r a r yd a t af i l e s .

o You want to determinethe available
disk spacefor
l i b r a r i eo
s r n e wf i l e s .
o You want specificfile information.suchasthe file name,
designation(permanent,
temporary,scratch),or the
spacereserved
for the file.
you supplyfor the programdepend
The control statements
on the programuse.

File and Volume Label Display Program-$LABEL

4-109

C O N T R OL S T A T E M E N TS U M M A R Y
The control statementyou must supplydependson the
desiredresults.
Functions

Controlstate-entO

P r i n te n t i r e
VTOC

LABE
/ / D I S P L A YUNlr-code,
L-vroc
[,to
// END

P r i n to n l y f i l e
information
from VTOC

O

tt

1runur
\l
LocAroN'l
t

D I S P L A YUNtr-code.
Lae
- - eL- - { lil'n"t }@
[filenamesJ
END

foreach use,the programrequiresthe statementsin the orderthey are listed: DISPLAY,END.

@ fh" numberof filenamesyou list for a programrun may not exceed20 (VTOC is consideredone filename).

P A R A M E T E RS U M M A R Y( D I S P L A YS T A T E M E N T )
Parameter

Description

UNIT-code

Locationof the areacontainingthe VTOC informationbeingprinted
P o s s i b lceo d e sa r e R 1 , F 1 , R 2 . F 2 , a n dt h o s ef o r t h e m a i nd a t aa r e a s .

LABEL-VTOC

Printentire contentsof VTOC.

L A B E L - ifl e n a m e

Print VTOC informationfor one file.

LABEL-'filename,filename,...'

Print VToc informationfor more than one file.O

SORT.NAME

VTOC informationis sortedinto alphabetical
order by filename

SORT-LOCATION

VTOC informationis sortedinto physicallocationsequence.

O ff," numberof filenamesyou list for a programrun may not exceed20 (VTOC is considered
one f ilename).

4-110

PARAMETE
R D E S C RPI T I O N S

SORT Parameter

UNIT Parameter

The SORT parametercan be specifiedonly when
L A B EL - V T O Ci s s p e c i f i e d l.f S O R T - N A M Ei s s p e c i f i e d ,
the VTOC informationis sortedby filenameinto alphabeticalorder. lf SORT-LOCATIONis specified.the VTOC
informationis sortedinto physicallocationsequence.This
functionappliesonly to main dataareaVTOCsand requires
additionalmain storagefor sorting.

T h e U N I T p a r a m e t e(rU N I T - c o d ei)n d i c a t etsh e l o c a t i o no f
the areacontainingthe VTOC informationbeingprinted.
P o s s i b lceo d e sa r e R 1 , F 1 . R 2 , F 2 , a n dt h o s ef o r t h e m a i n
dataareas.

LABEL Parameter
The LABEL parameterindicatesthe informationyou want
printed: the entirecontentsof the VTOC or only the informationfor certainfiles. The VTOC is an areaon disk that
containsinformationabout the contentsof the area.

E N T I R EC O N T E N T SO F V T O C
The parameterLABEL-VTOCmeansto print the entire
contentsof the VTOC. The meaningof the information
the programprints is givenin the followingchart. Headings
that are listedarethe onesprintedby the programto
identify the information. Figures4-69 and 4-7Oareexamplesof VTOC printouts.
lf the programneedsmorethan one pageto list the file
i n f o r m a t i o ni,t p r i n t st h e h e a d i n gfso r t h e f i l e i n f o r m a t i o n
at the top of eachnew page.

File and Volume Label Display Program-$LABEL

4-111

PACK_F2F2F2 UNIT F2

D A I E _ A 1/ 1 , O / 7 5

T I M E O I . O C . 5 I

I D

D E V I C EC A P A C I T Y _ 4 O O
A V A I L A S L ES P A C EO N P A C K
LOCATION TRACKS
008
t 8t
SEO
NUI4

FILE
RE
NAME TAIN

OO],DIRF12
002 DtR12A
OO3 RTNO3B
004 PDO05B
005 s EQ093
006 cRT03C
OO7 YTDO5C
008 5EO09C
0 0 9 s E Q l tC
0 10 s E Q l t c
0 1 1 , S E Q tl , C
01,2 ACR08C
013 | I Rl,2C
0 1 4 A CP F 0 7
015 SEQF09
01,6 PRLFOB
017 PAYF],0

FILE
DATE

FlLE
TYPE

a9/ 29/11,
at/10/15
a 1/ 7 a / 1 5
al /7A/15
01/1,a/15
al /r0 /15
al /\a/15
0 1/ L a / 1 5
01/\a/15
7 A / 3 0/ 1 a
7 A/ O \ / 1 7
a 1/ 7 0 / 1 5
a]/\o/15
al/10/15
o1/1,O/15
01/LA /1 5
01 /1,a/ 1 5

RFCKEY
LEN LEN

KEY
L0c

DATA
START

ao\24
44124
00133
00063
00512
00133
00063
00512
00t 28
00128
00128
00002
ao]"24
0 01,00
oa512
00002
04096

FlLE
FILE RECORNRECORIS
LOC TRACKS COUNT
A V AI L
400
394
314
339
329
309
2 14
264
254
t,B9
196
255
249
241
237
234
208

006
006
020
035
010
020
A35
0',1,A
006
007
01,2
003
A06
OO2
070
AA3
A26

291
291
28
52
61
28
52
61
99
99
98
54
291
17
o
54
38

895
336L
59
895
3361,
59
189
231
418
9\62
51,
420
946 2
l

OCL SIZE NEXTAVAIL
PARAI1ETER RECORD
6T
6T
201
35I
10T
20I
35I
t 0T
5T
7I
1,2I
3T
6T
71R
IaI
3T
38R

NEXTAVAIL
KEY

*+*+**
++**++
314/1,4/1,41,
339/1,2/205
3 3 4/ 0 2 / A O \
3A9 /',t 4 /1,4a
214/1,2/205
269/02/AO\
26A/A1,/a29
\91,/ Aa/ \29
19A / O\ / OAA
255/OO/1,A9
*++**+
2 4 4 / A 3/ 1 8 9
2 3 1 / A A/ O O 1 ,
234/OA/aO9
233/OA/AOa

Figure 4-69. Simulation Area VTOC printou

P A C KD t D l D 1

UNIT Dt

DArE_01/og/75

ltMF 00.!0.5s

1r l lRSTpAa(

NO. OF ALTERNATE
T R A C K SA V A I L A S L E , 4 O
A V A ] L A B L ES P A C EO N P A C K
LOCATION

TRACKS

ao2/aa

0364

o21,/1,9

0821

463/A2

0756

\aa/a\

0599

\31,/7C

A\I2

NUM

FILE
RE
NAME TAIN

FILE FlLE RECKEY
DATE TYPE LEN LEN

KEY
LOc

DATA
SIART

F I L E F I L E R E C O R DR E C O R I S O C L 5 I Z E N E X T A V A I L
Loc TRACKS couNT
avAIL paRAf4ETER REcoRn

OO1DIRF12
002 DlR12A
003 ttRl2c
OO4 I NDFO3
005 lNDF05
O O 6 I N D FO 7

0 1/ a 9 / t t
a 1/ a 9 / 1 5
0 1/ a 9 / 1 5
a] / 09/15
a] / 09/ 15
a 7/ a 9 / 7 5
VOL SEQNUM

0 0 1 , 24
1 , 4 1/ 0 6
ao\2 4
l4llo2
aaL24
L31/A2
00133 05 00104 001/02 001/00
0 0 0 6 3 2 9 0 A A 6 ) A 2 0 / \ 7 420/44
00100 08 00099 063/01 063100
01
LOKEY

007 I N!FC7A
0 0 8 I N D F0 8
O O 9 I N D F1 , 0

P 01/A9/15
1 01/A9/75
r al/a9/15
VOL SEQNUM
r 01/a9/15
P Af/a9/15
P 01/09/15
P Af/49/15
al /a9/15
o 1/ a 9 / 1 5
a]/a9/lt
a]/09/15
a]/09/15
al/a9/f5
o 1/ a 9 / f t
411A9/15
a 7/ 0 9 / 1 5
a7/09/75
0
a 9/ f 5
0
a9/75
/49 /f5
/a9/15
a9/15
a9/15
a9/15
/49/ft
0 9/ 1 5
09/15
09/15
/09/fa
a 9/ 7 '
0 9/ 1 5
0 9/ 1 5
09/15
a9/15
0 9/ 7 5

oo100
00002
0 40 9 6
01
04096
0013l
0 0 1 , 3l
00063
00063
00002
c0002
00096
44255
00511
00096
aaf61
o0020
00065
00256
44251
04096
00001
o 0 1 , 00
o 0 0 10
0 0 1 , 27
00128
o o 1 28
0 1 , 02 4
00032
00064
ao5L2
0 0 1 , 2I
o051,2
0 0 5 12
00128
00128

010 t NtFt OA
011 I Nt03A
012 I ND03C
013 rNt05A
O],4 I NDO5C
015 I Nl08A
016 I Nt08C
017 0uT01,
018 0uT02
019 0uT0l
020 0uT04
02I 0uT05
022 0uT06
023 0uT0t
o24 0uT08
025 0uT09
026 0uT10
027 0uTl1
028 0uT12
029 LtUTi,l
030 LrUTl,4
031 0!T15
012 0u Tl,6
031 0uTt,7
0t4 uuT18
035 0uTl,9
ol6 sEQF0s
0r7 5EQF1
t
038 SEQ09A
019 5EQ09C
O4O SEQ11,A
041 SEQ11C

o 8 ooa99 \44/Of
o2 00002 101,/00
07 44096 \44/OA
LOKEY
of 44096 L41/09
05 00104 146l08
0 5 oa\44 \4a/a4
29 aaa61 \45/A4
29 00063 139/OO
a2 oooa2 \44/A5
a2 aaao2 L3f/\a

Figure4-70. Main Data Area VTOC Printout'

4-112

AAA2
0006
AAA6
0020
003a
0002

198
594
594
28
52
6'

144l06 0005
100/18 0001
\43/1,9 AAO4

1a
54
8

141/08 0035
L46/46 AO2A
),4A/O2 AA20
L 4 4 / 1 , 1 ,A A 3 5
138/07 0o35
L4/+/A3 0AO3
137/08 0003
166,/00 0020
\56/AO AA2A
\65/OO 0A2C
r55l00 0020
1,64/OA OA2A
t 54l00 0020
163l00 002t)
153/00 0020
L62/AA AA2A
I52/0A 002a
1,61l00 0020
151/00 0020
t60/00 0020
150/00 0020
1,59lC0 0020
149l00 0o20
\5a/ao oa20
I48lOO 0020
L 5 1/ O O A O 2 0
1,31l00 0010
\41 /08 0012
r4ll0s
o01,0
\31 /1,1 aa\o
L43/03 aao6
L31/1,L 00A6

0
28
2a
52
,2
t4
t4

9f
61
6\
0
99

N E X TA V A I L
KEy

2I
*+*r1<

6T

6T
1 , 6 35
20i
4239
t5T
51
6 5R
rtKEY 00000005
0000006F
42A
5r
3894
3T
1
8R
H T K E Y0 0 0 0 0 0 8
\635
4635
4239
c239
3894
)494
2559
962
_-55q
119
L2?47
4119
959
955
59
2 4 4 15 9
2456
2451 5
\9 34
1919
191,9
239
1679
3839
244
1055
1,19
179
576

20r
207
357
3T
3T
207
207
20r
2AI
207
20T

101
6l
6I

aaL/a2/a5/a4\ aa\/oo/o2/aaI
a 2 a/ 7 1 / a 3 / 2 A 5 o 2 0 / 0 4 / o 8 / 2 5 6
0 6 3 / A \ / 2 6 / : " A \ 0 6 3 / A A/ 4 4 / A 2 5

1 , 4 4 / A| / 2 A / L a 9 1 , 4 4 / A 6 / A 4 / 0 9 7
LA\/AO /01,/ \O9 \ a a / L 8/ 4 2 / 0 1 3
1 , 4 4/ A 2 / 3 3 / A A L \ 4 3 / L 9 / A \ / O 8 9
a 4 a / 0 9/ a \ / a o l
a 4 J , /A 8 / A a / O A a
\46/48/\5/L4\
446/46/A2 /AA\
I4A/O4/\a/a4I \40/42/42/oo\
),45/A4/\3/205 \44/aa/o8/256
439/OA/L3/205 1,38/01/O8/256
1,44/A5/A\/\O9 \44/03 /42 /013
\ ) 1 / \ A / A t / L A g ) , 3 1/ O 8 / A 2 / O t 3
1,66/AA/Or/O91
\56/AA/AL/256
\6t,'oa/a2/256
1,55/OO/O\/A91
\64/AA/A3/256
1,54/aO/O\/O2\
\63/AA/A\/'466
453/OO/A2/0A\
L62/40 /42 /AA2
L52/O0/L] /AO\
76L/AA/OL/OO2
1,5a/OA/Aa/\O\
a6o / ao / A\ /t)1,\
\ 5 4 / O A/ A \ / \ 2 8
1,59/AA/O\/L29
7 4 9/ O A/ A a / \ 2 9
458/OO/a5/AO7
4 4 8 / O A/ A 7 / A ? 1
) , 5 1 / O A/ O \ / A 6 5
a3\/aa/oL/oo1,
a4f/09/a\/\29
\43 /L1,/21/ AA\
7i1 /\9 / 2J / AO\
L4)/A3/OL/OO1,
1 , 3 1/ 1 , 2 / 0 2 / a 2 9

M E A N I N GO F V T O C I N F O R M A T I O N
Heading

Meaning

PACK-name

Nameof the area.

UNIT-code

Locationof the areacontainingthe VTOC information.

DATE-xx/xx/xx

Partitiondate.

T I ME - x x . x x . x x

T i m eo f d a y .

I D-characters

A d d i t i o n a al r e ai d e n t i f i c a t i o (ni f a n y ) .

N U M B E RO F A L T E R N A T E
TRACKS
AVAILABLE-number

N u m b e ro f a l t e r n a t ter a c k sa v a i l a b lfeo r a s s i g n m e n M
t . a i nd a t aa r e ao n l y .

TRACKS WITH ALTERNATE
ASSIGNED

Addressof primarytracksthat havebeenassigned
an alternate.Maindata
a r e ao n l y .

DEFECTIVEALTERNATE
TRACKS

Addressof the alternatetracksthat aredefective.Main dataareaonly.

D E V I C EC A P A C I T Y - n u m b e r

r f t r a c k s ) .S i m u l a t i o na r e ao n l y .
D i s kc a p a c i t y( n u m b e o

LIBRARYEXTENT

B o u n d a r yo f l i b r a r i e o
s n t h e s i m u l a t i o na r e a . ( l f t h e s i m u l a t i o na r e a
containsno libraries,theseheadings
are not printed.)

START
END

E X T E N D E DE N D

A V A I L A B L E S P A C EO N P A C K

Track on which librarybeSins.-'l lf the simulationareacontainsboth source
and objectlibrary,START refersto beginI
Track on which libraryends. J
ningof sourcelibrary and END refersto
end of objectlibrary.
O b j e c tl i b r a r yo n l y ( s i m u l a t i o an r e ao n l y ) . T r a c ko n w h i c he x t e n s i o tno l i b r a r y
ends. Whenobjectlibrary is full, temporaryentriescan be placedin space
followingend of library,providedthat spaceis available.
Available
d i s ks p a c e .

LOCATION

n r e a ) .F i r s tc y l i n d e r / t r a cikn
F i r s tt r a c ki n a v a i l a b lsep a c e( s i m u l a t i o a
(main
dataarea).
availablespace

TRACKS

Numberof tracksavailable.

S E ON U M

L i n en u m b e r .

FILE NAME

N a m et h a t i d e n t i f i e fsi l e i n V T O C .

RETAIN

F i l ed e s i g n a t i o n :
P = Permanent
T = Temporary
S = S c r a t c h( s i m u l a t i o an r e ao n l y )

F i l e a n d V o l u m e L a b e l D i s p l a yP r o g r a m - $ L A B E L

4-l13

Heading

Meaning

FILE DATE

D a t eg i v e nt h e f i l e w h e nf i l e w a sp l a c e do n d i s k .

F I L ET Y P E

F i t et y p e :
| = indexed
S = seouential
D = direct
* = file
u s e db y s p o o l i n g

REC LEN

Numberof characters
in eachrecordin file.

KEY LEN

N u m b e ro f c h a r a c t e ri sn e a c hr e c o r dk e y ( i n d e x e df i l e so n l y ) .

KEY LOC

Positionin recordoccupiedby lastcharacterof recordkey (indexedfilesonly).

DATA START

Diskspacereserved
for indexedfilesonly. START is the first maindataarea
cylinder/trackof the area. This refersto the data portion of the file.

FILE LOC

F i r s t t r a c ku s e db y t h e f i l e . F o r s i m u l a t i o n
a r e af i l e s ,r e f e r st o a t r a c kn u m b e r .
For main dataareafiles,refersto a cylinder/tracknumber.

FILETRACKS

N u m b e ro f t r a c k sa l l o c a t e tdo t h e f i l e .

RECORDCOUNT

Total numberof recordscurrentlyin the file.

RECORDSAVAIL

Numberof recordsthat can be addedto the file.O

OCL SIZE PARAMETER

Parameter
usedon OCL statementwhen file wascreated.
T = tracks
R = records

N E X TA V A I L R E C O R D

Beginninglocationof next availablerecordin file. For simulationarea,location
is track,sector,and positionwithin sector. For main dataarea,locationis
cylinder,track, fixed record,and positionwithin record.
O
Example: 099/18/006 = track 99. sector18, positions6.\7
=cylinder 50, track 2, f ixed record12, po.i,ion O.O
O5O/O2/12/OOO

N E X TA V A I LK E Y

Indexedfilesonly. Beginninglocationof next availablerecordkey in index
portion of file. For main data area,locationis cylinder,track,fixed record,
and positionwithin record. Maindataareaonly.
= cylinder52, track 3, f ixed record10, position6. O
Example: O52/O3/10/006

V O LS E ON U M

V O L S E ON U M a p p l i e st o m u l t i v o l u m e
f i l e so n l y . l t i n d i c a t etsh e o r d e ro f t h e
volumeas it relatesto the other volumescontainingthe remainingportionof the
f i l e . M a i nd a t aa r e ao n l y .

4-1't4

Heading

Meaning

LOKEY

T h e h i g hk e y f r o m t h e p r e v i o u vs o l u m e .T h i sf i e l d w i l l b e b l a n kf o r t h e f i r s t
v o l u m eo f a m u l t i v o l u m e
f i l e . M a i nd a t aa r e ao n l y . @

HIKEY

T h e h i g h e skt e y t h a t c a nb e p u t o n a n y s p e c i f i cv o l u m eo f a m u l t i v o l u m ei n d e x e d
f i l e . M a i nd a t aa r e ao n l Y '( 9

O

tt,ft. field contains

*****.

t h e r e i s i n s u f f i c i e n ts p a c ei n t h e f i l e f o r a d d i t i o n a l r e c o r d so r i n d e x e n t r i e s .

of 0000125Fis printed
a packedkeyconsisting
@ R packedkeyis printedon two printlines.Forexample,
^^0015
"" 002E'

F I L EI N F O R M A T I O N
ONLY
T h e p a r a m e t eLr A B E L - f i l e n a moer L A B E L - ' f i l e n a m e s '
meansto print certainfile informationfrom the VTOC.
F o r o n e f i l e , u s eL A B E L - f i l e n a m feo; r t w o f i l e s ,u s e
LABEL-'filename,filenam
ed
' ;s o o n . ( U s et h e n a m e s
an
t h a t i d e n t i f yt h e f i l e si n t h e V T O C . ) Y o u c a n l i s t 2 0 f i l e namesfor a programrun. The statementlength,however.
is restrictedto 96 characters,
and continuationstatements
arenot supported.
The programprintsthe file informationfor eachof the files
you fist. This informationis describedunderMeaningof
VTOC lnformation.
lf the programneedsmorethan one pageto list the file
i n f o r m a t i o ni,t p r i n t sh e a d i n gfso r t h e f i l e i n f o r m a t i o na t
the top of eachnew page.

T h e A L L O C A T E DS P A C EN O T E O U A L T O S P A C EU S E D
message
is printedfor one or more of the followingreasons:
.

The VTOC is not updated,eventhoughspacehasbeen
of an abnormaltermination
allocatedfor a file, because
program.
of an executing

o A c o n s e c u t i voer d i r e c tf i l e i s b u i l t o v e ra n i n d e x e df i l e
(loadto old). The new file overlaysthe dataportion of
t h e i n d e xp o r t i o nu n a l t e r e d .
t h e i n d e x e df i l e l e a v i n g
o A checkpointedprogramhasnot beencompleted.
Unusedspacecan be madeavailableby useof the FORMAT
statement(file deleteprogram,$DELET),exceptwhen a
c o n s e c u t i voer d i r e c tf i l e i s b u i l t o v e ra n i n d e x e df i l e .

File and Volume Label Display Program-$LABEL

4-115

OCLCONSIDERATIONS
T h ef o l l o w i n gO C L s t a t e m e n tasr eu s e dt o l o a dt h e f i l e a n d
v o l u m el a b e ld i s p l a yp r o g r a m .
// LOAD$LABEL,code
// RUN
The codeyou supplydependson the locationof the simu_
lation areacontainingthe systemserviceprogram.possible
codesare R 1, F 1, R2, and F2.

EXAMPLE
PrintingVTOC Informationfor Two Files
Figures4-71 and4-72 areexamplesof the OCL statements
and control statements
neededto print VTOC information
for two files.

Explanation:
o T h e f i l e a n dv o l u m el a b e ld i s p l a yp r o g r a mi s l o a d e df r o m
F1.
Figure 4-71. OCL Load Sequence for File and Volume Label Display

Explanation:
o T h e f i l e sf o r w h i c hi n f o r m a t i o ni s p r i n t e da r en a m e d
B I L L N Ga n dI N V O l ( L A B E L - ' B I L L N G
t N, V O f i n
D I S P L A Ys t a t e m e n t )T. h e ya r el o c a t e do n m a i nd a t a
a r e aD 1 ( U N I T - D 1 ) .
Figure 4-72. Control Statoments for Printing VTOC lnformation
for Two Files

4 - 11 6

Library

Maintenance

Program-$MA|NT

The library maintenance program usesremporary worK
s p a c eo n d i s k f o r e a c h o f t h e f o l l o w i n q f u n c t i o n s :

PROGRAM DESCRIPTIONS
o

R e o r g a n i z ea l i b r a r y .

T h e l i b r a r y m a i n t e n a n c ep r o g r a m h a s t h e f o l l o w i n g f u n c tions:

o Sort a directory beforeit is printed.

o A l l o c a t e l i b r a r y s p a c ef o r u s e r a n d s y s t e m l i b r a r i e s .

r

o C o p y e n t r i e st o , a n d d i s p l a y t h e c o n t e n t s o f , l i b r a r i e s .
C r e a t ea f i l e f r o m l i b r a r y e n t r i e s .

T h e w o r k s p a c em u s t b e o n a s i m u l a t i o na r e ae x c e p t w n e n
t h e p r o g r a m i s r e o r g a n i z i n ga l i b r a r y , i n w h i c h c a s ei t c a n
a l s ob e o n a m a i n d a t a a r e a .

o

D e l e t el i b r a r y e n t r i e s .

o M o d i f y s o u r c el i b r a r y e n t r i e s .
o

M o d i f y a s o u r c el i b r a r y e n t r y .

R e n a m el i b r a r y e n t r i e s .

The control statementsyou must supply depend on the
function you are using.
For further informationabout library format, organization,
and location refer to Library Facilities in part 2 of this
manual.

T o s o r t a l i b r a r y d i r e c t o r y b e f o r e p r i n t i n g ,t h e l i b r a r y
m a i n t e n a n c ep r o g r a m r e q u i r e sa w o r k s p a c e ,o n t h e s i m u r a t i o n a r e a s p e c i f i e db y t h e F R O M p a r a m e t e r ,e q u a l t o t h e
s i z eo f t h e d i r e c t o r y . T h u s , i f y o u r o b j e c t l i b r a r y d i r e c t o r y
o c c u p i e s ,f o r e x a m p l e ,s i x t r a c k s ,a w o r k s p a c eo f s i x u n u s e o
tracks is required to sort that directory. When the function
is complete, the work spaceis releasedand may be used by
a n o t h e r l i b r a r y m a i n t e n a n c ef u n c t i o n , o r b y a p r o g r a m
a l l o c a t i n gf i l e s i n a n o t h e r p a r t i t i o n .

ORGANIZATION OF THIS SECT!ON
F o r i n f o r m a t i o n c o n c e r n i n gm u l t i p r o g r a m m i n gc o n s i d e r a tions, see Library MaintenanceProgram under Multiprogramming Considerations and Restrictions in Part 2 of
this manual.

The five functions of the library maintenance program are
described separately. Every description contains the
followino:
o

List of specific uses.

Use of Disk Space
T h e l i b r a r y m a i n t e n a n c ep r o g r a m a c q u i r e sl i b r a r y s p a c eo n
d i s k d u r i n g e a c ho f t h e f o l l o w i n g f u n c t i o n s :

o Control statement summary indicating the form of cont r o l s t a t e m e n tn e e d e df o r e a c n u s e .
.

P a r a m e t e rd e s c r i p t i o n se x p l a i n i n gi n d e t a i l t h e c o n t e n t s
and meaningsof the parameters.

o

F u n c t i o n d e s c r i p t i o n se x p l a i n i n gt h e d e t a i l so f e a c h
f unction.

o Createa library.
o

I n c r e a s et h e s i z eo f a l i b r a r y .

o D y n a m i c a l l ye x t e n d a n o b j e c t l i b r a r y t o c o p y t e m p o r a r y
e n t r i e st o t h e l i b r a r y .

F o l l o w i n g t h e f u n c t i o n d e s c r i p t i o n sa r e O C L c o n s i d e r a t i o n s
and examoles.

l f t h e r e i s n o t a l i b r a r y o n t h e s i m u l a t i o na r e a .t h e s p a c e
used to create one is the first contiguous space largeenough
t o c o n t a i nt h e l i b r a r y . l f t h e r e i s a l i b r a r y .t h e c o n t i g u o u s
s p a c ed i r e c t l y f o l l o w i n g i t w i l l b e u s e d .

L i b r a r y M a i n t e n a n c eP r o g r a m - $ M A I N T

4-117

$MAlNT-AIlocate Function

C O N T R OL S T A T E M E N TS U M M A R Y

USES
o Create(reserve
spacefor) libraries,systemhisroryarea,
schedulerwork area,and checkpoint/restart
area.
.

Changethe sizeof librariesand systemhistorvarea.

The control statements
you must supplydependon the
d e s i r e dr e s u l t s .
All volumesreferencedby the control statements
must
r e m a i no n l i n ed u r i n gt h e e x e c u t i o no f $ M A l N T .

o D e l e t el i b r a r i e s .
o R e o r g a n i zl ieb r a r i e s .

// ALLocArEro-code,souRcE-{1"'*'},oBJEcr-{numberf,r"rrrr-{}!r},,r,rroRy_numberl
] O R K - c o d e[ ,] p A C K O _ n a m e 1
[ , D tR S T Z E - n u m b e[ ,rW

Source
Library

Object
Library

Create

TO-code,SOURCE-number.WORK-code
@

Changesize

TO-code,SOURCE-number,WORK-code

Delete

TO-code,SOURCE-0

Reorganize

TO-code,SOU
RCE-R,WOR K-code

Create

To-code,oBJECT-number,SySTEM{}3,

}

Changesize

TO-code,OBJECT-number,WORK-code
O

Delete

TO-code,OBJECT-0

Reorganize

TO-code,OBJECT-R,WO
R K-"od, O

Oyou can indicatea sourcelibraryuse,any objectlibraryuse.or usesinvolvingboth libraries(for
example,
deletingthe sourcelibraryand changingthe sizeof the object ribrary).
\9 lf you are indicatingusesfor both libraries,useonly one To parameter.(The librariesmust be
on the same
simulationarea.) Also, useonly one WORK parameterif both usesrequirea WORK parameter.
O

fnt WORK parameteris neededonly if the simulationareacontainsan objectlibrary that you
are not deleting.

@ fn" WORK parameteris not requiredif this is a compressin place.

4 - 11 8

CONSI
DERATIONS
AND RESTRICTIONS
.

The allocatefunctioncannotreference
the librarieson
t h e s i m u l a t i o na r e af r o m w h i c ht h e l i b r a r ym a i n t e n a n c e
programor the systemwas loaded. For example,if the
s y s t e mw a sl o a d e d( l P L ) f r o m F l a n dt h e l i b r a r ym a i n t e nanceprogramwasloadedfrom R 1, the sourceor object
l i b r a r i eos n F 1 a n d R 1 c a n n o tb e r e f e r e n c eodn a n
ALLOCATE statement.

o W h e na l i b r a r yi s r e o r g a n i z e idt s, s i z ei s c h a n g e do,r i t i s
m o v e da
, l l t e m p o r a r ye n t r i e si n t h a t l i b r a r ya r ed e l e t e d .
Thisdeletionappliesto both the sourceand object
libraries.
o Whenyou arecreatingor changingthe sizeof the source
libraryon a simulationareathat containsan object
library,the objectlibrary is movedand reorganized
and
all temporaryentriesaredeleted.

The SOURCEor OBJECTparametermust be specified
in the ALLOCATE statement.lf the SYSTEM,
D I R S I Z E ,o r H I S T O R Yp a r a m e t ei rs s p e c i f i e dt h, e
OBJECTparametermust alsobe specified.
lf nestedprocedures
areused,informationcontainedin
the schedulerwork areacan becomeinvalidwtrenthe
sourcelibrary is reorganized
or the sizeof the source
library is changed(reallocated).Therefore,if you usea
procedureto reorganize
or reallocatelibraries,do not
call any further procedures
containedwithin that nested
procedurefrom the sourcelibrarythat is beingreallocatedor reorganized.
Informationcan be lost from the systemhistoryarea
(SHA): when an objectlibrary is reorganized
(unless
compressin place is used),when the sourcelibrary is
allocated,or when the sizeof the sourcelibrary is
changed.

$MAINT-Allocate Function

4 - 11 9

P A R A M E T E RS U M M A R Y
Parameter

Description

TO-code

The simulationareathat containsor will containthe library. Possible
codes
a r eR 1 , F 1 , R 2 , F 2 .

SOURCE-number
(no sourcelibraryexists)

Createa sourcelibrary. Numberindicatesthe numberof tracksyou want to
assign.

SOURCE-number
(sourcelibrary
alreadyexists)

Deleteor changethe sizeof the sourcelibrary. Usedependson number:
Number

Use
Delete

Any number
but zero

Changesize

SOURCE-R

R e o r g a n i zt e
h e s o u r c el i b r a r y .

OBJECT-number
(no objectlibraryexists)

Createan objectlibrary. Numberindicatesthe numberof tracksyou want
to assign.

OBJECT-number
(objectlibrary
alreadyexists)

Deleteor changethe sizeof the objectlibrary. Usedependson number:
Number

Use
Delete

Any number
but zero

Changesize

OBJECT.R

Reorganize
the objectlibrary.

DIRSIZE-number

Numberof tracksyou want for the directorywhen creating,reallocating,
or reorganizing
the objectlibrary.

SYSTEM-NO

Do not createa schedulerwork area. This will be a programpack.

SYSTEM-YES

Createa schedulerwork areaand a systemhistoryarea. This will be a
systempack.

HISToRY-number

Numberof tracksyou want for a systemhistoryarea.

WORK-code

The areacontainingspace
the programcan useasa work area. Possible
codes
are R 1, F1, R2, F2 and thosefor the main dataareas.

PACKO-name

Name of the simulation area specified by the TO parameter.

4-120

P A R A M E T E RD E S C R I P T I O N S

DIRSIZE Parameter

TO Parameter

T h e D I R S I Z E p a r a m e t e ra l l o w s t h e u s e rt o s p e c i f y t h e s i z e
of the object library directory. The number of tracksspecif i e d ( 1 - 9 ) o v e r r i d e st h e S Y S T E M p a r a m e t e ri n d e t e r m i n i n g

The TO parameter(TO-code)indicatesthe locationof the
simulation
a r e at h a t c o n t a i n so, r w i l l c o n t a i n t, h e l i b r a r y .
l f t h e p r o g r a mu s ei n v o l v e bs o t h l i b r a r i e st ,h e l i b r a r i e m
s ust
be on the samesimulationarea. The TO parametercannot
be the sameunit from which the library maintenance
prog r a mo r s y s t e mi s l o a d e d .P o s s i b lceo d e sa r e R 1 , F 1 , R 2 ,
F2.

directory size. Each track can contain 288 directory entries.
O n e e n t r y i s n e e d e df o r t h e d i r e c t o r y , s o t h e f o r m u l a f o r
t h e n u m b e r o f e n t r i e si n a d i r e c t o r y i s ( t x 2 8 8 ) - 1 , w h e r e
t i s t h e n u m b e r o f t r a c k s . l f t h e D I R S I Z E o a r a m e t e ri s
o m i t t e d , t h e S Y S T E M p a r a m e t e rd e t e r m i n e st h e d i r e c t o r y
s iz e .

SOURCEand OBJECTParameters

SYSTEM Parameter

Theseparameters
identify library uses:

T h e S Y S T E M p a r a m e t e ra p p l i e sw h e n y o u a r e c r e a t i n g ,
c h a n g i n gt h e s i z eo f , o r r e o r g a n i z i n go b j e c t l i b r a r i e s . l t
i n d i c a t e st o t h e p r o g r a mw h e t h e r y o u i n t e n d t o i n c l u d e
system programs in the library to create a system pack from
w h i c h a n I P L m a y b e p e r f o r m e d . l f s y s t e mp r o g r a m sa r e
to be included, a schedulerwork area must be assigned. See
Copy Function (Library-to-Library) in this manual for

Parameter

Use

S O UR C E - n u m b e r
OBJECT-number
( n u m b e ri s n o t z e r o )

l f t h e s i m u l a t i o na r e ac o n t a i n s
n o l i b r a r y ,t h i s p a r a m e t e r
m e a n sc r e a t ea l i b r a r y .
N u m b e ri s t h e n u m b e ro f
tracksyou want to assignto
the library.
l f t h e s i m u l a t i o na r e ac o n t a i n s
a l i b r a r y t, h i s p a r a m e t e r
m e a n sc h a n g et h e l i b r a r ys i z e .
N u m b e ri s t h e n u m b e ro f
tracksyou want to assignto
thelibrary.

SOURCE.O
OBJECT.O

D e l e t et h e l i b r a r y .

SOURCE-R
OBJECT-R

R e o r g a n i zt h
e e Ii b r a r y .

information about creating a system pack.
S p a c ef o r t h e s c h e d u l e rw o r k a r e a i s a s s i g n e di m m e d i a t e l y
p r e c e d i n gt h e o b j e c t l i b r a r y . l f t h e s i m u l a t i o na r e ac o n t a i n s
a s o u r c el i b r a r y , t h e s c h e d u l e rw o r k a r e a i s b e t w e e nt h e
s o u r c ea n d o b j e c t l i b r a r i e s . F o r i n f o r m a t i o n a b o u t t h e s i z e
of the scheduler work area, see Using the Allocate Function.
The system history area is allocated a spaceprecedingthe
s c h e d u l e rw o r k a r e a .
T h e f o l l o w i n g c h a r t ss h o w t h e r e s u l t so f c o d i n g t h e
S Y S T E M p a r a m e t e rf o r d i f f e r e n t a l l o c a t eu s e s .

$MAINT-Allocate Function

4'121

Creatingan Object Library

Parameter

Scheduler
Work
Area

Directory
Sizel

System
History
Area

Changingthe Sizeof or Reorganizingan Object Library
on a Simulation Area That Does Not Contain a Scheduler
Work Area and a SystemHistory Area
Scheduler
Work
Area

Directory
Sizel

System
History
Area

SYSTEM-YES Created

3 tracks

Created

Parameter

SYSTEM-NO

Not
created

1 track

Not
created

SYSTEM-YES Created

Not
changed

Created

Not coded

Not
created

1 track

Not

SYSTEM-NO

Not
created

Not
changed

Not
created

Not coded

Not
created

Not
changed

Not
created

created

'The

d i r e c t o r y s i z e i s o v e r r i d d e n i f t h e D I R S I Z E p a r a m e t e ra s
coded,

'The

Changingthe Sizeof or Reorganizingan Object Library
on a Simulation Area That Contains a Scheduler Work
Area and a SystemHistory Area

d i r e c t o r y s i z e i s o v e r r i d d e n i f t h e D I R S I Z E p a r a m e t e ri s
coded.

HISTORYParameter

Parameter

Scheduler
Work
Area

Directory
Sizel

System
History
Area

SYSTEM-YES Retaineo

Not
changed

Retained
(existing
entries
may be
lost)

SYSTEM-NO

Removed

Not
changed

Removed

Not coded

Retained

Not
changed

Retained
(existing
entries
may oe
lost)

lThe

d i r e " t o r y s i z e i s o v e r r i d d e n i f t h e D t R S I Z E p a r a m e t e ra s
coded.

4-122

Everysystempackmust havea systemhistoryarea(SHA),
which is usedto storeOCL, OCC,systemmessages.
message
responses,
control statements.
and other information(see
$ H l s n . T h e H I S T O R Yp a r a m e t ei rn t h e A L L O C A T E
statementallowsyou to specifythe sizeof the SHA on the
s y s t e mp a c k . T h e m i n i m u ms i z ei s 2 t r a c k s ;t h e m a x i m u m
i s t h e n u m b e ro f t r a c k si n t h e a v a i l a b laer e a . l f H I S T O R y
i s n o t s p e c i f i ew
d h e ny o u a r ea l l o c a t i n sgp a c eo n a s i m u l a tion area.the sizedefaultsto 2 tracks. The sizeof the SHA
r e m a i n su n c h a n g e du,n l e s si t i s a l t e r e db y a H I S T O R y
parameter. SeeSystem History Area under System Facilitr'esin Part2 of this manualfor additionalinformationin
determiningthe numberof tracksto be specifiedfor the
H I S T O R Yp a r a m e t e r .

WORK Parameter
T h eW O R K p a r a m e t e(rW O R K - c o d ei n) d i c a t etsh e l o c a t i o n
of the areathat containsa work area. Libraryentriesare
temporarilystoredin the work areawhile the program
m o v e sa n d r e o r g a n i z el isb r a r i e s P
. o s s i b lceo d e sa r e R l , F 1 ,
R2, F2, and thosefor the main dataareas.

Sizeof the Work Area

Location of Work Space

The work areamust be largeenoughto hold the directory
and the permanententriesof the sourcelibrary,object
libraryo
, r b o t h l i b r a r i eds e p e n d i nogn t h e p r o g r a mu s e . l f
you arecombininguses,suchaschangingthe sizesof both
libraries,the work areamust be largeenoughto hold the
contentsof both libraries.

The programusesthe lastavailablespacelargeenoughto
h o l dt h e l i b r a r yo r l i b r a r i e s .

Use

Contentsof Work Area

Createa sourcelibrary
( a no b j e c tl i b r a r ye x i s t s ) .

Objectlibrary

Changesourcelibrarysize
( a no b j e c tl i b r a r ye x i s t s ) .

Sourcelibraryand object
library

Changesourcelibrarysize
(anobjectlibrarydoes
not exist).

Sourcelibrary

Reorganize
sourceIi brary.

Source library

Chango
e b j e c tl i b r a r ys i z e .

Object library, if not compressin place (seeCompress in Place.l

R e o r g a n i zoeb j e c tl i b r a r y .

O b i e c tl i b r a r y .i f n o t c o m pressin place(seeCompressin place.l

l f t h e W O R K p a r a m e t ei rs s u p p l i e da n d i s n o t r e q u i r e di,t
w i l l b e i g n o r e da n d t h e m e s s a gW
e O RK P A R A M E T E R
I G N O R E Dw i l l b e l o g g e d .

Location of Area Containing the Work Space
The work spacecan be on any areaon any volume. However,it cannotbe the samesimulationareaasthe one you
specified in the TO parameter.The only requirementis
that the areahavespaceavailablelargeenoughfor the work
area. The programworksfasterif the simulationareacont r i v et h a nt h e a r e a
t a i n i n gt h e l i b r a r i e si s o n a d i f f e r e n d
containingthe work space.

PACKO Parameter
verifies
The optionalPACKOparameter(PACKO-name)
that the correctlibrary is beingaccessed
beforethe programperformsthe allocatefunction. lf supplied,the
programcomparesthe namegivenin the PACKo parameter
w i t h t h e n a m ei n t h e v o l u m el a b e lo n t h e s i m u l a t i o n
area
specifiedby the TO parameterto ensurethat they match.
l f n o t s u p p l i e dn, o v e r i f i c a t i o ins d o n e .
The namecan be any combinationof standardSystem/3
characters
exceptapostrophes,
leadingor embeddedblanks,
and embeddedcommas. lts lengthmust not exceed6
characters.SeeAppendixA for a list of standardSystem/3
characters.

$MAf NT-AIlocate Function

4-123

U S I N GT H E A L L O C A T EF U N C T I O N

Placementof the Source Library (An Obiect Library does
not Exist): The programassigns
the sourcelibraryto the
f i r s t a v a i l a b ldei s k a r e al a r g ee n o u g hf o r t h e l i b r a r y .

Creatinga SourceLibrary (SOURCE-number)
Surce Library Size
.

l f y o u a l l o c a t ea s o u r c el i b r a r ya f t e rd e l e t i n gi t . t h e s o u r c e
libraryis assigned
the sameway.

M i n i m u m : O n et r a c k .

o M a x i m u m : N u m b e ro f t r a c k si n t h e a v a i l a b laer e a .

Changing
the Sizeof (Reallocating)
a SourceLibrary
(SOURCE-numberl

o Regardless
of the numberof tracksyou specify,the f irst
two sectorsof the first track areassigned
to the library
directory. Additionalsectorsare usedas neededfor the
d i rectory.

Any time the programchangesthe sourcelibrarysize,it
reorganizes
both the sourceand objectlibrariesand deletes
all temporaryentries. (SeeReorganizing
a SourceLibrary.l
To do this, it needsa work area. (SeeWORKparameter.l

Placementof Source Library (An Object Library Exise,):
o The sourcelibrary must precedethe object library.
A
disk arealargeenoughfor the sourcelibrary mustfollow
the objectlibrary because
the programmovesthe object
libraryto makeroom for the sourcelibrary. To do this,
it needsa work area(seeWORK parameterl. The object
library is reorganized,
and all temporaryentnesare
deleted.
o lf you allocatea sourcelibraryafter deletingit, the
programautomaticallymovesthe object libraryto make
room for the sourcelibrary. The startinglocationof the
sourcelibrary is the previousstartinglocationof the
objectlibrary.

Making the Source Library Larger
o lf the simulationareacontainsan objectlibrary,space
m u s tb e a v a i l a b liem m e d i a t e lfyo l l o w i n gt h e o b j e c t
library. The programmovesthe objectlibraryto make
tracksavailableat the end of the sourcelibrary.
o lf the simulationareadoesnot containan objectlibrary.
spacemust be availableimmediatelyfollowingthe source
Ii brary.

Disk SpaceBeforeTracksAre Added to SourceLibrary
Source
Library
( 10 t r a c k s )

Disk SpaceBeforeGreatingSourceLibrary
Available
Space
( 15 t r a c k s )

Object Library
(30 tracks)

Object
Library
(30 tracks)

I o-t l--t-t t +Crr,o,n"'
Files

Crr,o-", (
Files

r8-47--+4s-62 +l
Tracks

\

lo-rl--B-3?---+l+-3;

Available
Space
(15 tracksl

Disk SpaceAfter 5 TracksAre Added to SourceLibrary

Tracks
Source
Library

I o-, l* t-t r*f*-

Oibect
Library
(30 tracks)

r.-or---l-0.- Urtl
Tracks

4-124

Available
Space
( 10 t r a c k s )

I

( 1 5t r a c k s|)

Disk SpaceAfter CreatingSourceLibrary
Source
Library
(5 tracks)

I

Curro,n".. (
Files

I o-, l* B-22
+-

Ob.iect
Library

lAvailable

i e ot r * t r )

| (io tr."rr)l

lSpace

'_*2--+u.-62>]
Tracks

Customer

Fil"'

Deletinga SourceLibrary (SOURCE-O)

Making the Source Library Smaller
lf thesimulation
a r e ac o n t a i n sa n o b j e c tl i b r a r y t, h e p r o grammovesthe end locationof the sourcelibraryto
m a k et h e l i b r a r ys m a l l e r .T h eo b j e c tl i b r a r yi s m o v e d ,
a n d s p a c eb e c o m easv a i l a b lfeo l l o w i n gt h e o b j e c tl i b r a r y .

T h e l i b r a r ym a i n t e n a n cper o g r a mm a k e st h e d i s ka r e a
o c c u p i e db y t h e s o u r c el i b r a r ya v a i l a b lfeo r o t h e ru s e( d i s k
f i l e s )b y m o v i n gt h e s t a r t i n gl o c a t i o no f t h e l i b r a r yt o t h e
b e g i n n i nogf t h e o b j e c tl i b r a r y .

lf thesimulation
a r e ad o e sn o t c o n t a i na n o b l e c tl i b r a r y ,
the programmovesthe end locationof the sourcelibrary
t o m a k et h e s o u r c el i b r a r ys m a l l e r .

T h e n ,i f y o u t r y t o r e c r e a t teh e s o u r c el i b r a r y ,$ M A I N T
checksfor sufficientlibraryspacefor the sourceand the
o b j e c tl i b r a r i e fsr o m t h e b e g i n n i nogf t h e o b j e c tl i b r a r y .

Disk SpaceBeforeSourceLibrary SizeWasDecreased
Source
Library
( 15 t r a c k s )

Object Library
(30 tracks)

I
|

Customer
Files

I o-, l-- t -22-+-23*s2---+.1

l f y o u w a n t t o r e t a i nt h e d e l e t e ds p a c ef o r l i b r a r yu s a g e ,
t h e O B J E C T - Rp a r a m e t esrh o u l db e u s e di n a d d i t i o nt o t h e
p a r a m e t eorn t h e s a m eA L L O C A T Es t a t e m e n t .
SOURCE-0
T h e n ,t h e s t a r t i n gl o c a t i o no f t h e o b j e c tl i b r a r yi s m o v e d
t o t h e s t a r t i n gl o c a t i o nf o r m e r l yo c c u p i e db y t h e d e l e t e d
s o u r c el i b r a r y .

Tracks

Disk SpaceBeforeSourceLibrary WasDeleted
Disk SpaceAfter 5 TracksWereTaken From Source
Library
Source
I
Library
I
(10 tracks) |

I o-t l* e*' t--l--

Obiect
Library
(30 tracks)

lAvailable
lSpace
I (5 tracks)

Customer
Fi l e s

Source
Library
( 15 t r a c k s )

I o-t l--t-

Curroa",. (
Files

Obiect Library
(30 tracks)

22-->V-23-52--t
Tracks

1s-47--r.F48-52
).1
Tracks

Disk SpaceAfter Source LibraryWasDeleted
( S O U R C E -o0n l y )
Object Library
(30 tracks)

Tracks

Disk SpaceAfter SourceLibrary WasDeletedWith Object
(SOURCE-0
and OBJECT-R)
Library Reorganized
ObjectLibrary
{3o tracks)

I o-, l*-

|
|

Ava ilable

^'--"--Space
:(:1: *
5 tracks)

--_+B-37

|
|

Customer
Fites

-l
38-s2

Tracks

$MAINT-AIlocate Function

4-125

Reorganizing
a SourceLibrary (SOURCE-Rl
Reasonfor Reorganizing the Library
Areasfrom which sourcelibraryentriesaredeletedare
completelyreusedfor new entries. lf an entry exceedsthe
spacein suchan area,the programputs as much of the
entry aswill fit in the areaand continuesthe entry in the
next availablearea. In this way, the programefficiently
useslibraryspace.This techniguehowever,may decrease
the speedat which thoseentriescan be readfrom the
library. Therefore,if you frequentlyadd or deletesource
libraryentries.you shouldreorganize
your sourcelibrary
periodically.

Reorganizing the Library
The programrelocates
entriesso that no entry is startedin
one areaand continuedin another. All temporaryentries
aredefeted. The programneedsa work area. lseeWARK
Parameter.l

Creatingan Object Library (OBJECT-numberl
Obiect Library Size
o M i n i m u m : T h r e et r a c k si n c l u d i n gt h e d i r e c t o r yt r a c k s .
o M a x i m u m : N u m b e ro f t r a c k si n a v a i l a b laer e a .
o Library Directory: The first 3 tracksin the libraryare
reserved
for the librarydirectoryif the library is to contain systemprograms;
otherwise.only the first track is
used. lf the DIRSIZE parameteris entered,the directory
sizespecified is used.

o Scheduler
Work Area. The scheduleris a componentof
the System/3SCPthat readsand processes
OCL statements. lt usesa work areaon disk (SWA)to temporarily
saveOCL file labelinformationduringthe processing
of
a program.The areais allocatedwhen SYSTEM-YESis
specified.The work spaceis not includedin the number
you specifyin the OBJECTparameter;
the spaceis calprogram.
culatedand assigned
by the library maintenance
The minimumspacerequiredfor the schedulerwork
your systemto
areais 18 tracks. lf you generated
supportcheckpoint/restart,
the sizeof the scheduler
work areais 33 tracks(includinga checkpoint/restart
area) .
SchedulerWork Area
withoutCheckpoint/
Restart

SchedulerWork Area
withCheckpoint/
Restart

18 tracks

33 tracks

The schedulerwork areacontainsFl and F7 labelinformation, an initiatortable,control statementarea,and miscellaneouswork areas.Thereis one schedulerwork areafor
each partition. (SeeScheduler Work Area under File Facilitr'esin Part 2 of this manual.)
Placementof Object Library (A Source Library Exists):
Spacefor the objectlibrary must be availableimmediately
followingthe sourcelibrary.
Placementof Object Library (A Source Library Does Not
Exist): The programassigns
the objectlibraryto the first
availablespacethat is largeenough.

Changingthe Sizeof (Reallocating)an Obiect Library
(OBJECT-number)
Making the Library Larger
The numberof tracksyou want to add must be available
immediatelyfollowingthe objectlibrary. The program
assigns
the additionaltracksto the library. (Thestarting
locationof the library remainsunchanged.)

Making the Library Smaller
The programmovesthe end locationof the object library
to decrease
the librarysize. Tracks,therefore,become
a v a i l a b lfeo l l o w i n gt h e l i b r a r y .

Reorganizin g the Library
Any time the programchanges
the librarysizeit alsoreorganizes
the libraryand deletesall temporaryentries(see
Reorganizingan Object Libraryl. A work area is neededif
other functionsare beingperformedwith the reorganization
lseeWORK Parameterl. lf not, a work areais not used(see
Compressin Placel .

Reorganizing
an Object Library (OBJECT-R)
Gapscanoccur betweenobjectlibraryentrieswhenyou add
and deleteentries. By reorganizing
the library,thesegaps
areremoved.Whenthe library is reorganized.
all temporary
entriesaredeleted.A work areais neededif other functions
(seeWORK
are beingperformedwith the reorganization
Parameterl. f f not, a work areais not used (seeCompress
in Placel.

compress
in Place{oa.recr-I ^
/

\

' o

, \

I I

InumDert/

lf an objectlibrary is to be reorganized,
or the sizeis to be
changedand this is the only functionto be performed.the
objectlibrary will be compressed
in place. This meansthat
the librarywill be reorganized
with all gapsremovedand all
temporaryentriesdeletedwithout the useof a work area.
lf supplied.the WORK parameterwill be ignoredand the
m e s s a gW
e O R K P A R A M E T E RI G N O R E Dw i l l b e l o g g e d .
lf, however,a sourcelibraryfunction is to be performedor
i f t h e d i r e c t o r ys i z e( D I R S I Z Ep a r a m e t e ro)r t h e p a c kt y p e
(SYSTEMparameter)or the systemhistoryareasize
( H I S T O R Yp a r a m e t e ri )s t o b e c h a n g e d
in conjunction
with an object libraryfunction,a work areawill be used
lseeWORK Parameterl.

Deletingan Object Library (OBJECT-0)
The programmakesthe disk spaceoccupiedby the object
library (andthe schedulerwork areaand the systemhistory
areaif this wasa systempack)availablefor other use.

$MAINT-Allocate Function

4'127

$MAINT-Copy Function
Use

USES
Use

Description

Reader-toLibrary

o Add or replace
a l i b r a r ye n t r y . T h e
r e a d e ri s t h e s y s t e mi n p u td e v i c e .

File-toLibrary

o Add or replace
o n e o r m o r el i b r a r y
e n t r i e s .A d i s kf i l e i s t h e i n p u t .

Libraryt o -Fi l e

o C o p yo n e o r m o r el i b r a r ye n t r i e st o
a d i s kf i l e .
o C o p yo n e l i b r a r ye n t r y ( o r t h o s e
entrieswith the samenamefrom
a l ll i b r a r i e s ) .

Libraryto-Library

(

o Copv libraryentriesthat havenames
g with certaincharacters.
beginnin
.

C o p ya l l l i b r a r ye n t r i e s .

o C o p ym i n i m u ms y s t e m .
o P r i n to n e l i b r a r ye n t r y ( o r t h o s e
e n t r i e sw i t h t h e s a m en a m ef r o m
a l ll i b r a r i e s ) .
o P r i n tl i b r a r ye n t r i e st h a t h a v en a m e s
b e g i n n i nw
g i t h c e r t a i nc h a r a c t e r s .
Libraryto-Printer

o P r i n ta l l l i b r a r ye n t r i e so f a c e r t a i n
rype.
.

P r i n td i r e c t o r ye n t r i e sf o r l i b r a r y
e n t r i e so f a c e r t a i nt y p e .

o P r i n te n t r i e sf r o m a l l d i r e c t o r i e s
i n c lu d i n gs y s t e md i r e c t o r y .
o P r i n ts y s t e md i r e c t o r yo n l y .

4-128

Description
Punchone libraryentry (or those
entrieswith the samenamef rom
alllibraries).

Library-toCardor
Diskette

P u n c hl i b r a r ye n t r i e st h a t h a v e
n a m e sb e g i n n i nw
g ith certain
characters.
P u n c ha l l l i b r a r ye n t r i e so f a c e r t a i n
type.
P r i n ta n d p u n c ho n e l i b r a r ye n t r y
(or thoseentrieswith the same
n a m ef r o m a l l l i b r a r i e s ) .

Libraryto-Printer
a n d - C a ro
dr
D iskette

P r i n ta n d p u n c hl i b r a r ye n t r i e st h a t
h a v en a m e sb e g i n n i nw
g ith certain
characters.
P r i n ta n d p u n c ha l l t e m p o r a r yo r
p e r m a n e nl ti b r a r ye n t r i e so f a
certaintype.

C O N T R OL S T A T E M E N TS U M M A R Y

Example of Data in Disk File

The control statements
you must supplydependon the
desiredresults.

O

All volumesreferenced
by the control statements
must
r e m a i no n l i n ed u r i n gt h e e x e c u t i o no f $ M A l N T .

ll copy FRoM-READER,LtBRARy-o.RETAIN
E.DECKOl

l o a dm o d u l e

Reader-toLibrary

// CEND

Add or Replacea Library Entry

O
/ Q

// coPY LTBRARY.s.NAME-DEcKo2

r

FRnM.READtsF.LTBRARv
// coPY
li t ,NAME-name,
/( "R1I

sourcemodule

li trruo

ro.code
[,PACKO-name]
[r.ro,*.{iN

@

// END

Library-to-File
, , O r . r rr n r r y

ll tgruO ..|

Vtustalwaysfollow the sourceor object
entry beingplacedinto the sourceor object
Ii brary.

Copy One or More Library Entria to a File
// COPYF ROM-code,TO-DlSK,F
I LE-fitename

[,*..r. l:: tl r,pACKrN.name]

L

/* , l& or /. statements
cannotbe presentin the entries
b e i n gc o p i e di n t o t h e l i b r a r i e s .

ts!_l

Control Statements Following // COPY
File-to-Library
Add or ReplaceOne or More Library Entries

(:
/n

/ / C O P YF R O M - D I S K . F I L E - f i l e n a m e . T O - c o d e

o

ri)

f
iname
1rv
characters.ALL}
) ,ruen4e-{

\ALL
// NEND .l|

{t}]
[-,.,lfrl][,,,o,,.

)

\P
// ENTRYLTBRARY I [.NEWNAME-name]
t ^) l

L L,TO-code
,NAME-characters.A

l-

lrrl

L

tnfj

l,nerntru-l t ! | [.NEWNAME-characters]

T O - c o d e , R E TA t N . <
P
|

L

(1.,_)

[ . P A C KN
l - n a m e ][ , P A C K O - n a m e ]

[ , P A C K I N - n a m e[], P A C K O - n a m@
el

Copy All Library Entries

(;
)
I I COPYFROM-code,LlBRARY-<
O
.NAME.ALL,

(1"
)

I

rrtl

L

t n )I

T O - c o dIe, R E T A I N - { >
P I [.PACKIN-name]

t,PACKO-namelO

Copy Minimum System
NEWNAMEparameteris neededin any of the following cases:

/ / C O P YF R O M - c o d e , L l B R A R Y - O , N A M E - S Y S TAE M ,
T O - c o d e[ , P A C K I N - n a m e[l, P A C K O - n a m e ] v

o lf you want the copy to havea differentnamethan
t h e o r i g i n ael n t r y .
o lf you want to replacean entry on the simulation
areaspecifiedby the TO parameterwith an entry
fromthesimulation
a r e as p e c i f i e b
dy the FROM
parameter,
but the entrieshavedifferentnames.
o lf you want the namesof the copiesto beginwith
differentcharacters
than the namesof the original
entries.the samenumberof characters
must be
i n t h e N E W N A M Ep a r a m e t ears i n t h e N A M E
parameter.
o lf the FROM and TO codesarethe same.
f f o t e ; N E W N A M Ec a n n o tb e D l R , A L L , o r S Y S T E M .

O

FROM and TO parameters
cannothavethe samecode.

P a g eo f G C 2 ' l - 5 1 6 2 - 1
lssued 28 Soptember 1979
By TNL: GN21-5674

Library-to-Printer-and/or-Card

Print Directory Entries for Library Entries of a Certain Type

Print and/or Punch One Library Entry (or Entrieswith the
SameName from All Libraries)

// coPYFRoM-code,LrBRARvI i l,r^t.-"'*,

t'..;/ l

lt copyFRoM-code,L,r*^*"
ll f ,rorr-".'",

(1...-)

( pRrNr )
TO-< PUNCH) [.PACKIN-name]
( enrecH)

T O - P RI N T [ , P A C KN
l -name]

[.oo,,{f i]

Print Entriesfrom All Directories lncluding System
Directory

o

L lR A R Y - A L L , N A M
/ / C O P YF R O M - c o d e . B
E - D lR ,

tTO-PRINTt,PACKIN-namel

Print and/or Punch Temporary and Permanent Library
Entries that Have NamesBeginning with Certain Characters

!

' - { :E^S
l,CDATE.
|
L

tNo

Print SystemDirectory Entries Only
E,- D l
I I C O P YF R O M - c o d e , L l B R A R Y - S Y S T E M , N A MR
T O - P RI N T [ , P A CK l N - n a m e ]

,NAME-characters.ALL,ro
{ ;li'i.tr }
tpnrpor)

Print Directory Entries, Omitting SelectedEnties
r S

\

\r I

[,PACKIN-name]

( -O
l l C O P YF R O M - c o d e , L l B R A R Y
t

lR

Print and/or Punch All Temporary and Permanent
Library Entriesof a Certain Type

\nll/

>.NAME-DIR,

l

\

\
To-pRrNTor\rrrrvrrr - Jname
1characters.ALL/

j
// copyFRoM.code,LrBRARyI |,-^r=.^.r,

[,PACKIN-name]

(' )

{ P R r N r)

COT{SIDERATI
ONS AND R ESTRICTIONS

I pnrpcHI

.

TO-( PUNCH ) I,PACKIN-namel

Whenthe library-to-filefunction is used,the FILE
parameteron eachCOPY control statementmust refer
to a uniquef ilename.Otherwise,previousentriesin
the file will be overlaid.

The CDATE parameteris validonly if LIBRARY-O
o r L I B R A R Y - A L Li s s p e c i f i e d .
$MAINT-Copy

Function

4-131

P A R A M E T E RS U M M A R Y
Parameter

Description

FROM.READER

Entry to be placedin libraryis to be readfrom the systeminput device.

FROM-code

T h e s i m u l a t i o na r e ac o n t a i n i n g
l i b r a r ye n t r i e st o b e c o p i e d ,p r i n t e d o
. r punched.
P o s s i b l e c o d e s aRr1e, F 1 , R 2 , F 2 .

FROM.DISK

T h e e n t r y o r e n t r i e st o b e p l a c e di n t o a l i b r a r yo r l i b r a r i e sr e s i d ei n a d i s kf i l e . T h e
d i s kf i l e m u s tb e d e s c r i b ebdy a n O C L F I L E s t a t e m e n t

F I L E - fi l e n a m e

For a file-to-libraryor library-to-filecopy. this parameteris neededto identify the
f i l e . T h e f i l e n a m em u s tm a t c ht h e f i l e n a m eo n t h e o c L F I L E s t a t e m e n t .

-'..lfff

,,r^-"
lil

F o r a f i l e - t o - l i b r a royr l i b r a r y - t o - f i lceo p y ,t h i s p a r a m e t egri v e st h e s i z eo f t h e d i s k
records.only 80- or 96-columncard imagerecordsareallowed. lf this parameter
i s o m i t t e d ,9 6 i s a s s u m e d .
Type of libraryentriesinvolvedin copy use. possiblecodesare:
Code

Meaning
Sourcestatements(sourcelibrary)
O C L p r o c e d u r e(ss o u r c el i b r a r y )

o

Objectprograms(objectlibrary)
R o u t i n e s( o b j e c tl i b r a r y )

LIBRARY.ALL

A l l t y p e so f e n t r i e s( S .P , O , a n d R ) f r o m b o t h l i b r a r i e a
s r e i n v o l v e di n t h e c o p y u s e .

LIBRARY.SYSTEM

O n l y s y s t e md i r e c t o r ye n t r i e sw i l l b e p r i n t e d .

*ott

(name

)

lrJrcters'eLLj

4-132

S p e c i f i cl i b r a r ye n t r i e so n t h e F R o M s i m u l a t i o na r e ao, f t h e t y p e i n d i c a t e di n
L I B R A R Y p a r a m e t e ri n, v o l v e di n c o p y u s e . p o s s i b l e
i n f o r m a t i o ni s :
Information

Meaning

name

Name of the library entry involved.

characters.ALL

Only those entries beginning with the indicated characters.
F o r e x a m p l e ,$ M A . A L L m e a n st h e l i b r a r v m a i n t e n a n c e
program($MAINT).

ALL

A l l e n t r i e s( t h e t y p e i n d i c a t e di n L I B R A R Y p a r a m e t e r ) .

Parameter

Description

NAME-SYSTEM

S y s t e mp r o g r a mtsh a t m a k eu p t h e m i n i m u ms y s t e ma n d I P L i n f o r m a t i o n
c o n t a i n e do n c y l i n d e r0 a r ec o p i e d .T h e m i n i m u ms y s t e mi s m a d eu p o f
systemprogramsnecessary
to loadand run programs.Systemprograms
necessary
to generateand maintainthe system.suchassystemservice
p r o g r a m sa.r en o t i n c l u d e di n t h e m i n i m u ms y s t e m .

NAME-DIR

D i r e c t o r ye n t r i e sf o r a l l l i b r a r ye n t r i e so f t h e t y p e i n d i c a t e di n t h e L I B R A R Y
p a r a m e t earr ei n v o l v e di n t h e c o p y u s e . l f t h e L I B R A R Y p a r a m e t ei rs
L I B R A R Y - A L L ,s y s t e md i r e c t o r ye n t r i e sa r ea l s op r i n t e d .

(r)

Adding Entry to Library. RETAIN givesdesignationof the TO entry:

t')

Code

Meaning

T

Temporary

PorR

Permanent

R E T A I N .P< >

ReplacingExisting Library Entry. RETAIN givesdesignationof the TO entry
and tellsthe programwhetherto issuea message
beforereplacingentry:
Code

Meaning
Temporarydesignation.lssuemessage
beforereplacingentry.
Permanentdesignation.lssuemessage
beforereplacingentry.
Permanentdesignation.Do not issuemessage
beforereplacing
entry.

Printing or Punching Entries. The RETAIN parameter is ignored.
TO-code

The simulation area that is to contain the copies of the entries. Possiblecodes
a r eR 1 , F 1 , R 2 , F 2 .

TO-PRINT

E n t r i e sa r e o r i n t e d .

TO-PUNCH

Entries are punched or written to diskette (the diskette device must be specified
a st h e P U N C H d e v i c e ) .

TO-PRTPCH

Entries are printed and punched, or printed and written to diskette (the diskette
d e v i c em u s t b e s p e c i fi e d a s t h e P U N C H c l e v i c e ) .

TO-DISK

T h e e n t r y o r e n t r i e sa r e t o b e c o p i e d t o a d i s k f i l e . T h e d i s k f i l e m u s t b e d e s c r i b e d
by an OCL FILE statement.

$MAINT-Copy Function

4-133

Parameter

Description

NEWNAME-name

Nameyou want usedon the simulationareaspecifiedby the TO parameterto
identify the entriesbeingput on that simulationarea. lf you omit this parameter,
the programusesthe NAME parameterin namingthe entries.

NEWNAME'characters

you want to usein namesidentifyingentriesbeingput on TO
Beginning
characters
simulationarea. You must usethe samenumberof characters
as in the NAME
parameter(NAME-characters.ALL).
lf you omit this parameter,
the programuses
the NAME parameterin namingthe entries.

OMfT-name

Whenprintingdirectoryentries,omit the entry specifie
d by name.

OMIT-characters.ALL

Whenprintingdirectoryentries,omit all entrieswith thesebeginningcharacters.

PACKO-name

Nameof the simulationareaspecified by the TO parameter.

PACKIN-name

Nameof the simulationareaspecified by the FROM parameter.

VtrC
CDATE-N;

4-134

The optionalCDATE-YESparameterspecifiesthat the compilationdateand time
f o r t h e C O B O L ,F O R T R A N ,a n d R P Gp r o g r a m as r et o b e p r i n t e d t; h i s i s t h e s a m e
dateand time that appearedin the headingduringcompilation(time is shown
only if timer supportwasgenerated
on the systemdoingthe compilation).When
CDATE-YESis specified,executiontime may be increased
because
$MAINT must
obtainthe dateand time from the objectprogram.The dateand time are not
printedif CDATE-NOis specified or assumed.(The CDATE parameter,YES or
N O , i s v a l i do n l y w h e n L I B R A R Y - Oo r L I B R A R Y - A L Li s s p e c i f i e d . )

L I B R A R YD I R E C T O R I E S

N A M I N GL I B R A R YE N T R I E S

Sourceand Object Library Directories

to Use
Gharacters

o The sourceand objectlibrarieshaveseparate
library
directories.Everylibraryentry hasa corresponding
entry in its librarydirectory. The directoryentry cont a i n ss u c hi n f o r m a t i o na st h e n a m ea n d l o c a t i o no f t h e
librarventry. (SeeFigures4-73 and4'74-l

exceptblanks,
Useany combinationof System/3characters
commas.quotes,and periods(AppendixA liststhe characs e g i nw i t h a d o l l a r
t e r s ) . T h e n a m e so f m o s t I B M p r o g r a m b
p
o
s
s
i
b
l
e
(
$
)
.
d
u
p
l i c a t i o nd, o n o t
t
o
a
v
o
i
d
Therefore,
sign
i
n
t
h
e n a m e sy o u u s e
f
i
r
s
t
c
h
a
r
a
c
t
e
r
a
s
t
h
e
u s ea d o l l a rs i g n
be
alphabetic'
your
must
f
irst
character
The
for
entries.

programmakesan entry in the
o The library maintenance
d i r e c t o r ya f t e ri t h a sp u t t h e e n t r y i n t h e l i b r a r y .
Lengthof Name
SystemDirectorY
o E a c hs i m u l a t i o n
a r e at h a t c o n t a i n sl i b r a r i e cs o n t a i n sa
The systemdirectorycontainsinfor'
directory.
system
s
i z e so f a n d a v a i l a b lsep a c ei n l i b r a r i e s
t
h
e
m a t i o na b o u t
d
i
r
e
c
t
o
r
i
e s(.S e eF i g u r e4 ' 7 5 . )
a n dt h e i r
programcreatesand maintains
o The library maintenance
d
i
r
e
c
t
o
r
y
.
thesystem

long.
The namecan be from 1 to 6 characters

RestrictedNames
D o n o t u s et h e n a m e sA L L , D l R . a n d S Y S T E M .T h e yh a v e
s p e c i am
l e a n i n gisn t h e N A M E p a r a m e t e r .

Entrieswith the SameName
For eachof the two physicallibraries,sourceand object,
therearetwo typesof entries.The sourcelibraryhastype
P and type S entries.The oblectlibraryhastype O and
type R entries. Entriesof the sametype cannothavethe
samename,but entriesof differenttypesmay' For exin a sourcelibrarycannothavethe
ample,two procedures
procedure
and a setof sourcestatements
samename,but a
can.

$MAINT-CoPY Function

4-135

R E T A I NT Y P E S
TemporaryEntries
o T e m p o r a r ye n t r i e sa r ee n t r i e sy o u
d o n o t i n t e n dt o k e e p
i n y o u r l i b r a r i e sT
. h e ya r en o r m a l l yu s e do n r yo n c eo r
a f e w t i m e so v e ra s h o r tp e r i o d .
o I n t h e o b j e c tl i b r a r y ,t e m p o r a r y
e n t r i e sa r ep l a c e d
t o g e t h efro l l o w i n gt h e p e r m a n e net n t r i e s .
A n y t r m ea
p e r m a n e net n t r y i s a d d e dt o t h e l i b r a r y ,
alltemporary
entnesare deleted.Temporaryentriesarealso
deleted
w h e ny o u r e p l a c e
o n e p e r m a n e net n t r y w i t h a n o t h e r .
o I n t h e s o u r c el i b r a r y ,r e m p o r a r y p e r m a n e n t
and
entries
c a nb e i n a n y o r d e r . O n ee n t r y i s p l a c e da f t e r
anotner
r e g a r d l e so sf t h e i rd e s i g n a t i o n sT.e m p o r a r y
entries,
therefore,are not automaticallydeletedevery
time you
add a permanententry. However,when the source
l i b r a r yi s r e a l l o c a t eodr r e o r g a n i z eodn, l y p e r m a n e n t
e n t r i e sr e m a i n .
Y o u c a n u s et e m p o r a r ye n t r i e sa so f t e n a sy o u
l i k eu n t i l
they aredeleted.
o A temporary entry cannotreplace permanenr
a
entry.
PermanentEntries
P e r m a n e n te n t r i e sa r e e n t r i e sy o u i n t e n d t o
keep in your
l i b r a r i e s . T h e y a r e n o r m a l l y e n t r i e sy o u
u s eo f t e n o r a t
r e g u l a ri n t e r v a l s( o n c e a w e e k , o n c e a m o n t h ,
and so on).
T h e p r o g r a m w i l l n o t d e l e t e p e r m a n e n te n t r i e s
u n l e s sy o u
u s e t h e d e l e t ef u n c t i o n o f t h e l i b r a r y m a i n t e n a n c ep r o _
g r a m t o d e l e t et h e m , o r t h e a l l o c a t ef u n c t i o n
to delete
the entire library.

4-136

S I M UL A T I O NA R E A V E R IF I C A T I O N
T h eo p t i o n a lP A C K I N ( p A C K l N _ n a m a
en
) d / o rP A C K O
( P A C K o - n a m ep)a r a m e t e rvse r i f yt h a t
t h e c o r r e c tr i b r a r i e s
are beingaccessed
beforethe programperformsthe copy
f u n c t i o n . l f t h e P A C K I Np a r a m e t ei rs s u p p l i e d , p r o _
tne
g r a mc o m p a r etsh e n a m eg i v e nw i t h t h e n a m e
in thevolume
l a b e lo n t h e s i m u l a t i o na r e as p e c i f i e b
d y t h e F R O Mp a r a m _
e t e rt o e n s u r et h a t t h e y m a t c h . l f t h e P A C K Op a r a m e t e r
i s s u p p l i e dt ,h e p r o g r a mc o m p a r etsh e n a m eg i v e n
with the
n a m ei n t h e v o l u m el a b e lo n t h e s i m u l a t i o n
a r e as p e c i f i e d
by the TO parameterto ensurethat they match. lf not
s u p p l i e dn, o v e r i f i c a t i o n
isdone.
T h e n a m es p e c i f i e idn t h e p A C K I Na n d / o rP A C K Op a r a m _
eterscan be any combinationof standardSystem/3
charac_
tersexceptapostrophes,
leadingor embeddedblanks,and
embeddedcommas.lts lengthmust not exceed6 characters.
SeeAppendixA for a list of standardSystem/3characters.

U S I N GT H E C O P YF U N C T I O N

Replacing Existing Entries

Reader-to-Library

o The programcan replacean existinglibraryentry with
t h e e n t r y y o u a r ep u t t i n gi n t h e l i b r a r y . T h e R E T A I N
parameterspecifiesthe new retaintype. lf the RETAIN
p a r a m e t ei rs o m i t t e d ,R E T A I N - Ti s a s s u m e dA. t e m p o rary entry cannotreplacea permanententry.

lnput
The programreadsone libraryentry. lt can be any one of
the followingtypes:
O Sourcestatements
o Procedure
o Objectprogram
.

o The programcan issuea message
beforereplacingan
e x i s t i n ge n t r y . W h e t h e irt d o e sd e p e n d o
sn the RETAIN
parameteryou use. (SeeRETAIN Parameter.l
o Beforethe new entry is added,the duplicateentry is
d e l e t e d .A d d i t i o n a l i b r a r ys p a c ei s n o t n e e d e du n l e s s
t h e n e we n t r y i s l a r g e tr h a nt h e o l d o n e .

Routine

The entry is readfrom the systeminput device.

File-to-Library

The headerrecordon an objectdeck (H in column 1) containsthe datethe deck waspunched.This date is in
columns58-63 and is in the format of the systemdate,
eithermmddyy or ddmmyy.

lnput

Output
.

Duplicatecharacters
are removedfrom sourcestatements
and procedures
beforethey are put in the sourcelibrary.
The programdoesnot checkthem for errors.

T h e d i s kf i l e c a nc o n t a i no n e o r m o r el i b r a r ye n t r i e s .T h e
entriesmust be in the format put out by the library-to-card
functionor by the linkageeditor. The COPYstatementat
the beginningof eachentry containsthe nameof the entry
a n dt h e t y p e o f l i b r a r y( S .P , O , R ) . A C E N Ds t a t e m e n t
m u s tf o l l o w e a c he n t r y i n t h e f i l e .
T h e d i s kf i l e m u s tb e a s e q u e n t i af ill e a n d b e d e f i n e db y a
F I L E s t a t e m e nitn t h e O C L f o r t h e l i b r a r ym a i n t e n a n c e
p r o g r a m .M u l t i v o l u m e
f i l e sa r en o t s u p p o r t e d .

o Objectprogramsand routinesare placedin the object
libraryafter sequence
and checksuminformationis
removed.

Output

Adding Entries

The output from the file-to-libraryfunction is the sameas
for the reader-to-library
function.

o The programcan add a new entry to a library. The name
of the entry is takenfrom the NAME parameter.See
NamingLibrary Entriesfor validnames.The RETAIN
parameter
specifies
whetherthe entry will be temporary
or permanent.lf the RETAIN parameteris omitted,
RETAIN-Tis assumed.lseeRetain Types.l

$MAfNT-CopyFunction

4-137

Library-to-File
lnput
The programcan copy one or more libraryentriesfrom a
libraryto a disk file. The typesof entriescan be:
o Sourcestatements
o Procedures
o Objectprograms
a Routines
o All of the precedingtypes
T h e N A M E a n d L I B R A R Y p a r a m e t e rosn t h e E N T R y
statements
specifywhich entriesto copy.

Output
The output from the library-to-filefunction is of the same
format asthat from the library-to-card
function. The output is written to a sequential
disk file definedby an OCL
FILE statementand createdby the librarymaintenance
program.Multivolumefilesare not supported.

Output
The entries,regardless
of their type, arecopiedfrom one
simulationareato anotherwithout change..
Entriescan be copiedand renamedon the samesimulation areaby useof the NEWNAMEparameter.(See
NEWNAME Parameter and Naming Library Entries,l
C o p y i n ga m i n i m u ms y s t e m( L I B R A R Y - O .
N A M E - S Y S T E Mo)r, a l l o f t h e t y p e s( L t B R A R Y - A L L ,
N A M E - A L L ) ,c r e a t e as s y s t e mp a c kf r o m w h i c ha n I P L
c a nb e p e r f o r m e d .( C o p y i n gL I B R A R Y - A L L ,
N A M E - A L Lw i l l c r e a t ea s y s t e mp a c ko n l y i f t h e s i m u l a tion areaspecified by the FROM parameteris a system
pack.) The objectlibrary on the simulationareayou
specifyin the TO parametermust be empty; that is, it
cannotcontainany entriesor deletedentries.Also,the
objectlibraryon the simulationareaspecifiedby the
TO parametermust havebeenallocatedwith a scheduler
work areaand a checkpoint/restart
areaat leastaslarge
as thoseon the simulationareaspecifiedby the FROM
parameter.
The RETAIN parameterspecifies
whetherthe entrieswill
b e t e m p o r a r yo r p e r m a n e n t l. f t h e R E T A I N p a r a m e t e r
is omitted. RETAIN-T is assumed.Whenthe parameters
L I B R A R Y - A L La n d N A M E - A L Lo r L I B R A R Y - Oa n d
NAME-SYSTEM
a r eu s e d ,R E T A i N - Pi s a s s u m eadn d
R E T A I N - Ti s i n v a l i d .

Library-to-Library
lnput

Adding Entries

The programcan copy one or more libraryentriesfrom
one simulationareato another. The typesof entriescan be:

o Y o u c a no m i t t h e N E W N A M Ep a r a m e t e rl.f y o u d o , t h e
nameusedfor the copy is takenfrom the NAME parameter. (Thecopy will havethe samenameasthe original
entry.)

o Sourcestatements
o Procedures
o Objectprograms
.

Routines

r

All of the precedingtypes

o M i n i m u ms y s t e m
T h e N A M E a n d L I B R A R Y p a r a m e t e rssp e c i f yw h i c he n t r i e s
to copy.

4-138

o l f N A M E - A L Li s s p e c iife d ,t h e n a m e sb y w h i c ht h e
entriesare identifiedon the simulationareaspecified by
the FROM parameterarealsousedon the simulation
arbaspecifiedby the TO parameterto identify the
entries.

Replacing Ex isting Entr ies
o The programcan replaceexistingentries
with the entries
you are putting in the library. lf the entry you
are
copying(the entry on the simulationareayou identify
in the FROM parameter)hasthe samenameasthe entry
you are replacing(the entry on the simulation
areayou
identify in the TO parameter),
you must omit the
N E W N A M Ep a r a m e t ebre c a u steh e N E W N A M Ep a r a m eter cannotbe the sameasthe NAME parameter.lf the
namesarenot the same,you must usethe N EWNAME
parameterto givethe nameof the entry being
replaced.
.

The programcan halt beforereplacingan existingentry.
Whetherit doesdependson the RETAIN parameter.
(SeeRETAI N Parameter.l

o A temporaryentry cannotreplacea permanent
entry.

Library-to-Printerand/or Card
Typesof Entries that Can ge printed or punched
The programcan print or punchone or more library
entries.
They can be any one of the followingtypes:
o Sourcestatements
a Procedures
o Object programs

The programcan print (but not punch)the followingtypes
of directoryentries:
o Sourcestatements
o Procedures
o Objectprograms
o Routines
.

Systemdirectory

o All of the precedingtypes
The programwill sort directorynamesbeforeprintingthem
only if there is enoughwork spaceto containthe directory
on the simulationareaspecifiedby the FROM paramerer.

Printed or Punched Library Entries
o Duplicatecharacters
are reinsertedinto sourcestate_
mentsand procedures
to makethem readable.
o Objectprogramsand routinesare printedand punched
after sequence
informationand checksuminformation
( p u n c ho n l y ) h a sb e e na d d e d .
o The libraryentries,when punched,areprecededby
a
COPYstatementof the reader-to-library
format and
followed by a CEND statement.

a Routines
r

All of the precedingtypes (limitedto entrieshavingthe
samenameand entriesbeginningwith the same
characters)

$MAINT-Copy

Function

4-139

Printout of Directory Entries
a The format of the sourcelibrarydirectoryprintout is
d e s c r i b e idn F i g u r e4 - 7 3 . l t t h e r ej s .n o s o u r c el i b r a r y ,
t h e N o s o u R c E L T B R A R YE X T S T S
m e s s a gi e
stogged.
l f a s o u r c el i b r a r ye x i s t sb u t i s e m p t y ,t h e N O - S O U R C E
D I R E N T R I E SE X I S Tm e s s a gi e
stogged.
o The format of the object librarydirectoryprintout is
describedin Figure4-74. lt thereis no objectlibrary,
the No oBJEcT LtBRARYEXTSTS
m e s s a gi e
stogged.
lf an objectlibraryexistsbut is empty, the NO OBJECT
D I R E N T R I E SE X I S Tm e s s a gi e
stogged.
o A samplesystemdirectoryprintout is describedin
F i g u r e4 - 7 5 . l f t h e r ei s n o s o u r c el i b r a r y ,t h e N O
S O U R C EL I B R A R YE X T S T O
S N T H t Sp A C K m e s s a g e
i s l o g g e d .l f t h e r ei s n o o b j e c tl i b r a r y ,t h e N O O B J E C T
L I B R A R Y E X I S T SO N T H t S P A C Km e s s a gi e
stogged.
The followingfieldsin the directoryprintout arenot updatedwhen an objectlibraryentry is deleted:
o The numberof availabledirectoryentries
o The locationof the next available
directoryentry
o The next availablelibrary sector
a The numberof availablelibrarysectors

4-140

Theserepresent
only contiguousspacethat can be used;
thereforegapsarenot included. In the objectlibrarysection
o f t h e s y s t e md i r e c t o r yp r i n t o u tt h e l i n e sU N U S E DS P A C E
F R O MD E L E T E DP E R M A N E N TaSn d U N U S E DS P A C E
F R O MD E L E T E DT E M P O R A R I EdSe s c r i bteh e s p a c e
occupiedby gaps. This spacecould be madeavailablefor
useif the object librarywereto be reorganized.lf this
spaceis excessive,
the library shouldbe reorganized.
The f inal line of the systemdirectoryprintout showshow a
control statementmight havebeencodedto resultin the
indicated
allocation.
Library informationis givenin both sectorsand tracks.
Whenthe numberof activeor available
sectorsis not evenly
divisibleby 24, a roundingschemeis usedto determinethe
sizein tracks. The fieldsdescribingactivelibraryspaceare
roundedup when convertingfrom sectorsto tracks,and the
fieldsdescribing
availablelibraryspaceare roundeddown
in the conversion.For example,in the sourcelibrarysect i o n ,t h e l i n e sD I R E C T O R YS P A C EP. E R M A N E N T
L I B R A R YS P A C Ea, n dA C T I V EL I B R A R YS P A C Ea r ea l l
referringto activespace.Thusthe numberof trackshas
beenroundedup whenevera fractionof a track wasactive.
T h e n u m b e ro f t r a c k sr e p r e s e n t i nAgV A I L A B L E L I B R A R y
SPACEwasroundeddown in the conversionfrom sector
sizeto track size.

PRINTOUT

DIRECTORY
F R O MX X V O L . I D X X X X X X M M I D D / Y YH H . M M . S S I
SOURCE

TYPE
X

A D D RE S S
NAME FIRST@
LAST@
XXXXXX XXX.XX
XXX,XX

ATTRI
X

#SECTORS
XXXX

Explanation:
Heading

Meaning

TYPE

S = sourcesratemerlts
P = procedure

NAME

N a m eo f l i b r a r ye n t r y ( u p t o s i x c h a r a c t e r s )

ADDRESS
( F I R S Ta n d L A S T )

A d d r e s s eosf f i r s t a n d l a s ts e c t o r tsh a t c o n t a i nt h e l i b r a r ye n t r y . A d d r e s s easr e
e x p r e s s ebdy t r a c ka n ds e c t o rn u m b e r s .E x a m p l e r0 0 9 - 0 3m e a n st r a c kg ,
sector3.

ATTRI

T = temporary
P = permanent

#SECTORS

T o t a l n u m b e r o f s e c t o r su s e df o r t h e l i b r a r v e n t r v

^The

t i m e s p e c i f i e db y H H . M M . S Si s i n c l u d e di n t h e p n n t o u t o n l y r f t h e t i m e , o t - d a yf u n c t i o n w a s s e l e c t e dd u r i n g s y s t e mg e n e r a r i o n

Figure 4-73. Sourcc Library Directory Printout

$MAfNT-Copy Function

4-141

P a g eo f G C 2 1 - 5 1 6 2 . 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TN L: cN21-5674

PRINTOUT

O B J E C TD I R E C T O R Y F R O M X X V O L . I D X X X X X X M M / D D / Y Y H H . M M . S S I

DISK
CYL/ TXT- LINK EXT RLD ENTRY CORE
TYPE NAME ADD
SEC CAT ADDR BUF DISP PNT
SEC
ATTR
XX X XXXXXX TTT/SS CC/SS XXX XXXX XXX XX
XXXX XXX
XXXX

TOT
LEVEL SEC
CDATE-CTIME
XXX
XXXX XX/XX HH.MM

Explanation:
Heading

Meaning

TYPE

The leftmost character printed indicatesthe attributes of the entry as follows:
P = permanent
T = temporary

T h e m i d d l ec h a r a c t epr r i n t e di n d i c a t etsh e m o d u l ec l a s sn u m b e ra sf o l l o w s :
Blank =
=
1
=
2
=
3

c l a s s0
class1
class2
class3

Classnumbersaresignificantwhenjobs are beingplacedon the spoolreaderqueue
by $OCOPYunderCCPand $OCOPYuserauthorizationis required.A usermay not
e x e c u t ea p r o g r a mw i t h a c l a s sn u m b e rh i g h e rt h a n t h a t f o r w h i c hh e i s a u t h o r i z e d .
(SeeProgramClassificationunder$OCOpy.)
T h e r i g h t m o sct h a r a c t epr r i n t e di n d i c a t etsh e t y p e o f m o d u l e . l t s m e a n i n g
i s a sf o l l o w s :
O = objectmodule
R = routine
NAME

N a m eo f l i b r a r ye n t r y ( u p t o 6 c h a r a c t e r s )

D S KA D D

A d d r e s sw h e r el i b r a r ye n t r y b e g i n so n d i s k . E x a m p l e :0 1 b / 1 0m e a n st r a c k l b .
s e c t o r1 0 ( i n d e c i m a l ) .T = t r a c k .S = s e c t o r .

CYL/SEC

A d d r e s sw h e r el i b r a r ye n t r y b e g i n so n d i s k ( i n h e x a d e c i m a l )C. = c y l i n d e rS
, = sector.

'The

t i m e s p e c i f i e db y H H M M . S S i s i n c l u d e d i n t h e p r i n t o u t o n l y i f t h e t i m e - o f - d a y f u n c t i o n w a s s e l e c t e dd u r r n g
systemgeneration.

Figure 4-74 {Part 1 of 3}. Object Library Directory printout

4-'t42

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

Heading

Meaning

TXT-CAT

For object program, this number indicatesthe number of sectorsuseclfor the text
p o r t i o n o f t h e l i b r a r y e n t r y . o b j e c t p r o g r a m sc o n s i s to f t w o p a r t s : t e x t a n d R L D .
T e x t i s t h e p r o g r a m ; R L D i s i n f o r m a t i o n u s e d i n l o a d i n gt h e p r o g r a mf o r e x e c u t i o n .
F o r r o u t i n e s ,t h i s n u m b e r i s t h e c a t e g o r yo f t h e r o u t i n e . T h i s n u m b e r i s u s e d b v t h e
o v e r l a y l i n k a g ee d i t o r f o r d e t e r m i n i n go v e r l a y s t r u c t u r e s .

L I N KA D D R

o b j e c t p r o g r a m so n l y . A s s i g n e dh e x a d e c i m a l i n k - e d i t a d d r e s so f t h i s l i b r a r y
entry. lf the program has external buffers (attribute byte 1, bit2=j and attribute
b y t e 2 , b i t 1 = 1) , t h e l o w - o r d e r b y t e o f t h e l i n k - e d i t a d d r e s si s a s s u m e dt o b e X ' 0 0 , .

EXTBUF

lf the program has external buffers (attribute byte 1, bit2=1 and attribute rrvte
2 , b i t 1 = 1 ) , e x t e r n a l b u f f e r s i z ei s i n d i c a t e di n s e c t o r s .

R L DD I S P

o b j e c t p r o g r a m so n l y . l t i n d i c a t e st h e h e x a d e c i m a lp o s i t i o n i n w h i c h R L D i n f o r m a t i o n b e g i n si n t h e l a s t t e x t s e c t o r . l f t h e l a s t t e x t s e c t o rc o n t a i n sn o R L t )
i n f o r m a t i o n , t h e R L D d i s p l a c e m e n it s 0 , i n d i c a t i n gt h a t t h e i n f o r m a t i o n s t a r t s
in the next sector.

E N T R YP N T

O b j e c t p r o g r a m so n l y . M a i n s t o r a g ea d d r e s s( h e x a d e c i m a l w
) h e r e p r o g r a me x e c u t i o n
begins before relocations.

C O R ES E C

M a i n s t o r a g es i z e ,g i v e n i n s e c t o r s ,r e q u i r e dt o r u n t h e p r o g r a m .

ATTR

Byte 1:

B i t0 = 1
0
B i t1 = 1
Bit 2=0
1

Bit3
Bit4=1

P e r m a n e netn t r y
T e m p o r a r ye n t r y
I n q u i r y . T h i s p r o g r a mr e q u i r e tsh a t t h e I n q u i r yk e y b e p r e s s etdo s t a r t
processi
ng.
M u s tb e z e r oi f a t t r i b u t eb y t e 2 b i t 1 = 0 .
E x t e r n abl u f f e r s( i f a t t r i b u t eb y t e 2 , b i t 1 = 1 ) . T h i s p r o g r a mu s e sd i s k
databuffersthat are outsidethe userprogramareabut within the
p a r t i t i o n ( s e en o t e 1 ) .
P r o g r a mc l a s s( s e en o t e 2 ) .
S o u r c er e q u i r e d . T h i s p r o g r a m r e q u i r e st h e a l l o c a t i o no f t h e $ W O R K
and $SOURCE files. $SOURCE must be filled eitherfrom the svstem
i n p u t d e v i c eo r f r o m a s o u r c el i b r a r y . T h i s p r o g r a mc a n b e p r e c e d e db y
the macro processor. lf a // SWITCH statement containing
l X X X X X X X w a s p r o c e s s e dt,h e $ S O U R C E f i l e i s o p e n e c a
l sinput
instead of output.

Notes:
1 . A checkpoint/restart program will have attributes of hex 0040 and a program with external buffers will have
2.

attributes of hex 2040. The checkpoint/restart and external buffers attributes are mutually exclusive.
A t t r i b u t e b y t e 1 b i t 3 i s t h e l e f t m o s t b i t a n d a t t r i b u t e b y t e 2 b i t 6 i s t h e r i g h t m o s tb i t o f a 2 - b i t b i n a r y p r o g r a m
c l a s sn u m b e r .

Figwe 4-74 (part 2 of 3). Object Library Directory printout

$MAfNT-Copv Function

4-143

Page
of GC21-5162.1
lssued28 September
1979
ByTNL: cN21-5674
Heading

Meaning

ATTR
(Continued
)

Bit 5=1
Bit6=1
Bit7=1

D e f e r . r . reldo t i r i t . T h i : p r o g r a ma c c e p t sm o u n t i n go f d a t am o d u l e s
d u r i n gi t s e x e c u t i o n .
P T F a p p l i e d .A p r o g r a mt e m p o r a r yf i x ( p T F ) h a sb e e na p p l i e dt o
t h i sp r o g r a m .
O v e r l a yo b i e c tp r o g r a m

Byte 2:
Bit 0=1
Bit 1=1

s y s t e m i n p u t d e d i c a t i o n . T h e s y s t e m i n p u t d e v i c em u s t b e d e d i c a t e dt o
t h i s p r o g r a m . T h e d e v i c em a y b e r e l e a s e dw h e n n o l o n g e r n e e d e d .
c h e c k p o i n t / r e s t a r tp r o g r a m ( i f a t t r i b u t e b y t e 1 b i t 2 = 0 ) . ( s e e n o t e 1 . )
E x t e r n a l b u f f e r s ( i f a t t r i b u t e b y t e 1 , b i t 2 = 1 ) . T h i s p r o g r a mu s e s

Bit 2=1

d i s k d a t a b u f f e r s t h a t a r e o u t s i d e t h e u s e r p r o g r a m a r e ab u t w i t h i n
t h e p a r t i t i o n { s e en o t e 1) .
D i r e c t s o u r c er e a d . T h i s p r o g r a m c a n h a v ea / / c o M p l L E s t a t e m e n t
a n d a n o s o u r c er e q u i r e da t t r i b u t e ( b y t e 1 . b i t 4 = 0 ) . T h e p r o g r a mw i l l
a c c e s st h e s o u r c ei t s e l f .

Bit 3=1
Bit 4=1
Bit 5=1

Bit 6
Bit 7=1

T h i s p r o g r a m h a s b e e n l i n k - e d i t e do r c o m p i l e d u s i n gs y s t e m c o n t r o l
P r o g r a mN u m b e r 5 7 0 4 S C 2 .
P r i v i l e g e dp r o g r a m .
P r o g r a mc o m m o n . T h i s p r o g r a m r e q u i r e st h a t a n e w l o a d a d d r e s sb e
c a l c u l a t e da t l o a d t i m e t o p l a c e i t i n m a i n s t o r a g eb e y o n d i t s o w n
p r o g r a mc o m m o n r e g i o n .
P r o g r a mc l a s s( s e en o t e 2 ) .
M e m o r y r e s i d e n to v e r l a y p r o g r a m .

L E V EL

R e l e a s el e v e lo f s y s t e mp r o g r a m s . F o r u s e r p r o g r a m s ,t h i s l e v e l i s a n u m b e r
a s s i g n eb
d y t h e o v e r l a yl i n k a g ee d i t o r . F o r a C O B O L , F O R T R A N . o r R p G l l
o b j e c t p r o g r a m ,t h e l e v e l i s p r i n t e d a s C O B , F O R , o r R p G .

TOT SEC

T o t a l n u m b e r o f d i s k s e c t o r so c c u p i e d b y t h e l i b r a r y e n t r y .

CDATE-CTIME

T h i s h e a d i n gi s f o r C O B O L , F O R T R A N , a n d R P G i l o b j e c t p r o g r a m s ;t h e d a t e
a n d t i m e a r e p r i n t e d o n l y i f t h e o b j e c t L l r o g r a mi s c o m p i l e d w i t h r e l e a s e3 o r
l a t e r o f p r o g r a m n u n r b e r 5 7 0 4 - s c 2 l f c D A T E - y E S w a s s p e c i f i e do n t h e c o p y
c o n t r o l s t a t e m e n t ,t h i s i s t h e d a t e a n d t i m e d u r i n g w h i c h t h e o b j e c t p r o g r a m
w a s c o m p i l e d ;t h e s a m ed a t e a n i l t i m e a p p e a r e do n t h e h e a d i n go f t h e c o m p i l e
l i s t i n g ( t i n r e i s s h o w n o n l y i f t i r n e r s u p p o r t w a s g e n e r a t e do n t h e s y s t e md o i n g
the conrpilation). The format of CDATE can be either mmidd (month and day)
o r d d / m m ( d a y a n d m o n t h ) d e p e n d i n go n t h e f o r m a t s e l e c t e df o r t h e s y s t e m
d a t e d u r i n q s y s t e mg e n e r a t i o n . T h e f o r m a t f o r C T I M E i s a l w a y sh h . m m
( h o u r . m r n u t e ) . l f t h e C D A T E f j a r a n t e t ew
r a s n o t s p e c i fi e d , t h e C D A T E - N O
p a r a m e t e rw a s s p e c i f i e c lo, r t h e e n t r y i s f o r a n R - m o d u l e ,t h e r e i s n o o u t p u t f o r
t h i sh e a d i n g .

1'
2.

A c h e c k p o i n t / r e s t a rp
t r o g r a mw i l l h a v e a t t r i h u t e so f f r e x 0 0 4 0 a n d a p r o g r a mw i t h e x t e r n a l b u f f e r s
will have
a t t r i b u t e so f h e x 2 0 4 0 . T h e c h e c k p o i n t , / r e s t a ratn d . _ , x t e r n ablu f f e r s a t t r i L , u t e sa r e m u t u a l l y
exclusive.
A t t r i b u t e b y t e 1 b i t 3 i s t h e l e f t m o s t b i t a l r d a t r r i b u l e b y t e 2 b i r 6 i s t h e r i g h t m o s tb i t o f 2 - b i t
a
binary program
c l a s sn u m b e r .

F i g . $ e 4 - " 1 4i P a r t 3 o f 3 1 . O h j e c t L i b r a r y D i r e c t o r y p r r n r o r r t

4-144

S Y S T E MD I R E C T O R YF R O M F 1 v o L U t ' l EI D F t F l F 1

L I S R A R YA R E A O V E R VEI t , l l
SOURCE
L I B R A R YA L L O C A T E S
DI Z E
O B J E C TD I R E C T O R A
YL L O C A T E S
DI Z E
O B J E C TL I B R A R YA L L O C A T E S
DI Z E
S T A R TO F L I B R A R
I ES
S Y S T E MH i S T O R YA R E A
C H E C K P O I N T , / R E S TAARRETA
S C H E D U L E|R
. l O R KA R E A
E N DO F L I B R A R I E S

--LOCATION-DISK ADDRESS

05/03/76

------SIZE
TRACKS
SECTORS
50
5
300

008-00
0 5 8 -0 0
06 2 - 0 0
0 77 - 0 0
394-23

o o . 0 4 . 1oe
N U M BER - -

OF E N T RI E S

TZUU

1,20
7 200

1,439

!o

S O U R C EL I B R A R Y S E C T I O N
S T A R T O F S O U R C EL I B R A R Y
D i R E C T O R YS P A C E
P E R M A N E N TL I B R A R Y S P A C E
ACTIVE LIBRARY SPACE
AVAILABLE LIBRARY SPACE
E N D O F S O U R C EL I B R A R Y

008-00
t
48
+aJ
ut)-jj

o 5 1- 2 3

2

8
1,),31,
77,31,
ol

O B J E C TL I B R A R YS E C T I O N
S T A R TO F O B J E C TD i R E C T O R Y
A V A I L A B L EP E R M A N E NDTI R E C T O R E
YN T R i E S
A V A I L A B L ET E M P O R A RDYI R E C T O R E
YN T R I E S
E N D O F O B J E C TD I R E C T O R Y
S T A R TO F O B J E C TL I B R A R Y
A V A I L A B L EP E R M A N E NL TI B R A R YS P A C E
U N U S E DS P A C EF R O MD E L E T E DP E R I , 4 A N E N T S
A V A I L A B L ET E M P O R A RL Y
I B R A R YS P A C E
UNUSED
S P A C EF R O MD E L E T E .DT E M P O R A R I E S
A C T I V EL I B R A R YS P A C E
P E R M A N E NOTB J E C TL I B R A R YS P A C E
P E R M A N E NRTO U T I N EL I B R A R YS P A C E
A L L O C A T EE
DN D O F O B J E C TL I B R A R Y
E X T E N D EE
DN D O F O B J E C TL I B R A R Y

095-00
098-7,1-1,47
098-18- 042
o99-23
100- 00
389-20
5YV-

v64
351
5
6

ZZ

JJZq
ifu
98

0
zd)
tz6

56

66 Z5
5469
L5 3 |

394-23
591-

Z 5

S O U R C E - 5D
0 I, R SI Z E - 5r O B J E C T - 3 0 0H,I S T O R Y - 4S, Y S T E M - Y E S

/n
\7

T h e t i m e s p e c i f i e db y H H . M M . S S i s i n c l u d e d i n t h e p r i n t o u t o n l y i f t h e t i m e - o f - d a y f u n c t i o n w a s
s e l e c t e dd u r i n g
system generation,

Figure 4-75, System Directory printout

$MAf NT-Copy Function

4-145

$MAl NT-Delete

Function

USES
a Deletea temporaryor permanententry from a library
( o r e n t r i e sw i t h t h e s a m en a m ef r o m a l l l i b r a r i e s ) .
o Deletetemporaryor permanentlibraryentriesthat have
namesbeginningwith certaincharacters.
o Deleteall temporaryor permanentlibraryentriesof a
certaintype.

CONTROLSTATEMENTSUMMARY
you mustsupplydependon the
The control statements
desiredresults.
All volumesreferenced
by the control statements
must
r e m a i no n l i n ed u r i n gt h e e x e c u t i o no f $ M A l N T .

Delete a Temporary or Permanent Library Entry fur Entris with the SameName from All Libraries)

(; )

(rrr

r

M - c o d e , L t B R A R v)-,

(noo )
R t N T Io
-r r, L, t_r - 1( P
->
I r t t e n a m e)

S p e c i f i ews h e t h e rt h e j o b s t e pi s t o b e o n l y c o p i e d( R E M O V E - N O )c,o p i e da n d
r e m o v e df r o m t h e p r i n t q u e u e( R E M O V E - Y E So) ,r r e m o v e d
w i t h o u t b e i n gc o p i e d
(REMOVE.ONLY).
Specifies
whetherthe output is to be copiedto a file or printed. lf copiedto a file,
the output can be addedto the currentlogicalend of the file ratherthan at the
b e g i n n i n og f t h e f i l e .
S p e c i f i etsh e n a m eo f t h e f i l e t o w h i c ht h e o u t p u t i s c o p i e d .A F I L E s t a t e m e n t
d e f i n i n gt h i s f i l e m u s tb e i n c l u d e di n t h e O C L w h e nt h e s p o o lf i l e c o p y p r o g r a mi s
loaded.

Spool File Copy Program-$OCOPY

4-171

P a g eo f G C 2 1- 5 16 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

Parameter

Description

C O P Y PR T O S t a t e m e n(tc o n t i n u e d )
H E A D E R -1 ! 9 ^ |
I Y E SJ
(Ug
)
STOP-lSTEP
I
I F O R M)

S p e c iife sw h e t h e ra r e c o r dc o n t a i n i n g
i n f o r m a t i o na b o u tt h e j o b s t e pi s t o b e
p l a c e di n t h e o u t p u tf i l e i m m e d i a t e lpy r e c e d i ntgh e s t e p .
Specifieswhethera message
is to be issuedwhich indicatesthe forms type and the
n u m b e r o fp a g e s r e q u i r e d t o p r i n t t h e n e x t j o b s t e
T ph .e m e s s a g e i s i s s u e d b e f o r e
e a c hs t e pi s c o p i e d( S T O P - S T E P
o r) w h e nt h e f o r m st y p e c h a n g e(sS T O PF O R M ) .
N o m e s s a gi e
s i s s u e di f t h e p a r a m e t ei rs S T O p - N O( d e f a u l t ) .

COPYPCHOStatement
UN|T-code

l d e n t i f i e st h e l o c a t i o no f t h e s p o o lf i l e c o n t a i n i n g
t h e p u n c hq u e u et o b e c o p i e d .
P o s s i b lceo d e sa r et h o s ef o r t h e m a i nd a t aa r e a s .l f t h i s p a r a m e t eirs n o t s p e c i f i e d ,
j o b s t e p sa r ec o p i e df r o m t h e p u n c hq u e u eo n t h e a c t i v es p o o lf i l e .

CARDNO-xxx

C o p i e so n l y t h o s ej o b s t e p sw h o s ec a r dt y p e m a t c h e st h e C A R D N Op a r a m e t e r .

J O B N -{ l o O n a m e. .. I
( characters**J

C o p i e so n l y t h o s ej o b s t e p sw h o s ej o b n a m ee i t h e rm a t c h e st h e J O B Np a r a m e t eorr
beginswith the samecharacters
that precedethe **.

S T E p N -l s t e n n a m e . I
(characters**J

C o p i e so n l y t h o s ej o b s t e p sw h o s es t e p n a meei t h e rr h a t c h etsh e S T E P Np a r a m e t eorr
b e g i n sw i t h t h e s a m ec h a r a c t e rtsh a t p r e c e d teh e * * . W h e nS T E P Ni s s p e c i f i e dJ,O B N
must alsobe specified.

( NO )
R E M O V E -( Y E S )
(olrlv)

S p . c i f i e sw h e t h e rt h e j o b s t e pi s t o b e o n l y c o p i e d( R E M O V E - N O c) ,o p i e da n d
r e m o v e df r o m t h e p u n c hq u e u e( R E M O V E - Y E So) ,r r e m o v e dw i t h o u t b e i n gc o p i e d
(REMOVED-oNLy).

(FILE
)
OUTPUT i PUNCH >
f AOO
)

O U T P U T - F I L E s p e c i f i e st h a t t h e o u t p u t i s t o c o n t a i n t h e c o n t r o l i n f o r m a t i o n
( O " a n d R - b y t e s )w h i c h i s u s e d b y s p o o l t o p u n c h t h e r e c o r d . O U T P U T - P U N C H

r=t,L, t=r )- P
( ]U
: -N C H O I >
Itrlename J

S p e c i f i e s t h e n a m etohfe f i l e t o w h i c h t h e o u t p u t i s c o p i e dA.F l L E s t a t e m e n t
d e f i n i n gt h i s f i l e m u s t b e i n c l u d e di n t h e O C L w h e n t h e s p o o l f i l e c o p y p r o g r a m
is loaded.

HEADER-119^l
I YhSJ

S p e c i f i e sw h e t h e r a r e c o r d c o n t a i n i n gi n f o r m a t i o n a b o u t t h e j o b s t e p i s t o b e
p l a c e d i n t h e o u t p u t f i l e i m m e d i a t e l yp r e c e d i n gt h e s t e p .

lNo I

STOP-<
STEP>

I canoI

4-172

tp.cifies that the output is not to contain the control information. The
O U T P U T - A D D p a r a m e t e i " c a u s et hs e s a m eo p e r a t i o n a s t h e O U T p U T - F I L E
parameter,except the output records are added to the current logical end of the
f i l e r a t h e rt h a n a t t h e b e g i n n i n g .

specifies whether a messageis to be issuedwhich indicatesthe card type for the
next job step to be copied. The messagecan be issuedbefore each step is copied
( S T O P - S T E Po
) r w h e n t h e c a r d t y p e c h a n g e s( S T O P - C A R D ) . N o m e s s a g ei s i s s u e d
i f t h e p a r a m e t e ri s S T O P - N O ( d e f a u l t ) .

Pageof GC21-5162-1
lssued28 September1979
ByTNL: GN21-5674

Description

Parametel

COPYRDROStatement
UNIT-code

codes
ldentifiesthe locationof the spoolfile containingthe readerqueue. Possible
arethosefor the main dataareas.lf this parameteris not specified,jobs arecopied
to or from the readerqueueon the activespoolfile.

R E CL - n n n

Specifies
the lengthof the spooledrecordson the readerqueuewhen copyingto
the readerqueue.

IFILE

)I

I N P U T .R

I

(wo)
o-

(eurrrcH)

UN lT-code

Specifiesthat the records copied from the file are to be either placed on the
a p p r o p r i a t es p o o l q u e u e ( O U T P U T - S P O O L )o r c o p i e d t o t h e p r i n t o r p u n c h d e v i c e
( O U T P U T - P RI N T o r O U T P U T - P U N C H ) .
l d e n t i f i e st h e l o c a t i o n o f t h e s p o o l f i l e c o n t a i n i n gt h e p r i n t o r p u n c h q u e u e t o
which the records from the file are to be copied. lf this parameter is not specified,
t h e a c t i v es o o o l f i l e i s a s s u m e d .

COPYOStatement

(wo
o-
(po )

FRoM.{:;..}

r"

{;"rt'}

Specifies the queue from which job steps are to be copied. WO specifies the print
q u e u e , R Q s p e c i f i e st h e r e a d e rq u e u e ,a n d P O s p e c i f i e st h e p u n c h q u e u e '

Specifieseither the main data area that contains the spool file from which the queue
is to be copied (FROM-code), or that the queue is to be copied from the active spool
f i l e ( F R O M - S P ) . T h e F R O M - S Pp a r a m e t e ri s v a l i d o n l y i f s p o o l i s a c t i v e .
Specifieseither the main data area (TO-code) or the active spool file (TO-SP) is to
receivethe copied queue. lf TO-code is specified and a spool file does not exist on
t h i s m a i n d a t a a r e a .t h e s p o o l f i l e c o p y p r o g r a m c r e a t e so n e ( S C Po n l y ) . T h e T O - S P
p a r a m e t e ri s v a l i d o n l y i f s p o o l i s a c t i v e .

J'BN{i"#il:,*..}

Copies only those job steps whose jobname either matches the JOBN parameter or
**.
beginswith the same charactersthat precedethe

tlupnt'nt
srEPN-{
-.}
t cnaracters)

Copies only those job steps whose stepnameeither matches the STEPN parameter
**.
When STEPN is specified,
or begins with the same charactersthat precede the
J O B N m u s t a l s ob e s p e c i f i e d .

REMovE.{}?r}

Specifieswhether the iob step is to be removed from the queue after being copied.

PARlloN.{l }
(e)

copies only those jobs which can be executed in the partition specified on the
P A R T I T I O N p a r a m e t e r . l f t h i s p a r a m e t e ri s s p e c i f i e d ,t h e r e a d e rq u e u e m u s t a l s o
b e s p e c i f i e d( O - R O ) .

Spool File Copy Program-$OCOPY

4-174'1

P a g eo f G C 2 1 - 5 1 6 2 - l
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: cN21-5674

C O P Y OS t a t e m e n(tc o n t i n u e d )
,/1\

\ ,1

P R T Ot rRY . (3 >

/1\

C o p i e so n l y t h o s e j o b s t e p sw h o s e p r i o r i t y m a t c h e st h e p R l O R l T y p a r a m e r e r .

\c./

I F O R M S NI O

) c n R o r u o/ - " ^*

c o p i e so n l y t h o s ej o b s t e p sw h o s ef o r m st y p e m a t c h e st h e F o R M S N o p a r a m e t e r ,
o r c o p i e so n l y t h o s ej o b s t e p sw h o s ec a r dt y p e m a t c h e st h e c A R D N o p a r a m e t e r .
e i t h e ro f t h e s ep a r a m e t e ri s s p e c i f i e dt h
, e c o p y m u s tn o t b e f o r t h e r e a o e q
r ueue.

A U T H O R I Z ES t a t e m e n r

Lrsr 1[g
!
YES
t

'

S p e c i f i e sw h e t h e r a l i s t i n go f a u t h o r i z a t i o nr e c o r d si s t o b e p r i n t e d
on the svstem
p r i n t e r a f t e r a l l c h a n g e st o t h e a u t h o r i z a t i o nf i r e h a v e
b e e nm a d e .

C L A S S I F YS t a t e m e n t
P R O G R A Mp r o g r a m n a m e S p e c i f i e st h e n a m e o f t h e p r o g r a m
t h a t i s b e i n ga s s i g n e da c r a s sn u m b e r .
U Nl T - c o d e

(?I

S p e c i f i e st h e l o c a t i o n o f t h e l i b r a r y c o n t a i n i n gt h e p r o g r a m t o
b e c l a s s i t i e d .p o s s i b l e
c o d e sa r e t h o s e f o r t h e s i m u l a t i o n a r e a s .

CLASS
<. )
(;)

S p e c i f i e st h e c l a s sn u m b e r t o b e a s s i g n e dt o t h e p r o g r a m .

LIBRARY
1 9. I
IRJ

s p e c i f i e sw h e t h e r t h e p r o g r a mt o b e c l a s s i f l e di s i n t h e o o r t h e R l i b r a r v .
lt this
p a r a m e t e rr s n o t s p e c i f i e d ,t h e O l i b r a r y i s a s s u m e d .

PACK-packname

s p e c i f i e st h e n a m e o f t h e s i m u l a t i o n a r e ai n d i c a t e db y t h e U N l r p a r a m e t e r .
lf this
p a r a m e t e ri s n o t s p e c i f i e d ,t h e d e s i r e dp a c k i s a s s u m e dt o
be on the unit specified.

4-174.2

This pageintentionallyleft blank

Spool File Gopy Program-$OCOPY

4-175

P a g eo f G C 2 t - 5 1 6 2 - l
lssued 28 September lgTg
By TNL: cN2t-5674

PARAMETER DESCRIPTIONS_COPYSP
FROM and TO parameters
FROM specifiesthe device from which the spool
file is
copied. The TAPE (FROM-TAPE)parameter.
the Sp
( F R O M - S P )p a r a m e t e r ,o r o n e o f
the following main data
a r e ac o d e sc a n b e s p e c i f i e d : D 1 , D 2 , D 3 . D 3 l ,
D32, D33,
D34, D4, D41 , D42, D43. or D44. The tape
unit must be
s p e c i f i e db y a n O C L F I L E s t a t e m e n tw i t h
the filename
$SPOOL. The copy from tape function can be
used only
for a tape that was previously created by
the COpySp
function of the spool file copy program.
TO specifiesthe device to which the spool file
is copied.
E i t h e r T A P E ( T O - T A P E )o r t h e f o l l o w i n g m a i n
dataarea
c o d e sc a n b e s p e c i fi e d : D 1 , D 2 , D 3 , D 3 1 D 3 2 ,
D33, D34,
,
D 4 , D 4 1, D 4 2 , D 4 3 , o r D 4 4 . T h e t a p e u n i t
must be speci_
f i e d b y a n O C L F I L E s t a t e m e n tw i t h t h e f i l e n a m e
$SPOOL. The spool file program does not supporr a tape_
t o - t a p e( F R O M - T A p E , T O - T A P E ) o p e r a t i o n .
F R O M - S Pc a u s e st h e a c t i v es p o o l f i l e t o b e
copiedand is
I
v
I alidonly when the spool is active.

P A R A M E T E R D E S C RI P T I O N S _ C O P Y P R T O
UNIT Parameter
T h i s o p t i o n a l p a r a m e t e ri d e n t i f i e st h e m a i n d a t a

area
c o n t a i n i n gt h e s p o o l f i l e f r o m w h i c h t h e p r i n t q u e u e
rs
copied. One of the following main data area codes
can be
specified: D1, D2, D3, D31, D32. D33, D34, D4,
D 4 1,
D 4 2 , D 4 3 , o r D 4 4 . l f t h i s p a r a m e t e ri s n o t s p e c i f i e d ,j o b
stepsare copied from the print queue on the active
spool
f ile.

STEPNParameter
This optionalparameterspecifies
that only thosejob steps
whosestepnamematchesthat suppliedin the STEpN
p a r a m e t earr et o b e c o p i e d .C o p y i n gm u l t i p l ej o b s t e p s ,
whosestepnames
beginwith the samecharacters,
requires
the specificationof thosecharacters
followedby **. From
1 through7 characters
can precedethe **. Whentne
S T E P Np a r a m e t ei rs i n c l u d e dt.h e J O B Np a r a m e t em
r ust
a l s ob e i n c l u d e d .

LENGTH Parameter
T h i s o p t i o n a l p a r a m e t e rs p e c i fi e s t h a t t h e d a t a p l a c e d i n
t h e f i l e b e e x p a n d e dt o 1 3 4 b y t e s ( L E N G T H - F L R ) o r
r e m a i nc o m p r e s s e da s i t e x i s t so n t h e s p o o l f i l e a n d p l a c e d
c o n t i g u o u s l yi n 1 3 4 - b y t e r e c o r d si n t h e o u t p u t f i l e
( L E N G T H - V L R ) . l f t h i s p a r a m e t e irs n o t
i n c l u d e d ,F L R
isassumed.

REMOVE Parameter
T h i s o p t i o n a l p a r a m e t e rs p e c i fi e st h e f o l l o w i n g : t h e j o b
step is to be removed f rom the print queue when the copy
o p e r a t i o ni s c o m p l e t e ( R E M O V E y E S ) , t t r e j o b s t e p i s t o
be removed f rom the print gueue without being copied
( R E M O V E - O N L Y ) , o r t h e s t a t u so f t h e j o b
stepis to re_
m a i n u n c h a n g e do n t h e p r i n t q u e u e a f t e r b e i n g c o p i e d
( R E M O V E - N O ) . F o r j o b s t e p sw i t h m u l t i p l e
c o p i e sa n d
R E M O V E - Y E S s p e c i f i e d ,t h e n u m b e r o f c o p i e si s r e d u c e d
by one after the copy is complete and the job step remains
o n t h e p r i n t q u e u e . l f R E M O V E - O N L y i s s p e c i f i e d ,t h e
jobstepswill be removed regardlessof the
number of
c o p i e s . l f t h i s p a r a m e t e ri s n o t i n c l u d e d ,N O i s a s s u m e d .

OUTPUT Parameter
FORMSNO Parameter
This optional parameter specifies that only those job
steps
w h o s ef o r m s t y p e m a t c h e st h a t s u p p l i e di n t h e F O R M S N O
parameter are to be copied.

JOBN Parameter
This optional parameter specifiesthat only those job
steps
whose jobname matches that supplied in the
JOBN parameter are to be copied. Copying multiple jobs, whose
jobnames begin with the same
characters,requiresthe
specification of those charactersfollowed by **.
From
1 through 7 characterscan precedethe **.

4-176

This optional parameter specifiesthat the copy of the
p r i n t q u e u e e i t h e r b e d i r e c t e dt o t h e f i l e i d e n t i f i e d
by the
F I L E p a r a m e t e ro r b e p r i n t e d . l f d i r e c t e dt o t h e f i l e . t h e
c o n t r o l i n f o r m a t i o n ( O - a n d R - b y t e s )i s i n c l u d e d . l f
O U T P U T - P RI N T i s s p e c i fi e d , t h e f o r m a t o f t h e p r i n t e d
o u t p u t i s t h e s a m ea s i f t h e j o b h a d n o t b e e n s p o o l e d .
W h e n O U T P U T - P RI N T i s s p e c i fi e d , L E N G T H _ V L R i s
i n v a l i d . l f t h e p r o g r a m i s e x e c u t i n gu n d e r C C p ,
O U T P U T - P RI N T c a n n o t b e s p e c i fi e d . T h e O U T p U T _ A D D
parameter specifies that the output operation is to
be the
s a m ea s f o r O U T P U T - F I L E e x c e p t t h a t i f t h e o u t p u t f i l e
i s a d i s k f i l e , t h e r e c o r d sa r e a d d e d t o t h e c u r r e n t l o q i c a l
end of the f ile.

P a g eo f G C 2 1 ' 5 1 6 2 - 1
lssued 28 SePtember 1979
By TNL: GN21-5674

FILE Parameter

CARDNOParameter

T h i so p t i o n a p
l a r a m e t earl l o w sy o u t o s p e c i f yt h e n a m eo f
the file to which job stepson the print queueareto be
c o p i e d .W h e nt h e s p o o lf i l e p r o g r a mi s l o a d e dy, o u m u s t
i n c l u d ea n O C L F I L E s t a t e m e ntth a t d e f i n e st h i s f i l e .

that only thosejob steps
This optionalparameterspecifies
w h o s ec a r dt y p e m a t c h e tsh a t s u p p l i e di n t h e C A R D N O
parameter
areto be copied.

l f t h e F I L E p a r a m e t ei rs n o t s u p p l i e dt ,h e f i l e n a m e
P R I N T Oi s u s e db y t h e s p o o lf i l e c o p y p r o g r a m .l f e i t h e r
i s s p e c i f i e tdh e
O U T P U T - P R I N oTr R E M O V E - O N L Y
p
a
r
a
m
e
t
e
r
FILE
i s i g n o r e da n dt h e f i l e i s n o t u s e d .

JOBNParameter

HEADER Parameter
T h i s o p t i o n a l p a r a m e t e rs p e c i if e s w h e t h e r o r n o t a r e c o r d ,
which contains information about the job step to be
c o p i e d ,s h o u l d b e i n c l u d e di m m e d i a t e l yp r e c e d i n gt h e j o b
s t e p . l f H E A D E R - Y E S i s s p e c i fi e d , t h e r e c o r d i s i n c l u d e d ;
i f H E A D E R - N O i s s p e c i fi e d o r a s s u m e dt.h e r e c o r d i s n o t
c o p i e d . l f O U T P U T - P R I N T i s s p e c i f i e d ,t h e H E A D E R - Y E S
parameter does not have any effect.

STOP Parameter
This optional parameter specifies whether a messageis to
be issuedthat indicatesthe forms type and the number of
pagesfor the job step to be copied. The messagecan be
issuedbefore each step is copied (STOP-STEP)or before a
c h a n g ei n f o r m s t y p e ( S T O P - F O R M ) . T h e m e s s a g ei s n o t
i s s u e di f S T O P - N O i s s p e c i fi e d o r a s s u m e d . I n a d d i t i o n t o
the STOP-STEPor STOP-FORM parameter,the messageis
i s s u e do n l y i f O U T P U T - P R I N T i s s p e c i f i e da n d t h e s p o o l
f i l e c o p y p r o g r a m i s e x e c u t i n gi n a n o n s p o o l e dp a r t i t i o n .

P A R A M E T E R D E S C RI P T I O N S _ C O P Y P C H O
UNIT Parameter
T h i s o p t i o n a l p a r a m e t e ri d e n t i f i e st h e l o c a t i o n o f t h e s p o o l
f i l e c o n t a i n i n gt h e p u n c h q u e u e t o b e c o p i e d . O n e o f t h e
f o l l o w i n g m a i n d a t a a r e ac o d e sc a n b e s p e c i f i e d : D 1 , D 2 ,
D3, D31, D32, D33, D34,D4,D41,D42, D43,or D44. tt
this parameter is not specified,iob steps are copied from
t h e p u n c h q u e u e o n t h e a c t i v es p o o l f i l e .

that only thoseiob steps
This optionalparameterspecifies
whosejobnamematchesthat suppliedin the JOBN param'
eterareto be copied. Copyingmultiplejobs.whose
jobnamesbeginwith the samecharacters,
requiresthe
**. From
followedby
specification
of thosecharacters
**.
1 through7 characters
can precedethe

STEPNParameter
that only thosejob steps
This optionalparameterspecifies
whosestepnamematchesthat suppliedin the STEPN
parameterareto be copied. Copyingmultipleiob steps,
requires
beginwith the samecharacters,
whosestepnames
**. From
followedby
the specification
of thosecharacters
**.
Whenthe
can precedethe
1 through7 characters
S T E P Np a r a m e t ei rs i n c l u d e dt,h e J O B Np a r a m e t emr u s t
a l s ob e i n c l u d e d .

REMOVEParameter
the following: the job
This optionalparameterspecifies
stepis to be removedfrom the punchqueuewhen the
c o p y o p e r a t i o ni s c o m p l e t e( R E M O V E - Y E St)h, e j o b s t e p
is to be removedfrom the punch queuewithout being
c o p i e d( R E M O V E - O N L Y )o,r t h e s t a t u so f t h e j o b s t e p
on the punchqueueafter being
is to remainunchanged
(
R
E
M
O
V
E
N
O
)F
. o r . j o bs t e p sw i t h m u l t i p l e
copied
s p e c i f i e dt h
. e n u m b e ro f c o p i e s
c o p i e sa n d R E M O V E - Y E S
is reducedbv one afterthe copy is completeand the job
step remainson the punchqueue. lf this parameteris not
i n c l u d e dN
. O isassumed.

Spool File Copy Program-$OCOPY

4'177

Page
of GC21-5162-1
lssued
28 September
1979
By TNL: cN21-5674
OUTPUTParameter
This optionalparameterspecifiesthat the copy output
of
t h e p u n c hq u e u ee i t h e ri s t o c o n t a i n( O U T P U T _ F I L Eo)r
is
n o t t o c o n t a i n( O U T p U T - p U N C Ht h) e c o n t r o li n f o r m a t i o n
(O'and R-bytes)usedby spootto punch
the records.The
OUTPUT-ADDparameterspecifies
that the output operat i o n i s t o b e t h e s a m ea sf o r O U T p U T _ F I L E
excepthat if
the output file is a disk file, the recordsareadded
to the
currentlogicalend of the file. lf this parameteris
not
i n c l u d e dF, I L E i s a s s u m e d .

FILE Parameter
This optionalparameterallowsyou to specifythe name
of
the file to which the job stepson the punchqueueare
copied. Whenthe spoolfile copy programis loaded,you
m u s ti n c l u d ea n O C L F I L E s t a t e m e ntth a t d e f i n e st h i sf i l e .
l f t h e F I L E p a r a m e t ei rs n o t s u p p l i e dt ,h e f i l e n a m e
PUNCHOis usedby the spoolfile copy program. lf
RE M O V E - O N
L Y i s s p e c i f i e dt h, e F I L E p a r a m e t ei rs
ignoredand the file is not used.

HEADER Parameter
This optional parameter specifieswhether or not a
header
record, which contains information about the job
step is to
be copied, is to be included immediately preceding
the job
s t e p . l f H E A D E R - Y E S i s s p e c i f i e d t, h e h e a d e rr e c o r d
is inc l u d e d ; i f H E A D E R - N O i s s p e c i f i e do r a s s u m e dt,h e h e a d e r
record is not copied. lf OUTPUT-PUNCH is specified,
the
HEADER-YES parameter does not have anv effect.

P A R A M E T E R D E S C RI P T I O N S - C O P Y R D R O
UNIT Parameter
This optional parameter specifiesthe location of the
spool
file that contains the reader queue to or from which jobs
a r e t o b e c o p i e d . P o s s i b l ec o d e sa r e D 1 D 2 , D 3 , D 3 l ,
,
D32,
D33, D34, D4, D41, D42, D43, and D44. tf thrsparameter
is not specified,jobs are copied to or from the reader
queue on the active spool file.

RECL Parameter
When you are copying to the spool reader queue, this
optional parameter specifiesthe length of records on the
spool reader queue. This parameter is required if the copy
is to a spool file on a system that does not have either spool
active or spool reader support. lf the spool reader records
are to be used in conjunction with an g0_columnspool
r e a d e rd e v i c e ,t h e n R E C L - 8 0 m u s t b e s p e c i f i e d . S i m i l a r l y ,
a 96-column spool reader device requiresthat RECL_g6 be
specified.
T h i s p a r a m e t e ri s o p t i o n a l w h e n c o p y i n g t o a s p o o l f i l e o n
a
system with spool active and the spool reader supported.
A
default record length is assumedbasedon the spool reader
device. For more information about the spool reader
queue record length, refer to the Spool File Considerations
and Restrictions (COpy R D R A ).
l f t h i s p a r a m e t e ri s s p e c i f i e d .t h e O U T p U T , J O B N ,
P A R T I T I O N , a n d R E M O V E p a r a m e t e r sc a n n o t b e s p e c i f i e d .

INPUT Parameter
STOP Parameter
This optional parameter specifieswhether a messageis
to be
issuedthat indicatesthe card type for the job step to be
copied. The messagecan be issuedbefore each step is
copied (STOP-STEP)or before a change in card rype
( S T O P - C A R D ) . T h e m e s s a g ei s n o t i s s u e d
if STOp-NOis
specifiedor assumed. In addition to the STOp_STEpor
the
STOP-CARD parameter,the messagecan be issuedonly if
a l l o f t h e f o l l o w i n g c o n d i t i o n se x i s t : O U T p U T - p U N C H i s
specified,the spool file copy program is executing in a
nonspooled partition, and the punch queue records being
copied are for the same device as the output file (punch)
device.

This optional parameter identif ies the source of the records
c o p i e d t o t h e r e a d e rq u e u e . l f I N p U T - F I L E i s s p e c i f i e d ,
t h e r e c o r d sc o n t a i n e d i n t h e R E A D E R O f i l e o r t h e f i l e
specified by the FILE parameter are copied to the spool
r e a d e rq u e u e . l f I N P U T - R E A D E R i s s p e c i f i e d ,r e c o r d sr e a d
from the system input device are copied to the spool
readerqueue. (The spool file copy program must be exec u t i n g u n d e r c o n t r o l o f S C Pw h e n I N p U T - R E A D E R i s
s p e c i f i e d . ) l f I N P U T - T E R M I N A L i s s p e c i f i e d ,r e c o r o ss e n t
from the terminal that made the program requestare copied
to the spool reader queue. (The spool file copy program
m u s t b e e x e c u t i n gu n d e r c o n t r o l o f C C p w h e n I N p U T _
T E R M I N A L i s s p e c i f i e d . ) l f t h i s p a r a m e t e ri s n o t i n c l u d e d .
F I L E i s a s s u m e d . l f t h i s p a r a m e t e ri s s p e c i fi e d . t h e
OUTPUT, JOBN, PARTITION, and REMOVE parameters
cannot be specified.

4-178

P a g eo f G C 2 1 ' 5 1 6 2 ' 1
lssued 28 SePtember 1979
BYTNL: GN21-5674

FILE Parameter

LOKEY Parameter

eitherthe nameof the
This optionalparameterspecifies
file from which iobsarecopiedto the spoolreaderqueueor
the nameof the file to which jobs arecopiedfrom the
spoolreaderqueue. A F ILE statementthat definesthis
f i l e m u s tb e i n c l u d e di n t h e O C L w h e nt h e s p o o lf i l e c o p y
programis loaded.

T h i s o p t i o n a l p a r a m e t e ri s o n l y f o r c o p y i n g t o t h e s p o o l
readerqueue from an indexed file. The charactersincluded
on this parameter determine the f irst record to be copied
from the file. Only those recordsthat have a key equal to
or greaterthan the characterson this parameter are copied.
A m i n i m u m o f 1 c h a r a c t e ra n d a m a x i m u m o f 2 9 c h a r a c t e r s
c a n b e i n c l u d e do n t h i s p a r a m e t e r .

lf this parameteris not included,the spoolfile copy prog r a mu s e st h e d e f a u l tn a m eR E A D E R O .
lf INPUT-READER
I N, P U T - T E R M I N AoLr, R E M O V E ,e
O N L Y w i t h t h e O U T P U Tp a r a m e t ei rs s p e c i f i e dt h
F I L E p a r a m e t ei sr i g n o r e da n d t h e f i l e i s n o t u s e d .

KEY Parameter
This optional parameter is only for copying to the spool
r e a d e rq u e u e f r o m a n i n d e x e df i l e . A m i n i m u m o f 1
character and a maximum of 29 characterscan be included
on this parameter. These charactersare compared,
character by character,starting with the leftmost character in the key. The compare operation ends when the last
character is detected either in the key or on the parameter
( w h i c h e v e ri s f i r s t ) . T h e r e c o r d i s n o t c o p i e d u n l e s sa n
e q u a lc o n d i t i o n e x i s t s .
l f a c o m m a , h y p h e n , b l a n k , o r a n a p o s t r o p h e( s i n g l eq u o t e )
is included in the specified characters,the character string
must be enclosedby apostrophes. An apostrophe can be
i n c l u d e di n t h e c h a r a c t e rs t r i n g o n l y i f i t i s s p e c i fi e d i n t w o
consecutivepositions.
l f t h e K E Y p a r a m e t e ri s s p e c i f i e d ,t h e L O K E Y , H I K E Y ,
L O R E C . H I R E C ,O U T P U T ,J O B N , P A R T I T I O N , A N d
REMOVE parameterscannot be specified.

l f a c o m m a , h y p h e n , b l a n k , o r a n a p o s t r o p h e( s i n g l eq u o t e )
is included in the specified characters,the character string
must be enclosed by apostrophes. An apostrophe can be
included in the character string only if it is specified in two
consecutivepositions.
lf the charactersspecified on this parameter are not the
same length as the keys for the file records,the characters
specified are truncated or padded on the right with blanks
(hex 40) as needed to match the key length.
l f t h i s p a r a m e t e ri s s p e c i f i e d ,t h e K E Y , L O R E C , H I R E C ,
OUTPUT, JOBN, PARTITION, and REMOVE parameters
cannot be specified.
l f t h i s p a r a m e t e ri s n o t s p e c i f i e da n d t h e H I K E Y p a r a m e t e r
i s s p e c i f i e d ,t h e l o w k e y d e f a u l t v a l u e i s b l a n k s ( h e x 4 0 ) .

HIKEY Parameter
This optional parameter is only for copying to the spool
readerqueue from an indexed f ile. This parameter specifies
the highest key for which a record can be copied. Only
those records are copied with a key equal to or lessthan the
character(s)on this parameter.
l f t h i s p a r a m e t e ri s s p e c i f i e d ,t h e K E Y , L O R E C , H I R E C .
OUTPUT, JOBN, PARTITION, and REMOVE parameters
cannot be sPecified.
l f t h i s p a r a m e t e ri s n o t s p e c i fi e d a n d L O K E Y i s s p e c i f i e d ,
t h e d e f a u l t v a l u e f o r t h i s p a r a m e t e ri s a l l n i n e s ( h e x F 9 ) .
A m i n i m u m o f 1 c h a r a c t e ra n d a m a x i m u m o f 2 9 c h a r a c t e r s
c a n b e i n c l u d e do n t h i s P a r a m e t e r .
l f a c o m m a , h y p h e n , b l a n k , o r a n a p o s t r o p h e( s i n g l eq u o t e )
is included in the specified characters.the character string
must be enclosed by apostrophes. An apostrophe can be
i n c l u d e di n t h e c h a r a c t e rs t r i n g o n l y i f i t i s s p e c i f i e di n t w o
consecutivepositions.

Spoof File Copy Program-$OCOPY

4'179

Pageof GC21-5162-1
lssued28 September
1979
ByTNL: GN21-5674
lf the charactersspecified on this parameter are not
the
same length as the keys for the file records,the
characters
specified are truncated or padded on the right with
nines
(hex F9) as needed to match the
key length.

LOREC Parameter
W h e n c o p y i n g t o t h e s p o o l r e a d e rq u e u e f r o m f i l e ,
a
this
optional parameter specifiesthe relative record
numoer
from which the copy operation is to begin.
Relatrverecord
numbers identify a record's location with respect
to other
records in the file. The relative record number
of the first
record is 1, the number of the second record is
2, and so on.
A p o s i t i v ed e c i m a l n u m b e r t h a t c o n s i s t so f a m i n i m u m
of 1
d i g i t a n d a m a x i m u m o f 1 5 d i g i t sc a n b e s p e c i f i e d .
l f t h i s p a r a m e t e ri s s p e c i f i e d ,t h e K E y , L O K E y , H l K E y ,
OUTPUT, JOBN, PARTtTtON, and REMOVE parameters
cannot be specified.
l f t h i s p a r a m e t e ri s n o t s p e c i fi e d a n d t h e H I R E C p a r a m e t e r
is specified,the relative record number default is .l
.

HIREC Parameter
W h e n c o p y i n g t o t h e s p o o l r e a d e rq u e u e f r o m a f i l e ,
this
optional parameter specifies the relative record number
which ends the copy operation (this record is copied).
Relative record numbers identify a record's locatton with
respectto other records in the file. The relative
record
number of the first record is 1, the number of the secono
record is 2, and so on. A positive decimal number
that
c o n s i s t so f a m i n i m u m o f 1 d i g i t a n d a m a x i m u m o f
1S
digits can be specified.
l f t h i s p a r a m e t e ri s s p e c i f i e d ,t h e K E y , L O K E y , H l K E y ,
OUTPUT, JOBN, PARTITION, and REMOVE parameters
cannot be specified.
lf this parameter is not specified and the LOREC parameter
is specified, the relative record number default is the
h i g h e s tr e c o r d n u m b e r i n t h e f i l e .

4-180

OUTPUTParametel
This optionalparametercauses
jobs to be copiedf rom the
s p o o lr e a d eqr u e u et o a f i l e ( O U T p U T - F I L E ) .l f
O U T P U T - A D Di s s p e c iife da n dt h e o u t p u t f i l e i s a d i s kf i l e ,
the spoolreaderqueuerecordsareaddedto the current
l o g i c ael n d o f t h e f i l e , r a t h e rt h a na t t h e b e g i n n i n g l.f t h e
O U T P U Tp a r a m e t ei rs n o t s p e c i f i e dt h
, e d e f a u l to p e r a t i o n
will copy recordsfrom a file to the spoolreaderqueue. lf
t h i sp a r a m e t ei rs s p e c i f i e dt h
, e l N P U T ,R E C L ,K E y ,
L O K E Y ,H I K E Y ,L O R E C a, n dH I R E Cp a r a m e t ecr a
s nnot
be specified.

JOBN Parameter
W h e nc o p y i n gf r o m t h e s p o o lr e a d egr u e u et o a f i l e ,t h i s
optionalparameterspecifiesthat only thosejobs whose
jobnamematchesthe JOBN parameterareto
be copied.
C o p y i n gm u l t i p l ej o b s ,w h o s ej o b n a m e b
s e g i nw i t h t h e
samecharacters,
requiresthe specificationof thosecharacters followedby **. From I through7 characters
can
precedethe **. lf this parameteris specified,the OUTpUT
p a r a m e t em
r u s ta l s ob e s p e c i f i e dt h
; e l N P U T ,R E C L ,K E y ,
L O K E Y ,H I K E Y ,L O R E C a, n dH I R E Cp a r a m e t ecr a
snnot
be specified.

PARTITIONParameter
Whencopyingfrom the spoolreaderqueueto a file, this
optionalparameterspecifies
that only thosejobswhich can
b e e x e c u t e di n t h e p a r t i t i o ns p e c iife do n t h e p A R T I T I O N
p a r a m e t earr et o b e c o p i e d . l f t h i sp a r a m e t eirs s p e c i f i e d ,
t h e O U T P U Tp a r a m e t em
r u s ta l s ob e s p e c i f i e dt h
; e lNpUT,
R E C L ,K E Y , L O K E Y ,H l K E y , L O R E Ca, n d H T R E C
param_
eterscannotbe specified.

REMOVEParameter
W h e n c o p y i n g f r o m t h e s p o o l r e a d e rq u e u e t o a f i l e . t h i s
optional parameter specifies that: the job is to be removed
from the reader gueue when the copy operation is com_
p l e t e ( R E M O V E - Y E S ) ,t h e j o b i s t o b e r e m o v e df r o m
the
r e a d e rq u e u e w i t h o u t b e i n gc o p i e d ( R E M O V E - O N L y ) , o r
the status of the job is to remain unchangedon the reader
q u e u e a f t e r b e i n gc o p i e d ( R E M O V E - N O ) . l f t h l s
Daram_
e t e r i s n o t s p e c i f i e d ,R E M O V E - N O i s a s s u m e d . l f t h i s
p a r a m e t e ri s s p e c i fi e d , t h e O U T p U T p a r a m e t e r
must alsobe
s p e c i f i e dt;h e I N P U T , R E C L , K E y , L O K E y , H l K E y .
L O R E C , a n d H I R E C p a r a m e t e r sc a n n o t b e s p e c i f i e d .

PARAMETER DESCRIPTIONS-COPYCTR
L

FILE Parameter

FILE Parameter

This optionalparameterallowsyou to specifythe nameof
t h e f i l e t o w h i c ht h e d i s p l a yo u t p u t i s c o p i e d . l f t h e c o p y
o u t p u ti s t o a f i l e ( O U T P U T - IFL E ) a n dt h i s p a r a m e t eirs
n o t i n c l u d e dt,h e f i l e n a m eD I S P L A Y Oi s a s s u m e d .

This optionalparameterallowsyou to specifythe nameof
the file that containsthe control statements.The default
n a m eC O N T R O Li s u s e di f t h i s p a r a m e t ei rs n o t i n c l u d e d .
A F I L E s t a t e m e ndt e f i n i n gt h i sf i l e m u s tb e i n c l u d e di n t h e
OCL statements
when CCPis started.

l f t h e d i s p l a yo u t p u t i s c o p i e dt o a f i l e , a F I L E s t a t e m e n t
d e fi n i n gt h i s f i l e m u s tb e i n c l u d e di n t h e O C L s t a t e m e n t s
whenthe spoolfile copy programis loaded.

P A R A M E T ER D E S C RI P T I O N S _ D I S P L A Y

l f O U T P U T - T E R M I N AiLs s p e c i f i e dt h
, e FILE parameter
isignored.

UNIT Parameter
Q Parameter
This optionalparameterspecifiesthe locationof the spool
f i l e t o b e d i s p l a y e dP
. o s s i b lceo d e sa r e : D 1, D 2 , D 3 , D 3 1 ,
D 3 2 ,D 3 3 , D 3 4 , D 4 , D 4 1 , D 4 2 ,D 4 3 ,a n d D 4 4 . l f t h i s
parameteris not specified,the statusof the activespool
fileisdisplayed.

OUTPUTParameter
T h i sp a r a m e t ei rs o p t i o n a l . l f O U T P U T - F
I L E i s s p e c i fe d ,
the copy output is directedto the file identifiedin the
F I L E p a r a m e t eorr t o t h e f i l e n a m e dD I S P L A Y O .

T h i so p t i o n a lp a r a m e t esrp e c i f i ews h i c hq u e u ei s t o b e d i s p l a y e d .l f O - R Oi s s p e c iife d ,t h e r e a d e q
r u e u ei s d i s p l a y e d .
l f O - W Oi s s p e c i f i e dt ,h e p r i n t q u e u ei s d i s p l a y e d l.f O - P O
i ss p e c iife d ,t h e p u n c hq u e u ei s d i s p l a y e d .
l f O U T P U T - F I L Ei s s p e c i f i e a
d n d t h i s p a r a m e t ei rs n o t
included,all queuesarecopied. The statusof the readeris
copiedfirst, followed by the print queue,then the punch
queue.
d n d t h i s p a r a m e t ei rs
l f O U T P U T - T E R M I N A iLs s p e c i f i e a
n o t i n c l u d e dt,h e p r i n t q u e u ei s d i s p l a y e d .

The OUTPUT-ADDparameterspecifies
that the output
o p e r a t i o ni s t o b e t h e s a m ea sf o r O U T P U T - F
ILE except
that if the output file is a disk file, the recordsareaddedto
t h e c u r r e n tl o g i c ael n do f t h e f i l e .
lf the spoolf ile copy programis executingunderCCPand
O U T P U T - T E R M I N AiLs s p e c i f i e dt h
, e c o p yo u t p u t i s
directedto the CCPterminalthat madethe programrequest
l f t h i s p a r a m e t ei rs n o t i n c l u d e dO
, U T P U T - F I L Ei s a s s u m e d
when the programis executingunderSCP,and OUTPUTT E R M I N A L i s a s s u m ew
d h e nt h e p r o g r a mi s e x e c u t i n g
u n d e rC C Pa n d h a sa t e r m i n a l .T h e O U T P U T - T E B M I N A L
parameteris not valid when the spoolfile copy programis
executing
u n d e rS C Po r u n d e rC C Pa n dd o e sn o t h a v ea
t e r mi n a l .

Spool File Copy Program-$OCOPY

4-181

P a g eo f G C 2 1 - 5 1 6 2 - l
lssued 28 Seprember 197g
By TNL: cN21-5674

P A R A M E T ER D E S C RI P T I O N S _ R
E S T O RE
FILE Parameter
This optionalparameterspecifiesthe nameof the f ile
that
containsthe print or punchqueuerecordsto be copied.
lf
this parameteris not included,RESTOREis assumed
to be
t h e n a m eo f t h e f i l e . A F I L E s t a t e m e ntth a t d e f i n e s
this
f i l e a sb e i n ge i t h e ra d i s kf i l e o r a t a p ef i l e m u s t
be included
in the OCL statements
when the spoolf ile copy programis
loaded.

JOBN Parameter
This optionalparameterspecifies
that the print or punch
queuerecordsareto be copiedfor only thosejob
steps
whosejobnamematchesthe namesuppliedon the JOBN
parameter.Copyingmultiplejobs,whosejobnames
begin
with the samecharacters,
requiresthe specification
of
thosecharacters
followedby **. From 1 through7 char_
acterscan precedethe **. Whenthis parameteris specified,
a job step in the file must havea headerrecordin orderto
be copied.

STEPNParameter
This optionalparameterspecifies
that the print or punch
queuerecordsareto be copiedfor only thosejob
steps
whosestepnamematchesthe namesuppliedon the STEpN
parameter.Copyingmultiplejob steps,whose
srepnames
beginwith the samecharacters,
requiresthe specification
of thosecharacters
followedby **. From I through7
characters
can precedethe **. lf the STEPNparameter
is included,the JOBN parametermust alsobe included.
Whenthis parameteris specified,a job stepin the file must
havea headerrecordin orderto be copied.

FORMSNO Parameter
T h i s o p t i o n a l p a r a m e t e rs p e c i f i e st h a t t h e p r i n t q u e u e
records are to be copied for only those job steps whose
forms type matches this parameter.
When this parameter is specified,a job step in the file must
have a header record in order to be copied.
T h e F O R M S N O p a r a m e t e ra n d t h e C A R D N O p a r a m e t e r
aremutually exclusive.

4-182

CARDNO Parameter
This optionalparameterspecifies
that the punchqueue
recordsare to be copied for only thosejob stepswhosecard
type matchesthis parameter.
Whenthis parameteris specified,a job stepin the file must
havea headerrecordin order to be copied.
The CARDNO parameterand the FORMSNOparamerer
a r em u t u a l l ye x c l u s i v e .

STOPParameter
This optionalparameterspecifies
whethera message
should
be issuedfor the job stepto be copied. The message
indicatesthe forms type and the numberof pagesfor the print
recordsor the card type for the punchrecords.lf STOP_
STEPis specified,the message
is issuedbeforeeachstep is
copied. lf STOP-FORMor STOp-CARDis specified,the
message
is issuedbefore eachstep is copied in which the
formstype or the card tlpe is differentthan in the preceding step. lf STOP-NOis specifiedor assumed,
the message
is not issued.In addition,the message
can only be issued
if the spoolfile copy programis executingin a nonspooled
partition,the job stepto be copiedhasa headerrecord,
and the job stepis beingcopiedto the print or punch
device.

OUTPUT Parameter
This optionalparameterspecifies
whetherthe print or
punchrecordscopiedfrom the file areto be placedon the
spoolprint or spoolpunchqueue(OUTPUT-SPOOL)
or to
be printedor punchedon the devicefor which they were
originallyinterceptedby spool (OUTPUT-PRlNTor
OUTPUT-PUNCH).lf this parameteris not specified,
OUTPUT-SPOOL
is assumed.ln orderto be copiedfrom
the file to the spoolqueue,a job stepmust havea header
record.

UNIT Parameter
This optionalparameterspecifiesthe locationof the spool
file that containsthe print or punchqueueto which the
recordsareto be copiedfrom the file. possiblecodesare
D l , D 2 , D 3 , D 3 1 ,D 3 2 ,D 3 3 ,D 3 4 , D 4 , D 4 1 , D 4 2D
, 4 3 .a n d
D44. lt this parameteris not specified,the print or punch
gueueon the activespoolfile is assumed.

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
Bv TNL: GN21-5674

P A R A M E T E R D E S C RI P T I O N S _ C O P Y O

REMOVE Parameter

O Parameter

T h i s o p t i o n a l p a r a m e t e rs p e c i fi e s t h a t e i t h e r t h e c o p i e d j o b
s t e p b e r e m o v e df r o m t h e q u e u e ( R E M O V E - Y E S ) o r t h e
s t a t u so f t h e j o b s t e p r e m a i n u n c h a n g e do n t h e q u e u e
( R E M O V E N O ) . F o r j o b s t e p sw i t h m u l t i p l ec o p i e sa n d
R E M O V E - Y E S s p e c i fi e d , t h e n u m b e r o f c o p i e si s r e d u c e d
by one after the copy is complete;thejob stepremains

This parameter specifiesthe spool queue for which iob
s t e p sa r e t o b e c o p i e d . l f O W Q i s s p e c i f i e d t, h e p r i n t q u e u e
j o b s t e p sa r e c o p i e d . l f O - R O i s s p e c i f i e d ,t h e r e a d e rq u e u e
j o b s a r e c o p i e d . l f O - P O i s s p e c i fi e d , p u n c h q u e u e j o b s t e p s
arecopied.

o n t h e q u e u e . l f t h i s p a r a m e t e ri s n o t i n c l u d e d ,
R E M O V E - N Oi s a s s u m e q .

FROM Parameter
PARTITION Parameter
T h i s p a r a m e t e rs p e c i fi e s t h e l o c a t i o n o f t h e m a i n d a t a a r e a
t h a t c o n t a i n st h e s p o o l f i l e f r o m w h i c h t h e q u e u e i s t o b e
c o p i e d . E i t h e r S P ( F R O M - S P )o r o n e o f t h e f o l l o w i n g
m a i n d a t a a r e ac o d e s m u s t b e s p e c i fi e d : D 1 , D 2 , D 3 , D 3 1 ,
D32, D33, D34,D4,D41,D42, D43, or D44. lf SP is
s p e c i f i e d ,t h e q u e u e i s c o p i e d f r o m t h e a c t i v es p o o l f i l e .

T h i s o p t i o n a l p a r a m e t e rs p e c i fi e s t h a t o n l y t h o s e i o b s a r e t o
b e c o p i e d w h i c h c a n b e e x e c u t e di n t h e p a r t i t i o n s p e c i f i e d
o n t h e P A R T I T I O N p a r a m e t e r . P o s s i b l ep a r t i t i o n p a r a m e t e r sa r e 1 , 2 , a n d 3 .
T h i s p a r a m e t e rc a n o n l y b e i n c l u d e d i f t h e c o p y i s f o r t h e
r e a d e rq u e u e .

TO Parameter
T h i s p a r a m e t e rs p e c i fi e s t h e l o c a t i o n o f t h e m a i n d a t a a r e a
t h a t i s t o r e c e i v et h e c o p y o f t h e q u e u e . l f a s p o o l f i l e d o e s
n o t e x i s t o n t h i s m a i n d a t a a r e a ,t h e s p o o l f i l e c o p y p r o g r a m c r e a t e so n e ( S C Po n l y ) .

PRIORITY Parameter

EitherSP (TO SP) or one of the following main data area
c o d e sm u s t b e s p e c i f i e d : D 1 , D 2 , D 3 , D 3 1 , D 3 2 , D 3 3 ,
D 3 4 , D 4 , D 4 ' 1 , D 4 2 , D 4 3 , o r D 4 4 . l t S P i s s p e c i f i e dt,h e
q u e u e i s c o p i e d t o t h e a c t i v es p o o l f i l e .

a r e1 , 2 , 3 , 4 , a n d 5 .

JOBN Parameter
T h i s o p t i o n a l p a r a m e t e rs p e c i fi e s t h a t o n l y t h o s e j o b s t e p s
w h o s e i o b n a m e m a t c h e st h a t n a m e s u p p l i e do n t h e J O B N
p a r a m e t e ra r e t o b e c o p i e d . C o p y i n g m u l t i p l e j o b s , w h o s e
j o b n a m e sb e g i n w i t h t h e s a m ec h a r a c t e r s r, e q u i r e st h e
s p e c i f i c a t i o no f t h o s e c h a r a c t e r sf o l l o w e d b y " * . F r o m 1
**.
through 7 characterscan precedethe

T h i s o p t i o n a l p a r a m e t e rs p e c i fi e s t h a t o n l y t h o s e i o b s t e p s
w h o s ep r i o r i t y m a t c h e st h a t s u p p l i e di n t h e P R I O R I T Y
p a r a m e t e ra r e t o b e c o p i e d . P o s s i b l ep r i o r i t y p a r a m e t e r s

FORMSNO and CARDNO Parameter
T h i s o p t i o n a l p a r a m e t e rs p e c i fi e s t h a t t h e i o b s t e p ( s )i s t o
be copiedonly when the forms type and the FORMSNO
p a r a m e t e rm a t c h ( p r i n t ) o r w h e n t h e c a r d t y p e a n d t h e
C A R D N O p a r a m e t e rm a t c h ( p u n c h ) . T h e F O R M S N O a n d
C A R D N O p a r a m e t e r sa r e m u t u a l l y e x c l u s i v e .
l f t h i s p a r a m e t e ri s i n c l u d e d ,t h e c o p y m u s t n o t b e f o r t h e
r e a d e ro u e u e .

P A B A M E T ER D E S C R I P T I O N S - A U T H O R I Z E
STEPN Parameter
LIST Parameter
T h i s o p t i o n a l p a r a m e t e rs p e c i f i e st h a t o n l y t h o s e j o b s t e p s
w h o s e s t e p n a m em a t c h e st h a t n a m e s u p p l i e do n t h e S T E P N
p a r a m e t e ra r e t o b e c o p i e d . C o p y i n g m u l t i p l e j o b s t e p s ,
w h o s e s t e p n a m e sb e g i n w i t h t h e s a m ec h a r a c t e r sr, e q u i r e s
**.
From
t h e s p e c i f i c a t i o no f t h o s e c h a r a c t e r sf o l l o w e d b y
**.
This parameter
1 t h r o u g h 7 c h a r a c t e r sc a n p r e c e d et h e
c a n n o t b e i n c l u d e dw h e n c o p y i n g t h e r e a d e rq u e u e . W h e n
t h e S T E P N p a r a m e t e ri s i n c l u d e d ,t h e J O B N p a r a m e t e r
must alsobe included.

T h i s o p t i o n a lp a r a m e t e r( L I S T Y E S o r L I S T - N O )s p e c i f i e s
w h e t h e r t h e c o n t e n t so f t h e A U T H O R I Z f i l e i s t o b e
p r i n t e d . W h e n L I S T - Y E S i s s p e c i f i e d ,t h e c o n t e n t s o f t h e
A U T H O R I Z f i l e a r e p r i n t e d o n t h e s y s t e mp r i n t e r a f t e r
a l l c h a n g e st o t h e A U T H O R I Z f i l e h a v e b e e n m a d e . W h e n
L I S T - N O i s s p e c i f i e d ,t h e c o n t e n t so f t h e A U T H O R l Z
f i l e a r e n o t p r i n t e d . l f t h i s p a r a m e t e ri s n o t s p e c i f i e d ,
LIST NO isassumed.

Spool File Copy Program-$OCOPY

4-183

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued28 September ,|979
By TNL: cN2t-5674

P A R A M E T ER D E S C R I P T I O N S . C L A S
FS
YI
PROGRAMParameter
T h i sp a r a m e t e(rP R O G R A M - p r o g r anm
a m e )s p e c i f i etsh e
nameof the programthat is to be assigned
a classnumoer.

S P O O LF I L E C O N S I D E R A T I O NASN D R E S T R I C T I O N S
FILE Requirements
O n l y t h o s eF I L E s t a t e m e n ttsh a t a r en e e d e dt o e x e c u r e
the desiredfunctionsof $OCOpy needto be includedin
theOCL.

UNIT Parameter
This parameter(UN|T-code)specifies
the locationof the
simulation
a r e at h a t c o n t a i n st h e l i b r a r yc o n t a i n i n g
the
programto be assigned
a classnumber. possiblecodesare
F 1 , R 1 , F 2 ,o r R 2 .

CLASSParameter
T h i sp a r a m e t e(rC L A S S - 01, , 2 , o r 3 ) s p e c i f i etsh e c t a s s
numberto be assigned
to the programidentifiedby the
P R O G R A Mp a r a m e t e r .

LIBRARY Parameter
T h i so p t i o n apl a r a m e t e( L
r IBRARy_O
or LIBRARy-R)
specifies
whetherthe programto be assigned
a classnumber
i s i n t h e O ( o b j e c t )l i b r a r yo r t h e R ( r o u t i n e )l i b r a r y . t f
t h i s p a r a m e t ei rs n o t s p e c i f i e dt h
, e O l i b r a r yi s a s s u m e d .

PACK Parameter
T h i so p t i o n a p
l a r a m e t e(rp A C K - p a c k n a mvee) r i if e st h a t
the correctlibrary is accessed
whena programis assigned
a classnumber. (The PACK parameteris comparedwith
t h e n a m eo f t h e s i m u l a t i o na r e ai d e n t i f i e db y t h e U N I T
parameter.)lf the PACK parameteris not specified,
v e r i f i c a t i o ins n o t d o n e .

4-184

T h e s p o o l f i l e c o p y p r o g r a m f u n c t i o n s t h a t r e q u i r ef i l e s a l s o
r e q u i r ed a t a m a n a g e m e n ts u b r o u t i n e st o b e i n c l u d e dt o
accessthose files. The function requestedis compared with
t h e s p e c i f i e df i l e t o d e t e r m i n ew h i c h d a t a m a n a g e m e n t
s u b r o u t i n e sa r e t o b e i n c l u d e d . T h e s es u b r o u t i n e sa r e t h e n
l i n k e d t o g e t h e ra s r e q u i r e d i m m e d i a t e l Vb e f o r e t h e f u n c t i o n
is executed. The required data managementsubroutines
must be located in the R-library of either the system pack
o r t h e p r o g r a mp a c k .
F i g u r e4 - 9 4 s h o w s t h e f i l e s a n d t h e d a t a m a n a g e m e n st u b r o u t i n e sr e q u i r e df o r s p e c i f i cf u n c t i o n s o f t h e s p o o l f i l e
copy program.

Partition Size Requirements
F i g u r e4 - 9 4 s h o w s t h e m i n i m u m p a r t i t i o n s i z e sr e q u i r e d
t o e x e c u t es p e c i f i cf u n c t i o n s o f $ O C O p y . H o w e v e r ,t h e
performance of $QCOPY might be improved when this
p r o g r a m i s e x e c u t e di n a p a r t i t i o n w i t h a s i z e l a r g e rt h a n
m i n i m u m r e q u i r e m e n t s( 1 6 K , f o r e x a m p l e ) . T h e l a r g e r
p a r t i t i o n s i z e a l l o w s $ O C O P Y t o u s e a l a r g e rl / O b u f f e r
area becausethe $OCOPY functions that involve copying
t o o r f r o m a s p o o l f i l e u s e t h e a v a i l a b l es p a c ei n t h e p a r t i _
t i o n f o r l / O b u f f e r s ,b o t h f o r t h e s p o o l f i l e a n d f o r t h e
d a t a m a n a g e m e n t( i f d i s k f i l e s a r e u s e d ) . U n d e r C C p ,
t h i s c a p a b i l i t y r e q u i r e st h e s p e c i f i c a t i o no f a l a r g e rv a t u e
o n t h e T A S K S I Z E p a r a m e t e ro f t h e p R O G R A M s t a t e m e n r
i n t h e a s s i g n m e nst e t .

P a s eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e P t e m b e r1 9 7 9
BYTNL: GN21-5674

Copy the EntireSpool File (COPYSP)

Copy SelectedJob Stepsfrom the Print Oueue(COPYPRTO)

Tape-to-tape
copy is not supported.

A i o b s t e po n t h e p r i n t q u e u ec a n n o tb e c o p i e di f a n y o f
t h e f o l l o w i n gc o n d i t i o n se x i s t :

The FROM and TO parameters
cannotbe the same.
r
T o m i n i m i z et h e t i m e r e q u i r e dt o e x e c u t et h e s p o o lf i l e
c o p y p r o g r a mo, n l y s p o o lf i l e t r a c kg r o u p sc o n t a i n i n d
gata
arecooied.
The spoolfile. when copiedto disk,can be usedby spool
a f t e ra n I P L i s p e r f o r m e d .
Any lob stepsthat are incompletewhen the copy is started
will be incompleteon the copy of the spoolfile. To
preventcopyingincompletejob steps,the COPYSPfunct i o n f r o m a n a c t i v es p o o lf i l e s h o u l dn o t b e s t a r t e du n t i l a l l
s p o o l i n gf u n c t i o n si n t h e s u p e r v i s oarr ec o m p l e t ea n d a l l
spooledpartitionsareat end of job.

T h e j o b s t e pi s c u r r e n t l ye x e c u t i n g .

o The job stepis beingprintedby spoolor beingcopiedby
the spoolf ile copy programin anotherpartition.
o A REUSEcommandwasspecifiedfor the job step.
o The OCOPY-NOparameterhad beenspecifiedon the
P RI N T E RO C L s t a t e m e nfto r t h a t l o b s t e p .
d i t h o u tt h e F O R M S N O ,
W h e nC O P Y P R T Oi s s p e c i f i e w
p
a
r
a
m
e
t
e
ras l,l a v a i l a b lieo b s t e p so n t h e
a
n
d
S
T
E
P
N
JOBN,
p r i n t q u e u e( i n c l u d i n g
t h o s et h a t a r ec u r r e n t l yh e l d )a r e
copied.

lf the copy from the active spool file is started before all
s p o o l i n gf u n c t i o n s i n t h e s u p e r v i s o ra r e c o m p l e t e a n d
before all sFooled partitions are at end of job, then the
spool file copy program can causethe spooling functions to
wait for the copy to complete.

When a job step is being copied from the print queue, that
j o b s t e p a p p e a r so n a d i s p l a y o f t h e q u e u e w i t h a n i n d i c a tion that it is being copied by $OCOPY. However, system
commands that normally pertain to that iob step do not

W h e n a s p o o lf i l e i s c o p i e d e i t h e r t o o r f r o m a t a p e f i l e , a
record length of 1024 is used. A default block length of
1O24 is used unlessotherwise specified on the tape OCL
FILE statement.

F i x e d - l e n g t hr e c o r d s( F L R ) w r i t t e n t o t h e P R I N T O f i l e
contain printer IOB O- and R-bytes as the f irst 2 bytes.
(The O- and R-bytes contain data that is used by spool to
print the record.) An end'of'step record. consistingof 134

The spool file copy program supports copying an inactive
s p o o lf i l e t o a m u l t i v o l u m et a p e f i l e b u t d o e sn o t s u p p o r t
c o p y i n g a n a c t i v es p o o l f i l e t o a m u l t i v o l u m e t a p e f i l e .
Therefore, when the active spool f ile is being copied to tape
and the end-of-reelmarker is detected, a messageis issued
a n d t h e c o p y f u n c t i o n i s d i s c o n t i n u e d .Y o u c a n o v e r c o m e
this situation by copying the active spool file to disk first
and then copying the new inactive spool file from disk to a

affect it.

b v t e sw i t h h e x F F F F i n t h e f i r s t 2 b y t e s ,i s w r i t t e n a t
the end of each step for each step that is completely copied.

m u l t i v o l u m et a p e f i l e .

record (VLR) written to the PRINTO
E a c hv a r i a b l e - l e n g t h
file contains a length byte (which defines the total length of
the record including the length byte) followed by the
printer IOB O- and R'bytes and the print record with the
t r a i l i n g b l a n k s r e m o v e d . M u l t i p l e V L R r e c o r d sa r e b l o c k e d
into a 134-byte record and then written to the file. An
e n d - o f - s t e pr e c o r d c o n s i s t i n go f h e x 0 3 F F F F i s a p p e n d e dt o

The COPYSP control statement is valid only when the
spool file copy program is executed under the system
control program.

the VLR print records in the buffer at end of step for each
step that is completely copied. The print recordsfor the
next step start at the beginning of the next 134-byte
record.
A f o r m l e n g t h c h a n g er e c o r d ,c o n s i s t i n go f h e x 0 4 E 1 0 0 n n
for VLR or hex E100nn plus an additional131 bytesfor
F L R , a p p e a r sa n y w h e r ea m o n g t h e p r i n t r e c o r d st o i n d i c a t e
' a c h a n g ei n t h e f o r m s l e n g t h . T h e n n i n d i c a t e st h e n e w
forms lengthin hex.

Spool File Copy Program-$OCOPY

4-18/.'1

This pageintentionallyleft blank.

4-184.2

P a g eo t G C 2 1 ' 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

Function

Default
F i l eN a m e

COPYSP
FROM-TAPE

$SPOOL

File Device

File AccessMethod

File
Record Length2

Tape

Input

1024

List of
Required
M i n i m u m Data
Partition Management
(SeePart4l
Size

1 0 KP l u s
2 Times

E

the Block
Lengthr

TO-TAPE
COPYPRTO
ILE
OUTPUT-F
or
OUTPUT-ADD

P RI N T O

REMOVE.YES
or
REMOVE.NO

Tape

Output

1024

loK

g

Unit Record

Output

134

1oK

El

S i m u l a t i o n A r e a C o n s e c u t i v eA d d o r
ConsecutiveOutPUt

134

1oK

El

Main Data Area

ConsecutiveAdd or
ConsecutiveOutPut

134

1oK

E

Tape

Output

134

10KPlus

fl

2 Times
the Block
Lengtht
COPYPCHO
OUTPUT-FILE PUNCHO
or
OUTPUT.ADD
REMOVE-YES
or
REMovE-No

MFCU-98
MFCM-83
1442.82

10K

E

S i m u l a t i o nA r e a C o n s e c u t i vAed d o r M F C U - 9 8
C o n s e c u t i vOeu t p u t M F C M - 8 3
1442'82

10K

tr

M a i nD a t aA r e a C o n s e c u t i vAed d o r M F C U - 9 8
C o n s e c u t i vOeu t p u t M F C M - 8 3
1442-82

10K

tr

UnitRecord

Output

Tape

Output

MFCU-98
MFCM-83
144282

10KPlus
2 Times
the Block
LengthI

f,l

OUTPUT-PUNCH

Unit Record

Output

MFCU-96
MFCM.SO
1442-80

10K

fl

REMOVE-YES
or
REMOVE-NO

S i m u l a t i o nA r e a C o n s e c u t i vAed d o r M F C U - 9 6
C o n s e c u t i vOeu t P u t M F C M - 8 0
1 4 4 28 0

10K

tr

M a i nD a t aA r e a C o n s e c u t i vAed d o r M F C U - 9 6
C o n s e c u t i vOeu t p u t M F C M8 0
1442-80

10K

tr

*rtition sizeup to the next 2K boundary.
, Gllll-*
2Th"
t l t a r e c o r d l e n q t h f o r t h e C O P Y P C H O f u n c t i o n d e p e n d so n w h i c h p u n c h d e v i c ew a s b e i n g s p o o l e d
I
t
Figure 4-94 (Part I of 41. Spool File Copy Program Files and Subroutines

Spool File Copy Program-$OCOPY

4-185

P a g eo f G C 2 1- 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r19 7 9
By TNL: cN21-5674

List of
Required
Data
Management
(SeePart 4)

File AccessMethod

Output

COPYRDRO
OUTPUT-FILE
or
OUTPUT.ADD
REMOVE.YES
or
R E M O V EN O

INPUT.F
ILE

RE A D E R O U n i t R e c o r d
Output
S i m u l a t i o nA r e a ConsecutiveAdd or

MFCU.96
MFCM-80
1442-80

96
96

10K
10K

C o n s e c u t i v eO u t p u t
Main DataArea

ConsecutiveAdd or
ConsecutiveOutput

96

10K

Tape

Output

96

1 0 KP l u s
2 Times
the Block
LengthI

Unit Record

lnput

1-128
't-128

10K

S i m u l a t i o n A r e a C o n s e c u t i vI e
nput
Main Data Area

C o n s e c u t i vI e
nput

Tape

Input

1-128
't-128

10K
10K
1 0 KP l u s
2 Times
the Block
LengthI

g

a
tr
E

tr
tl
tr
tr
g
IE

LOREC
or
HIREC

S i m u l a t i o n A r e a D i r e c tI n p u t

1-128

10K

Main DataArea

D i r e c tI n p u t

1-128

10K

K E Y ,L O K E Y
or HIKEY

Main Data Area

IndexedSequential
InputWithin Limits

1-128

12K

tr

Main Data Area

lndexedSequential
Input

1-128

12K

@

Output

40

10K

E

40

10K

Main Data Area

Consecutive
Add or 4 0
C o n s e c u t i vOeu t p u t

10K

Tape

Output

1 0 KP l u s
2 Times
the Block
LengthI

( l n d e x e df i l e ,
keysnot
s p e c i fe d )
DISPLAY
O U T P U T . FLIE
or
OUTPUT.ADD

DISPLAYO Unit Record

S i m u l a t i o nA r e a Consecutive
Add or
Consecutive
Output

40

l ^

hound the partition sizeup to the next 2K boundary.
,' T h e
f ile record length for the CoPYPCHQ function depends
on

w h i c h p u n c h d e v r c ew a s b e a n gs p o o l e d

Figure 4.94 (Part 2 of 41. Spool File Copy program
Fites and Subroutines
4-186

1 0 KP l u s
2 Times
the Block
Lengthr

tr
tr
E

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
Bv TNL: GN21-5674

File
Record Length2

List of
Required
M i n i m u m Data
Partition Management
(SeePart 4)
Size

Function

Default
F i l eN a m e

RESTORE

R E S T O R E S i m u l a t i o nA r e a C o n s e c u t i vI e
nout

R e c o r d fso r :
1403-134
MFCU-98
MFCM-83
1442.82

12K

tl

Main DataArea C o n s e c u t i vIen p u t

R e c o r d sf o r :
1403-134
MFCU.98
MFCM-83
1442-82

12K

tr

Tape

R e c o r d fso r :
14 0 3 - 13 4
MFCU-98
MFCM-83
1442.82

1 2 KP l u s
2 Times
theBlock
LengthI

C O N T R O L S i m u l a t i o n A r e aD i r e c tl n p u t

1 -128

10K

N/A

M a i nD a t aA r e a D i r e c tI n p u t

1-128

10K

N/A

256

10K

N/A

COPYCTR
L

AUTHORIZE

File Device

File AccessMethod

Input

A U T H O R I Z M a i nD a t aA r e a D i r e c t I n p u t

tr

Direct Update

I
Round the partition sizeup to the next 2K boundary.
tTh"
f i l " r e c o r d l e n g t h f o r t h e C O P Y P C H O f u n c t i o n d e p e n d so n w h i c h p u n c h d e v i c e w a s b e i n g s p o o l e d '

Figure 4-94 (Part 3 of 4). Spool File Copy Program Files and Subroutines

Spool File Copy Program-$OCOPY

4-186'1

Paseof GC21-5162-1
lssued28 September1979
ByTNL: GN21-5674

RequiredDataManagement
(R-Modules)
for $OCOpy FunctionsUsingFiles

Il

$$cslT

$$TSMO $$TSBS

$$TSCR

a

$$csoT

$$TSMO

$$TSCR

E
g

tr
tr

$$TSSB

$$ARFF lit 1442is used)
$$LPRT (if 1403 is used)

$$MFpp lif S4Z4is used)
$$MMpp (if 2560 is usedl
$$LpMp (if 3284 or 3287is used) $$cpop (it g741isused)

$$CSOP $$SRBR $$SRUA $$SRDF $$SRTC $$SRDI
$$CFOP

$$SFBR

$$SFUA

$$ARFF lif 1442is used)
$ $ A R R D ( i f 2 5 0 1i s u s e d )

$$SFDF

$$SRTC

$$SFPD

$$MFRD lit il24 is usedl
$ $ C p t p( i f 3 7 4 1 i su s e d )

$$SRMO $$SRSB $$SRBP
$$SRMO $$SFSB

$$MMRD (if 2560 is used)

E

$$CSIP

tr

$$SRBR $$SRUA $$SRTC $$SRMO $$SRSB $$SRDI

$$CFIP

$$SFBR

$$DAID

$$SRCB $$SRDA $$SRDI

$$SRRC $$SRRI

$$SRTC

$$DFID

$$sFpD

$$sFRC

$$sFRt

$$sFcB

tr

$$SRTC

$$IHIL

$$SFMO $$SFPD

$$SFIC

$$SFRC $$SFRI

@

$$rHrp $$sFMo $$sFpD $$sFrc $$sFRc $$sFRr $$sRTc $$sFBp

g
IE

$$sFsl

$$SFUA

$$SRTC $$SFMO $$SFSB

Figure tl-94 (Part 4 of 41. Spool File Copy program
Files and Subroutinoi

4-186.2

$$SFDA

$$SFBP

$$SFPD

$$SFLM

$$SRBP
$$SFBP

$$SRTC $$SFBP

$$SFSC

This pageintentionallyleft blank.

Spool File Copy Program-$OCOPY

4-187

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: cN21-5674

lf HEADER-YES
i s s p e c i f i e da, 1 3 4 - b y t eh e a d e r e c o r di s
written at the beginningof the output for eachstep. For
F L R ( F i x e dL e n g t hR e c o r d )t,h e f i r s t t w o b y t e sc o n t a i n
h e x F F F E . F o r V L R ( V a r i a b l eL e n g t hR e c o r d )t,h e f i r s t
t h r e eb y t e sc o n t a i nh e x 8 6 F F F E . T h e f o l l o w i n gc h a r tg i v e s
t h e f o r m a to f t h e h e a d e r e c o r d sf o l l o w i n gt h e i n i t i a l2 _o r
3-bytesas previouslyindicated:
Start
Offset
Hex

End
Offset
Hex

00
08
10

o7
OF
10

8
8
1

11

11

1

12

12

1

13
14
15

13
14
15

1
1
1

16
19

18
1A

3
2

1B

82(83)

104(105)

4-188

Length
(Decl

Description
Jobname
Stepname
Statusbyte 1
X ' 8 0 ' J o b s t e ph e l do n
pflnI queue
X ' 0 4 ' F o r m sa l i g n m e n tr e q u i r e d
X ' 0 2 ' H a l to n u n p r i n t a b l ec h a r a c t e r s
Statusbyte 2
X'20' job stepkept
on printqueue
P r i o r i t yo n p r i n t
q u e u e( h e x )
Reserved
F o r m sl e n g t h( h e x )
N u m b e ro f c o p i e s
(hex)
Formstype
Numberof pages
(hex)
Reserved

T h e f o l l o w i n g c h a r t g i v e st h e Q - a n d R - b y t e sa n d t h e i r
m e a n i n g sf o r t h e r e c o r d sw r i t t e n t o t h e P R I N T O f i l e :

O-Byte

1 00000

R-Byte

Description

11100001
111 00 0 1 0
111 00 0 1 0
111 00 0 1 0
11100010
1110100
11100100

00000000
00000001
00000010
00000011
00000000
00000000
00000001
00000010
00000011
00000001
00000010

11100100
11i 0 0 1 0 0
11100110
11100110

0110
1111
0111 0000
00000001
00000010

S k i p t o l i n e 1 11
S k i pt o l i n e 11 2
P r i n t f o l l o w e db y s k i p t o l r n e i
P r i n t f o l l o w e d b y s k i p t o l i r r e2

11100110
11100110
'11111111

01101111
01 1 1 0000
11111110
11111111

P r i n t f o l l o w e db y s k i p t o l i n e 1 1 l
P r i n tf o l l o w e db y s k i p t o l i n e 1 1 2

11111111
I

?l

S P A C E^ i

A r r R - b y t e v a l u eo f g r e a t e rt h a n 3 i s n o t p e r m i t t e d a n d r e s u l i s
i n a s p a c e0 .

: \
F o r m s l e n g t hc h a n g e r
P r i n t f o l l o w e d b y s p a c e0
P r i n t f o l l o w e d b y s p a c e1
P r i n t f o l l o w e d b y s p a c e2
P r i n t f o l l o w e d b y s p a c e3
Skipto line 1
Skip to line2

A n R ' b y t e g r e a t e rt h a n 3 i s n o t p e r m i t t e d a n d
r e s u l t si n a s p a c e0 .

\

H e a d e rr e c o r d '
End of steprecordt

lndi"ut", O- and R-bytes for records generated by spool ancl$OCOPY.

F o r m o r e i n f o r m a t i o n a b o u t t h e O - a n d R - b y t e s ,r e f e r t o
the IBM System/3 Models 8, 10, 12, 15 Components
Reference Manual. G421 9236.
W h e n t h e s y s t e m i s e x e c u t i n gt h e s p o o l f i l e c o p y p r o g r a m
i n a s p o o l e dp a r t i t i o na n d O U T P U T P R I N T i s s p e c i f i e d( o r
O U T P U T " F I L Ew i t h t h e P R I N T Q f i l e a s t h e p r i n t e r ) ,t h o s e
j o b s t e p sp r i n t e d b y $ O C O P Y a r e i n t e r c e p t e db y s p o o l a n d
p l a c e do n t h e q u e u e a s o n e j o b s t e p u n d e r t h e i o b a n d s t e p
n a m e u s e d w h e n t h e s p o o l f i l e c o p y p r o g r a mw a s l o a d e d .
l f t h e J O B N , o r J O B N a n d S T E P N p a r a m e t e r sa r e s p e c i fi e d
w i t h t h e F O R M S N O p a r a m e t e r ,t h e j o b s t e p ss p e c i fi e d a r e
c o p i e d o n l y i f t h e i r f o r m s t y p e m a t c h e st h a t g i v e n i r r t h e
FORMSNO parameter.

TheV are not valid printer O and R'bytes.

i nly after it
lf the output file is a disk f ile, it can be sltareto
is closed.
l f t h e o u t p u t f r l e i s a t a p e f i l e , $ O C O I - ' Yi r s s t r r n easd e f a u l t
b l o c k l e n g t h o f 1 3 4 0 ( 1 0 - r e c o r d sp e r b l o c k ) u r - r l e sasb l o c k
l e n g t hi s s p e c i f i e do n t h e P R I N T O O C L F i L E s t a t e m e n t .
T h e m i n i m u m p a r t i t i o ns i z ew h e n L r s r n tga p e i s 1 0 K b y t e s
p l u s t w i c e t h e t a p e b l o c k l e n g t h r o u n d e du p w a r d t o t h e
n e a r e s t2 K . C o n s i d e rt h e f o l l o w i n g e x a r n p l e :
Tapeblock lengthin bytes
Multiply by 2
A d d b a s ef u n c t i o n s i z e ( 1 0 K )
T o t a l s t o r a g er e q u i r e d
R o u n du o w a r dt o n e x t 2 K

1340
X2
2680
+10240
12520
14336 (14K)

T h e r e q u i r e dp a r t i t i o ns i z ef o r t h i s e x a m p l ei s

'14K.

Spool FileCopy Program--$OCOPY 4-189

Page
of GC21-5162-1
l s s u e 2d 8 S e p t e m b ei 9r 7 9
B y T N L . :c N 2 1 - 5 6 7 4
l f t h e c o p y f u n c t i o n i s O U T P U T F l L E , p u n c h c h e c k sc a n
o c c u r i f t h e o u t p u t f i l e i s a p u n c h d e v i c e ,o r u n p r i n t a b l e
c h a r a c t e r sc a n o c c u r i f t h e o u t p u t f i l e i s a p r i n t e r . T h e s e
c o n d i t i o n sc a n o c c u r b e c a u s et h e c o p y r e c o r d sc o n t a i n t h e
Q - a n d R - b y t e sa s t h e f i r s t 2 c h a r a c t e r s .l f t h e c o p y f u n c t i o r r i s O U T P U T . P R I N T , t h e s p o o l f i l e p r o g r a ms u p p o r t s
u n p r i n t a b l ec h a r a c t e r si n t h e s a m em a n n e r a s t h e s p o o l
p f l n t w r i t e r . T h e p a r a m e t e rO U T p U T _ p RI N T i s i n v a l i d

copied.
W h e n a j o b s t e p i s b e i n g c o p i e d f r o m t h e p u n c h q u e u e ,t h a t
j o b s t e p a p p e a r so n a d i s p l a y o f t h e q u e u e w i t h a n i n d i c a -

w h e n t h e p r o g r a m i s e x e c u t i n gu n d e r C C p .

t i o n t h a t i t i s b e i n gc o p i e d b y $ O C O P Y . H o w e v e r ,s y s t e m
c o m m a n d st h a t n o r m a l l y p e r t a i n t o t h a t j o b s t e p d o n o t
affect it.

W h e r rR E M O V E Y E S i s s p e c i f i e d ,j o b s t e p sa r e n o t r e m o v e c l
f r o m t h e q u e u e u n t i l a l l j o b s t e p sh a v e b e e n s u c c e s s f u l l V
copied. However, job steps are removed before the next
c o i l t r o l s t a t e m e n ti s r e a d . T h e r e f o r e ,j o b s t e p sb e i n g
c o p i e d a r e n o t l o s t i f t h e c o p y f u n c t i o n d o e sn o t t e r m i n a t e
n o r m a l l y . B u t j o b s t e p sw i l l b e l o s t i f $ O C O p y i s c a n c e l e d
after the job steps have been removed.

W h e n y o u s p e c i f y t h e O U T P U T - F I L E p a r a m e t e r ,t h e c o p y
o u t p u t c o n t a t n sc o n t r o l b y t e s . T h e s ec o n t r o l b y t e s ,c a l l e d
p u n c h I O B O - , R - , a n d H - b y t e s ,a r e u s e d b y t h e s y s t e mt o
p u n c h t h e r e c o r d . T h e y a r e c o n t a i n e di n t h e f i r s t ( l e f t m o s t )

W h e n R E M O V E O N L Y i s s p e c i fi e d , j o b s t e p sa r e r e m o v e d
f r o r n t h e q u e u e w i t h o u t b e i n gc o p i e d . T h e p R I N T O f i l e
i s n o l u s e di o r t h i s f u n c t i o n .
C o m n t e n t sa r e n o t a l l o w e d o n t h e C O p y p R T O s t a t e m e n t
u n l e s sa t l e a s to n e p a r a m e t e ri s i n c l u d e d "
N o t e : l f a j o b s t e p i s t o b e a d d e dt o a f i l e i n w h i c h t h e l a s t
job step does not have an end-of-steprecord (due
to not
b e i n gc o n r p l e t e l yc o p i e d t o t h e f i l e f r o m t h e s p o o l q u e u e ) ,
t h e l o b s t e p b e i r r ga d d e d m u s t h a v e a h e a d e rr e c o r d i n o r d e r
t o b e r e c o g n i z e df r o m t h e p r e c e d i n gi n c o m p l e t ej o b s t e p i n
t h e f i l e . A j o b s t e p s h o u l d n o t b e a d d e dt o a f i l e i n w h i c h
t h e i a s t j o b s t e p h a s v a r i a b l e - l e n g t ph r i n t r e c o r d sa n d d o e s
n o t h a v e a r re r r d - o-fs t e pr e c o r d ;r e s u l t sw i l l b e u n p r e d i c t a b l e
i f a R E S - fO R E f u n c t i o n i s a t t e m p t e d w i t h t h a t f i l e .

Copy SelectedJob Steps from the Punch eueue
(COPYPCHO}
A j o b s t e p o n t h e p u n c h q u e u ec a n n o t b e c o p i e d i f a n y o f
t h e f o l l o w i n gc o n d i t i o n se x r s t :
The job step iscurrently executing.
T h e j o b s t e p i s b e i n g p u n c h e d b y s p o o l o r b e i n gc o p i e d
b y t h e s p o o l f i l e p r o g r a m i n a n o t h e rp a r t i t i o n .
.

W h e n C O P Y P C H O i s s p e c i f i e dw i t h o u t t h e C A R D N O ,
J O B N , a n d S T E P N p a r a m e t e r sa, l l a v a i l a b l ej o b s t e p so n t h e
p u n c h q u e u e ( i n c l u d i n gt h o s e t h a t a r e c u r r e n t l y h e l d ) a r e

A R E U S E c o m m a n d w a s s p e c i if e d f o r t h e j o b s r e p .

o T h e O C O P Y N O p a r a m e t e rw a s s p e c i f i e do n t h e
P U N C H O C L s t a t e m e n tf o r t h a t j o b s t e p .

4-190

2 or 3 bytesof the record. For more informationabout the
O-, R-, and H-bytes, refer to the IBM System/3 Models 8.
10, 12, and 15 Components Reference Manual, G421-9236.
Becausethe copy output can contain the control bytes, the
record length depends on whether you specify the
O U T P U T F I L E p a r a m e t e ro r t h e O U T P U T - P U N C H
p a r a m e t e r . T h e f o l l o w i n g c h a r t s h o w st h e r e c o r d l e n g t h
f o r t h e p o s s i b l ep u n c h d e v i c e sa n d t h e O U T P U T p a r a m e t e r s .

Parameters
Punch device

OUTPUT-PUNCH OUTPUT.FILE

5424 MFCU

96

ggr

2 5 6 0M F C M

80

932

1 4 4 2C a r d
R e a dP u n c h

80

g2l

lThe

fir.t 2 bytes of the record are the punch lOg
O'and R'bytes.
2The
first 3 bytes of the record are the punch IOB
O-, R-, and H-bytes.

l f y o u s p e c i f y t h e O U T P U T - F I L E p a r a m e t e ra n d t h e c o p y
o u t p u t i s d i r e c t e dt o a p u n c h d e v i c e ,t h e r i g h t m o s t 2 o r 3
bytes of the record are truncated if the record lenoth
e x c e e d st h e d e v i c ec a p a c i t y .

P a g eo f G C 2 1- 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
Bv TNL: GN21-5674

l f y o u s p e c i f yt h e O U T P U T - F I L E p a r a m e t e r ,a n e n d - o f - s t e p
record is written at the end of each job step that is completely copied. The f irst 2 bytes of this record consist of
h e x F F F F . A d d i t i o n a l l y ,i f y o u s p e c i f yH E A D E R - Y E S ,a
header record that contains information about that job step
i s w r i t t e n t o t h e f i l e a t t h e b e g i n n i n go f e a c hc o p i e d i o b
step. The length of the header record is the same as the
record length of the file. The first two bytes of the header
r e c o r dc o n s i s to f h e x F F F E . T h e f o l l o w i n g c h a r t g i v e st h e
f o r m a t o f t h e h e a d e rr e c o r d f o l l o w i n o t h o s e i n i t i a l t w o
bytes:

Ending
Start
Offset Off set Length
(Dec)
{Hex) (Hex)

00
08
10

07
OF
10

8
8
1

11

11

I

12

12

I

13
15
16
19

14
15
18
1A

2
1
3
2

1B

E n do f
Record

Description

The following chart gives the Q- and R-bytes and their
meanings for the records written to the PUNCHO f ile:

O-Byte
1442

0 1 0 10000
0 10 1 0010

Feed
P u n c ha n d F e e d

F e e d( p r i m a r y )
P u n c ha n d f e e d
(primary)
Feed(secondary)

1 1 1 10 0 0 0
5424
1 1 1 10 0 1 0
(MFCU)
2560
1 1 1 11 0 0 0
( M F C M ) 1 1 1 11 0 ' t 0

Punchand feed
( s e c o n d a r )y

xxxx x000 No stacker
5/'24
(MFCU)

Status byte 2
X'20'Job step kept on
puncn queue
Priority on punch queue
(hex)

xxxxx100
x x x xx 1 0 1
x x x xx i 1 0
x x x x x 111

s e l e c toi n
S e l e c ts t a c k e r4
S e l e c ts t a c k e r1
S e l e c ts t a c k e r2
Select stacker 3

x x x x x 0 0 0 S t a c k e rs e l e c t
defauIt
(1-primary,

Reserved
N u m b e r o f c o p i e s( h e x )
Card type
Number of cards
(hex)

Description

xxxx x000 S e l e c ts t a c k e r1
x x x x x 0 0 1 S e l e c ts t a c k e r1

Job name
Step name
Status byte 1
X'80' Job stepheld on
puncn queue

R-Byte

2560
(MFCM)

R eserved

xxxx x001
x x x xx 0 1 0
x x x x x 0 11
xxxx x100
x x x xx 1 0 1

5 - s e c o n d a r y)
S e l e c ts t a c k e r1
S e l e c ts t a c k e r2
S e l e c ts t a c k e r3
S e l e c ts t a c k e r4
Select stacker 5

1442
e a d e rr e c o r d r
f r r r r r r r 1 1 1 11 ' , | 1 0HErrd
v24
1 1 1 1 1 1 1 1 of step
2560 1 1 1 1 1 1 1 1 1
recordl
I

Indicates O- and R-bytes for records generatecl by
$OCOPY and are not valid O- and R-bytes.

F o r m o r ei n f o r m a t i o na b o u tO - . R - , a n d t { - b y t e s ,r e f e r t o
the IBM System/3 Models 8, 10, 12, and l5 Contponents
ReferenceManual,GA21 9236.

Spool File Copy Program $OCOPY

4'191

P a g eo f G C Z 1- 5 1 6 2 . 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TN L: cN21-5674

| ,v^v ,n,e nt n e

s y s t e mr s e x e c u t t n gt h e s p o o l f i l e c o p y p r o g r a m
I
, n d t h e p U N C H Of i l e i s
I I n a p a r t i t i o nw i r h s p o o l a c t i v e a
t h e s p o o l l t r t r r c l rl,h r : l r t h i ; s ej o b s t e p sp u n c h e d a r e i n t e r ccpl.uil LryspOci irfrrjpiaced on th€:puilclt queue rs one job
s t e p u u d e r t h e j o b a n d s t e p n a m e u s e dw h e n t h e p r o g r a m
wasloaded.
l f t h e o u t p u t f i l e i s a d i s k f i l e , i t c a r rb e s h a r e do n l v a f t e r i t
isclosed.
l f t h e o u t 6 r r . rf it l e i s a t a p e f i l e , $ O C O p y a s s u m e sa d e f a u l t
b l o c k l e n g t h o f t e n t i m e s t h e r e c o r d l e n g t h u n l e s sa b l o c k
l e n g t h i s s p e c i f i e do n r h e P U N C H Q O C I * F I L E s t a t e m e n t .
T h e m i n i m u m p a r t i t i o ns i z ew h e n u s i n gt a p e i s 1 0 K b v t e s
p l u s t w i c e t h e t a p e b l o c k l e n g t hr o u n d e du p w a r d t o t h e
n e a r e s t2 K .
l f t h e c o p y f u r r c t i o ni s O U T P U T . Fl L E , p u n c h c l i e c k sc a n
o c c u r i f t h e o u t p u t f i l e i s a p u n c h d e v i c eo r u n p r i n t a b l e
c h a r a c t e r sc a n o c c u r i f t h e o u t p u t f i l e i s a p r i n t o e v r c e .
T h e s ec o n d i t i o n sc a n o c c u r b e c a u s et h e c o p y r e c o r o s
c o n t a i n t h e O - a n d R - b y t e sa s t h e f i r s t 2 c h a r a c t e r s .p u n c h
c h e c k sc a n a l s o o c c u r i f O U T P U T - P U N C H i s s p e c i fi e d a n d
t h e p L r n c hd a t a i s f o r a d i f f e r e n t t y p e o f p u n c h d e v i c e ( f o r
e x a m p l e , 1 4 4 2 C u d R e a d P u n c h s p o o l e d r e c o r d sc o p i e d t o
a 5424 MFCU).
W h e n R E M O V E - Y E S i s s p e c i f i e d ,j o b s t e p sa r e n o t r e m o v e d
f r o r n t l r e q u e u e u n t i l a l l j o b s t e p sh a v e b e e n s u c c e s s f u l l y
c o p i e d . H o w e v e r ,j o b s t e p sa r e r e m o v e db e f o r e t n e n e x t
c o n t r o l s t a t e r n e n ti s r e a d . l - h e r e f o r e ,j o b s t e p sb e i n gc o p i e d
a r e n o t l o s t i f t h e c o p y f u r - r c t i o nd o e s n o t t e r m i n a t e n o r m _
a l l y . B u t j o b s t e p sw i l l b e l o s t i f $ O C O p y i s c a n c e l e d
a f t e r t h e j o b s t e p sh a v e b e e n r e m o v e d .
W h e n R E M O V E - O N L Y i s s p e c i f i e dj ,o b s t e p sa r e r e m o v e o
{ r o m t h e q u e u ew i t h o u t b e r n gc o p i e d . T h e P U N C I I O f i l e
is not used for this function_
C o n r m e n l sa r { lr r o l a l l o w e d o n t t r e C O p y p C H O s t a r e n r e n t
u n l c s sa t l e a s t , : ; r il :l a r a m e t e irs i r i c l L l d e d .
N o t e : l I a j o b s t e p i s t o b e a d d e c tJo a f i l e i n w h i c h t h e l a s t
J o b s t e p d o e s n o t h a v e a n e n c i - o i , s t e pr e c o r d ( d u e t o n o t
b e i n gc o m p l e t e l y c o p i e d t o t h e f i l e f r o m t h e s p o o l q u e r - r e ) ,
t h e ; i i b s t e p b e i r r ga d d e d m u s t h a v e a h e a c l e r e c o r c li n o r d e r
f rc,rntho tr:,rccerling
to be rr:co.i4nized
incomplete iob srep in
the fiir:.

4 - 1 92

Copy Jobs to or f rom the Reader Oueue (COpyRDRO)
W h e n a j o b i s c o p i e d t o t h e r e a d e rq u e u e b y $ O C O p y
e x e c u t i n gu n d e r C C P , t h e n a m e o f t h e t e n n i n a l f r o m w h i c h
$OCOPY was requestedappearsnext to the jobname on a
d i s p l a y o f t h e r e a d e rq u e u e . A d d i t i o n a l l y , t h e p r i o r i t y o f
j o b s p l a c e do n t h e a c t i v es p o o l f i l e r e a d e rq u e u e u n d e r
C C Pc a n b e l i m i t e d e i t h e r b y t h e H I P T Y O C C ( o p e r a r o r
control command) or by an option of the configuration
r e c o r d p r o g r a m ( $ C N Fl G ) .
W h e n a j o b i s c o p i e d t o t h e r e a d e rq u e u e ,t h e R E C L
p a r a m e t e ri s r e q u i r e di f s p o o l i s n o t a c t i v eo r t h e s p o o l
r e a d e ri s n o t s u p p o r t e d . l f t h e R E C L p a r a m e t e ri s s p e c i f i e d
i r r o t h e r t h a n t h e s ec o n d i t i o n s ,i t w i l l o n l y b e u s e d i f t h e
s p o o l r e a d e rf o r t h e s y s t e m i s t h e 3 7 4 1 o r i f t h e c o p y i s t o
a n i n a c t i v es p o o l f i l e .
l f t h e s p o o l r e a d e ri s t h e 3 7 4 1 'a n d t h e R E C L p a r a m e t e ri s
n o t s p e c i f i e d ,t h e i n p u t r e c o r d l e n g t h i s t h e l e n g t h o f t h e
s o u r c er e c o r d sa s d e t e r m i n e db y t h e I N P U T p a r a m e t e r :

I N P U TP a r a m e t e r

Input Record Length

TE RM INAL

80

READER

L e n g t h o f s y s t e mi n p u t d e v i c e
recoros

FILE

Length of file records

The followingchart showshow to determinethe input
recordlength. For example,if the spoolreaderis not the
3741 and eitherthe copy is for the activespoolfile or the
RECL parameteris not specified,then the input record
lengthwill be the lengthof the spoolreaderrecords.
Conditions
Spool reader
3741

RecordLength Choices
RECL givenon control statement

Spool
not active

X

Spool readernot 3741
R E C Lg i v e n

Spool reader R E C L R E C L n o t Active
not supported given given
file

X

X

Lengthof input records

Both the block lengthand the recordlengthparameters
must be specifiedon a tapeOCL FILE statementif one of
t h e f o l l o w i n gc o n d i t i o n se x i s t : ( 1 ) t h e t a p ed o e sn o t h a v ea
standard
l a b e l ,o r ( 2 ) t h e R E E L - B L Pp a r a m e t ei rs s p e c i f i e d .
T h e m i n i m u mp a r t i t i o ns i z ew h e nu s i n gt a p ei s 1 0 K b y t e s
plustwice the tapeblock lengthroundedupwardto the
nearest2K.
Diskfilesusedto copy recordsto the readerqueuecan be
consecutive,
direct,or indexed.The followingchart shows
the access
methodusedbasedon the file organization
and
parameterspecifications.

lnactive Active
file
file

Inactive
file

X

X

Lengthof spool readerrecords

lf recordsare beingcopiedfrom a f ile,the recordlengthof
t h a t f i l e c a n b e a n y v a l u ef r o m 1 t h r o u g h1 2 8 .

RECL not given

X

X

X

File Organization
Parameter
Specifications Consecutive Direct
lndexed
L O R E Co r
H I RE C

Direct
input

Direct
input

lnvalid

KEY,
L O K E Y ,o r
HIKEY

Invalid

Invalid

Indexed
sequential
input
within
l i mi t sI

N o t L O R E C , Consecutive Consecutive lndexed
H IR E C ,
input
input
sequential
KEY,
inputr
L O K E Y ,o r
HIKEY
I

R e q u i r e sa 1 2 K p a r t i t i o n .

The copy function is terminated when two consecutive/.
recordsare read or when end of data (EOD) is detected
from the READERO file and the file is disk or tape. lf the
job being copied to the spool reader queue is not completely copied when the copy reader queue function
t e r m i n a t e s t, h a t i o b i s t a k e n o f f t h e q u e u e .

Spool File Copy Program-$OCOPY

4-193

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued28 September 1979
8y TNI-: cN21-5674

Whenthe output function of COpyRDRO is specified,the
jobstreamrecordsarecopiedfrom the spoolreaderqueue
and placedin a f ile with a recordlengthof 96. lf the
J O B Na n d P A R T I T I O Np a r a m e t e rasr en o t s p e c i f i e da,l l
jobs on the readerqueue(includingthosejobs
available
that arecurrentlyheld)arecopied.
A job cannotbe copiedfrom the readerqueueif any of the
followingconditionsexrsr:
o The job stepis currentlyexecuting.
.

.

The job stepis currentlybeingplacedon the reader
queueor is beingcopiedby the spoolfile copy program
i n a n o t h e rp a r t i t i o n .
The OCOPY-NOparameterwasspecifiedon the JOB
OCL statementfor that job.

Whena job is beingcopiedfrom the readerqueue,that job
appearson a displayof the queuewith an indicationthat
it is beingcopiedby $OCOpy. However,systemcommandsthat normallypertainto that job do not affect it.
lf the output f ile is tape,a defaultblock lengthof g60 (ten
recordsper block) is assumed
unlessa block lengthfor the
f i l e i s s p e c i f i e od n t h e O C L F I L E s t a t e m e n tT. h e m i n i m u m
partitionsizewhenusingtapeis l0K bytesplustwice the
tapeblock lengthroundedupwardto the nearest2K.
WhenREMOVE-YESis specified.jobs arenot removed
from the queueuntil all jobs havebeensuccessfully
copied.
However,jobs are removedfrom the queuebeforethe
next control statementis read. Therefore,jobs being
copiedare not lost if the copy functiondoesnot terminate
normally. But jobs will be lost if $OCOpy is canceled
after the jobs havebeenremoved.
WhenREMOVE-ONLYis specified,jobs are removedfrom
the queuewithout beingcopied. The READEROfile is
not usedfor this function;however,the OUTpUT parameter must be specified.
Commentsare not allowedon the COpyRDROcontrol
statementunlessat leastone parameteris included.
/t/ote.' When input to the readerqueueis from the system
input deviceand a canceloption is takento an error
message,
the JOB statements
and the /. recordsusedto
terminatethe copy readerqueuefunction alsoterminatethe
flushof the systeminput devicethat occursafter the cancel
option. The LOAD, CALL, and /& statements
can also
terminatethe flush if the spoolf ile copy programis
executedwhen the systemis not in job mode.

4-194

ReadControl Statementsfrom a File (COpyCTRL)
T h e C O P Y S PC, O P Y C T R LA
, U T H O R T Z Ea, n dC L A S S t F y
controlstatement$
cannotbe specifiedin the CONTROL
file.
Commentsare not allowedon the COpyCTRL control
statementif thereare no parameters
included.
No more than 254 control statementrecordsareallowedin
the CONTROLfile. The CONTROLfile can be any record
lengthfrom 1 through128.
The COPYCTRL control statementis validonly when the
spoolfile copy programis executedunderthe communicationscontrol program.

Copy a Displayof the Statusof the Spool Oueues
(DISPLAYI
Commentsare not allowedon the DlSpLAy control statement if thereareno parameters
included.
All queues(read,punch,and printl arecopiedif OUTPUTFILE is specifiedand the O-parameter
is not included.The
statusof the readerqueueis copiedfirst, followedby the
print queue,then the punchqueue. Eachqueueis displayed
in its entirety. The first recordis the queueheadingrecord,
which is followedby the queuestatusrecordsand an END
O F O U E U Er e c o r d .
Whenthe priority limit is lessthan 5 for jobs placedon the
activespoolfile readerqueue,a displayof the activespool
file readerqueuecontainsa line at the top of the screen
that indicatesthe priority limit.
T h e p r i n t q u e u ei s d i s p l a y e w
d h e nO U T P U T - T E R M I N AiLs
specifiedand the Q-parameter
is not includedon the
control statement.
WhenOUTPUT-FILEis specified,the recordlengthis 40
bytes. lf the output file is tape,a defaultblock lengthof
400 (ten recordsper block is assumed
unlessa block length
for the file is specifiedon the OCL FILE statement.The
minimumpartitionsizewhen usingtape is 'l0K bytesplus
twice the tapeblock lengthroundedupwardto the nearest
2K.
lf the output file is disk, the f ile can be sharedonly when it
is closed.

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued 28 September 1979
8y TNL: GN21-5674

Whenthe spoolfile copy programis executedunderSCP,
O U T P U T - T E R M I N AiLs i n v a l i da n d t h e d e f a u l ti s O U T P U T .
FILE. Whenthe programis executedunderCCP,OUTPUTT E R MI N A L i s t h e d e f a u l t .
For more informationaboutqueuedisplay,referto the IBM
System/3 Model | 5 User'sGuide to Spooling, GC2l -7632.

Spool File Copy Program-$OCOPY

4-194.1

T h i s p a g ei n t e n t i o n a l l yl e f t b l a n k .

4-194.2

Pageof GC21-5162-1
lssued28 September1979
BvTNL: GN21-5674

RestorePrint or PunchOueueRecordsFrom a File
(RESTORE}
T h e r e s t o r ef u n c t i o n r e q u i r e sa m i n i m u m p a r t i t i o n s i z eo f

12Kbytes.
T h e R E S T O R Ef i l e m u s tb e a d i s ko r t a p ef i l e t h a t w a s
c r e a t e db y e i t h e rt h e C O P Y P R T O
or theCOPYPCHO
funct i o n o f $ O C O P Yw i t h O U T P U T - F I L E
or OUTPUT-ADD
s p e c i if e d .

T h e R E S T O R Ef i l e r e c o r dl e n g t hi s u s e dt o d e t e r m i n e
w h i c hd e v i c et h e r e c o r d si n t h e f i l e a r ef o r . T h e f o l l o w i n g
c h a r ts h o w st h e v a l i di n p u t r e c o r dl e n g t h sa n dt h e a s s o c i a t e d
devices:

Input RecordLength

Output Device

82
83
98
134

1442
2560
5424
1403

l f t h e R E S T O R E f i l e i s a t a p e f i l e a n d t h e t a p e d o e sn o t
c o n t a l n a s t a n d a r dl a b e l o r t h e R E E L - B L P p a r a m e t e ri s
specified,then both the block length and the record length
m u s t b e s p e c i f i e do n t h e O C L F I L E s t a t e m e n tf o r t h e f i l e .
The minimum partition size when using tape is 12K bytes
plus twice th,etape block length rounded upward to the

lf the RESTOREfunction with OUTPUT-PRINTor
O U T P U T - P U N C H i s b e i n g e x e c u t e di n a p a r t i t i o n t h a t i s
b e i n gs p o o l e d ,a n d t h e p r i n t o r p u n c h o u t p u t i s f o r t h e
s a m ep r i n t o r p u n c h d e v i c eb e i n g s p o o l e d ,t h e n t h e r e c o r d s
being printed or punched are intercepted by spool and
p l a c e do n t h e q u e u e a s o n e j o b s t e p , u n d e r t h e j o b n a m e a n d

s t e p n a mues e dw h e nt h e s p o o lf i l e c o p y w a sl o a d e d .
W h e na j o b s t e pi s r e s t o r e d
f r o m a f i l e t o a s p o o lq u e u e
( O U T P U T - S P O O Lt h) ,a t j o b s t e pm u s th a v ea h e a d e r e c o r d .
W h e np l a c e do n t h e q u e u e t, h e j o b s t e pw i l l h a v et h e s a m e
j o b n a m es, t e p n a m ef o, r m st y p e { p r i n t )o r c a r dt y p e
( p u n c h )p, r i o r i t y ,h o l d s t a t u sa, n d k e e ps t a t u sa si t h a d
o r i g i n a l l y .A r e s t o r e dl o b s t e pi s c o n s i d e r etdo b e p a r t o f
the same job as the preceding restored job step only if both
j o b s t e p sh a v et h e s a m ej o b n a m e a n d t h e s a m ep r i o r i t y .
Otherwise, the job step is consideredas a different job.
C o m m e n t sa r e n o t a l l o w e d o n t h e R E S T O R E s t a t e m e n t
u n l e s sa t l e a s to n e p a r a m e t e ri s i n c l u d e d .
Note: lf punch records are being restored from a file to the
, o check is madeto
spoolpunch queue (OUTPUT-SPOOL)n
verify that the punch records are for the same device as the
s p o o l p u n c h d e v i c e ; u n p r e d i c t a b l er e s u l t sc a n o c c u r i f t h e
d e v i c e sa r e n o t t h e s a m e .

Copy SelectedJob Steps From One Spool File to Another
(COPYO)

n e a r e s t2 K .
A j o b s t e p o n a q u e u ec a n n o t b e c o p i e d i f a n y o f t h e f o l l o w i n g c o n d i t i o n se x i s t :

T h e R E S T O f I E f i l e c a n c o n t a i n j o b s t e p st h a t h a v e h e a d e r
records,iob s,tepsthat do not have any header records,or
both job stepr5{[31 have header records and job steps that

o The job step is currently executing.

d o n o t h a v e h e a d e rr e c o r d s . A l s o , p r i n t j o b s t e p sc a n b e
VLR, FLR, or a mix of VLR and FLR steps.

.

Job steps that have header records can be selectively
r e s t o r e db y j o b n a m e ,s t e p n a m e ,a n d f o r m s t y p e ( p r i n t ) o r
c a r d t y p e ( p u n c h ) . A d d i t i o n a l l y , a m e s s a g ei s i s s u e di f
STOP is requestedand the records are being restored to a
s p o o l e dd e v i c ei n a n o n s p o o l e dp a r t i t i o n ( O U T P U T - P R I N T

The job step is being used by spool or copied by the
s p o o l f i l e c o p y p r o g r a m i n a n o t h e rp a r t i t i o n .

o A R E U S E c o m m a n d w a s s p e c i fi e d f o r t h e j o b s t e p .
o A OCOPY-NO parameter is specified on the OCL statem e n t p e r t a i n i n gt o t h e d e s i r e dq u e u e .

or OUTPUT-PUNCH).
Job steps without header records cannot be restored by
j o b n a m e ,s t e p n a m e ,a n d f o r m s t y p e ( p r i n t ) o r c a r d t y p e
( p u n c h ) e v e n t h o u g h t h e s ep a r a m e t e r sa r e s p e c i f i e do n t h e
R E S T O R Es t a t e m e n t . A l s o , n o m e s s a g e
can be issued
between steps,when a forms type changes,or when a card
type changes.

A l l a v a i l a b l ej o b s t e p so n t h e q u e u e ( i n c l u d i n gt h o s e t h a t
are currently held) are copied when COPYO is specified
w i t h o u t a n y o f t h e f o l l o w i n g p a r a m e t e r s :J O B N , S T E P N ,
FORMSNO.CARDNO, PRIORITY. PARITION. When a
j o b s t e p i s b e i n g c o p i e d ,t h a t j o b s t e p a p p e a r so n a d i s p l a y
I of the queue with an indication that it is being copied by

$ O C O P Y .H o w e v e r ,s y s t e mc o m m a n d tsh a t n o r m a l l y
pertainto that job stepdo not affect it.

Spool File Copy Program-$OCOPY

4-195

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: cN21-5674

When the COPYO function is executed under control of the
SCP (system control program), the spool f ile copy program

MAINTAIN THE AUTHORIZ FILE (AUTHORIZE)

can create a new spool file on the main data area designated
on the TO parameter. However, the new spool file is created

T h e A U T H O R I Z E c o n t r o l s t a t e m e n ti s v a l i d o n l y w h e n
the spool file copy program is executed under the system
control program; however, it is not valid in a procedure.

o n l y i f o n e d o e s n o t e x i s t p r i o r t o e x e c u t i n gt h e C O p y O
function undercontrol of the SCp. lf the spoolf ile is
created by $OCOPY, it will be the same size and track group
s i z ea s t h e f i l e s p e c i fi e d o n t h e F R O M p a r a m e t e r .

A u t h o r i z a t i o n i n f o r m a t i o n i s m a i n t a i n e di n a m a i n d a t a
area disk file. The record length of the file is 256 bytes.
E a c h l o g i c a lr e c o r d i n t h e f i l e c o n t a i n s 1 6 a u t h o r i z a t i o n

A new spool file can be created without any jobs on the
queues by specifying a JOBN parameter that does nor exrst
o n t h e s p o o l f i l e s p e c i f i e db y t h e F R O M p a r a m e t e r .

r e c o r d s ,s o t h a t a 1 - t r a c k f i l e w i l l h o l d 7 6 8 p a s s w o r d sa n d
t h e i r a s s o c i a t e da u t h o r i z a t i o ni n f o r m a t i o n . T h e f i l e m u s t
o ; i g i n a l l y b e c r e a t e da s a n e m p t y d i r e c t f i l e . T h i s c a n b e
done with $COPY with the following OCL and control
statements:

l f t h e C O P Y O f u n c t i o n i s e x e c u t e du n d e r c o n t r o l o f t h e
c o m m u n i c a t i o n sc o n t r o l p r o g r a m ( C C p ) ,t h e r e m u s t b e a
spool f ile on the main data area specified by the TO
parameter.
W h e n R E M O V E - Y E S i s s p e c i f i e d j,o b s / j o b s t e p sa r e n o r
removed from the queue until all jobs/job steps have been
successfullycopied. However, jobs/job steps are removed
from the queue before the next control statement is read.
Therefore, jobs/job steps are not lost if the copy function
d o e s n o t t e r m i n a t e n o r m a l l y . B u t j o b s / j o b s t e p sw i l l b e
lost if $OCOPY is canceled after the jobs/job steps have
been removed.
y'y'ofe:When punch queue job
steps are copied from one
spool file to another, $OCOPY does not verifv that the
p u n c h r e c o r d so n e a c h s p o o l f i l e a r e f o r t h e s a m ep u n c n
device;unpredictable resultscan occur if the devicesare not
t h e s a m e . S i m i l a r l y .w h e n r e a d e rq u e u e j o b s a r e c o p i e d
f r o m o n e s p o o l f i l e t o a n o t h e r ,u n p r e d i c t a b l er e s u l t sc a n
occur if the spool reader record length is not the same for
e a c hs p o o l f i l e .

// LOAD$COPY,F1
/ / F I L E N A M E - C O P Y I N , U N I TB E A D E R
. D 1D 1 ,
/ / F I L E N A M E - C O P Y O , U N I T - D 1 , P A C K1
//
//
//
//
//

T R A C K S - 1 , L A BE L - A U T H OR I Z . RE T A I N . P
RUN
C O P Y F I L E O U T P U T . F IL E , L E N G T H . 2 5 6
OUTDM DATAMGMT.DI RECT
END

B e f o r e $ C N F I G i s u s e d t o r e q u i r e$ O C O P Y a u t h o r i z a t i o n ,
a r e c o r ds h o u l d b e p l a c e di n t h e A U T H O R I Z f i l e t h a t c o n t a i n s a p a s s w o r da l l o w i n g a u t h o r i z a t i o nc h a n g e s .F o r
i n f o r m a t i o n c o n c e r n i n gt h e c r e a t i o n o f a n a u t h o r i z a t i o n
record, refer to Create Authorization Record.
A u t h o r i z a t i o n r e c o r d si n t h e f i l e a r e c r e a t e d ,u p d a t e d ,o r
deleted basedon the authorization change recordsthat are
read from the system input device. These records must
follow the AUTHORIZE control statement. (lf $OCOPY
u s e r a u t h o r i z a t i o ni s r e q u i r e di n t h e s y s t e mw h e n t h e
A U T H O R I Z f i l e i s b e i n g c h a n g e d ,a r e c o r d w i t h a p a s s w o r d
i n c o l u m n s 1 t h r o u g h 4 m u s t p r e c e d et h e a u t h o r i z a t i o n
change records in the system input device; the password
m u s t a u t h o r i z ec h a n g e st o t h e A U T H O R l Z f i l e . )
A u t h o r i z a t i o n c h a n g er e c o r d sh a v et h e f o l l o w i n g f o r m a t :

C o l u m n s1 - 4
C o l u m n s5 - 8
C o l u m n 9s - 1 2
C o l u m n s1 3 - 1 6
C o l u m n s1 7 - 2 4
C o l u m n s2 5 - 3 2

4-196

Old password
New password
Old authroizations
New authorizations
Old user lD
New user lD

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: cN21-5674

The old passwordis the password
asit currentlyexists;the
new passwordis what the passwordis to be changedto.
Passwords
mustconsistof four lettersof the alphabet
and/ornumericdigitsin any combination(but not $, #,
@,or any specialcharacters).
W h e na l i s t i n gi s r e q u e s t e(dL I S T - Y E S )t ,h e u s e rl D i s u s e d
to associate
a user(for example,by lastname)with a password. This association
is usedfor informationalpurposes
o n l y a n d i s n o t u s e db y $ O C O p Yi n d e t e r m i n i nw
ghether
a u s e ri s a u t h o r i z e fdo r s p e c i f i cf u n c t i o n s .l f t h i sa s s o c i a t i o n i s n o t d e s i r e dt ,h e o l d a n dn e w u s e rl D f i e l d sm u s tb e
blank.

AuthorizationFields
The authorizations
field indicateswhich functionsof
$OCOPYareauthorizedby the password.Eachposition
o f t h e a u t h o r i z a t i o nf ise l dh a sa s p e c i f i cm e a n i n g W
. ithin
eachpositionthe values0 through7 correspond
with
authorizationfor specificfunctionsof $OCOPY.

Position

I

P o s i t i o n 1 c o n t r o l s t h e a u t h o r i z a t i o nf o r c h a n g i n gt h e
A U T H O R l Z f i l e , t h e a u t h o r i z a t i o nf o r a s s i g n i n g
class
numbers to programs,and the authorization for the various
classesof programs that can be executed in a batch partition. The following chart relatesthese authorizations
w i t h t h e v a l u e s( 0 - 7 ) t h a t c a n b e s p e c i f i e di n p o s i t i o n 1 .

Valuesfor Position1
Functions

0 1 2 3 4 5 6 7

Change
t h e A U T H O R I Zf i l e

N N N N Y Y Y Y

Assignclassnumbersto
programs

N N N N Y Y Y Y

Execute batch programs
o f c l a s s0

Y Y Y Y Y Y Y Y

Execute batch programs
of classes0 and 1

N Y Y Y N Y Y Y

Execute batch programs
of classes0, 1, and 2

N N Y Y N N Y Y

Executebatchprograms
o f c l a s s e0s, 1 , 2 , a n d 3

N N N Y N N N Y

F o r e x a m p l ea, v a l u eo f 2 w i l l a l l o w t h ee x e c u t i o no f b a t c h
p r o g r a misn c l a s s e0s, 1 , a n d 2 ( n o t 3 ) a n dw i l l n o t a l l o w
c h a n g etso t h e A U T H O Rl Z f i l e ,n o r w i l l i t a l l o wt h e
assigning
of classnumbersto programs.A valueof 5 will
allowthe executionof batchprogramsin classes
0 and l
( n o t 2 o r 3 ) . a n d w i l l a l l o wc h a n g etso t h e A U T H O Rl Z
f i l e ,a n dw i l l a l s oa l l o wt h e a s s i g n i nogf c l a s sn u m b e r st o
programs.Executinga batchprogramassumes
the authorizationto placejobs on the readerqueue(seeposition2.
v a l u e s4 . 5 , 6 , a n d 7 ) .

Position 2
Position2 controlsthe authorizationfor access
to the
readerqueue. Authorizationmay be grantedfor copying
jobs from the queue,removingjobsfrom the queue.and/or
copyingjobs to the queue.The followingchart relates
theseauthorizations
with the values(0-7)that can be specif i e d i n p o s i t i o n2 .
Values for
Positions2,3, and 4

Functions

0 1 2 3 4 5 6 7

Copy jobs from the queue

N Y N Y N Y N Y

Removejobs from the queue

N N Y Y N N Y Y

Copy jobs to the queue

N N N N Y Y Y Y

For example, a value of 0 preventsany accessto the reader
queue. A value of 1 allows copying from the queue, but
does not allow removing from the queue or copying to it.
A v a l u e o f 7 a l l o w s c o p y i n g f r o m , r e m o v i n gf r o m , a n d
copying to the queue. (A value of 4 or greatermust be
specified in position 2 when any value (other than 0 or 4)
i s s p e c i fi e d i n p o s i t i o n 1 . )

Spool File Copy Program-$OCOPY

4-196.1

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: cN21-5674

Value in Authorization Field

$OCOPY Control Statements

Program
Position 1
Class o ' 1 2 3 4 5 6 7

Pcition 2
Position 3
12345'67 o 1 2 3 4 5 6 7

// COPYSP

5

q

7

//COPYPBTO (REMOVE-NO}
// COPYPRTO REMOVE-ONLY
// COPYPRTO REMOVE.YES

1

3
2 3

-

5

,

COPYRDRO
COPYRDRO
COPYRDRO
COPYRDRO
COPYRDRO
COPYRDRO
COPYRDRO

(to print queuel
(to punch queue)

//
//
II
//
//
//
//
//
//
/i
//
//

O.WO,(REMOVE.NO)
O.WO.REMOVE.YES
O.PO,(REMOVE-NO)
O-PO,REMOVE-YES
O.RO,(REMOVE.NO)
O-RO,(REMOVE.NO)
O-RO,(REMOVE-NO}
O.RO,(REMOVE-NO}
O-RO,REMOVE-YES
O-RO.REMOVE-YES
O.RO,REMOVE-YES
O-RO,REMOVE-YES

COPYO
COPYO
COPYA
COPYO
COPYO
COPYO
COPYO
COPYO
COPYO
COPYO
COPYO
COPYO

1

3
2 3
J

OUTPUT.FILE/ADD.(REMOVE.NO)
OUTPUT-FILE/ADD,REMOVE-ONLY
OUTPUT.FILE/ADD,REMOVE-YES
(INPUT-FtLE/READER/TERMINAL) o
(INPUT.FILE/READER/TERMINAL} I
(INPUT-FILE/READER/TERMtNAL) z
(INPUT-FILE/READER/TERMINAL)

// RESTORE
// RESTORE

5

1

3
2 3

5

?

o1234567
1 2 3 5 6 7
2 3
6 7
3
7

5
5
5
5

5

7
6 7
I

7
6 7

-

4
4
4
4

7

7
6 7

//COPYPCHO (REMOVE.NO}
//COPYPCHO REMOVE-ONLY
// COPYPCHO REMOVE-YES
//
//
//
//
//
//
//

Pcition 4
,1234567

7

6
6
6
6

7
7
7
7
4567
4567
5

t

7
5 - t
7
0
1
2

o
1
2

o1234567
1 2 3 5 6 7
2 3
6 7
J
7
o1234567
1 2 3 5 67
2 3
6 l
3
7

// AUTHORIZE

4 5 6 7

// CLASSIFY

4567

5

7

q

7

5

7
7
7

Figure 4-94.1. Authorization Function Values for OCOPY Functions

Positions 3 and 4
Position 3 controls the authorization for accessto the
p r i n t q u e u e ,a n d p o s i t i o n 4 c o n t r o l st h e a u t h o r i z a t i o nf o r
accessto the punch queue. The authorizations granted
b y t h e v a l u e s0 t h r o u g h 7 f o r t h e p r i n t a n d p u n c h q u e u e s
are the same as for the reader queue.
A value must be specified in each position of the authori_
z a t i o n f i e l d . F i g u r e4 - 9 4 . 1 c a n b e u s e dt o a s s i s ti n s e l e c t ing the valuesfor each position basedon the functions
y o u w a n t t o a l l o w . W i t h i n e a c h p o s i t i o n ,a n y o f t h e v a l u e s
specified on the chart authorizesthe correspondingcontrol
s t a t e m e n t . ( P o s i t i o n st h a t d o n o t h a v ea v a l u es p e c i fi e d
on the chart are of no consequenceto the specific control
s t a t e m e n ta n d m a y c o n t a i n a n y v a l u e f r o m 0 t h r o u g h 7 . )
4-196.2

F o r e x a m p l e ,a v a l u eo f 1 , 3 , 5 , o r 7 i s r e q u i r e di n p o s i t i o n
3 t o a u t h o r i z e/ / C O P Y P R T OR E M O V E - N O ; t h ea u t h o r i z a t i o n sf i e l d m a y b e c o d e d x x ' l x , x x 3 x , x x 5 x , o r x x 7 x .
T h e 1 , 3 , 5 , a n d 7 v a l u e si n p o s l t i o n 3 e a c h a u t h o r i z eo t h e r
p r i n t q u e u e f u n c t i o n s ;s o t h e r i g h t v a l u e m u s t b e c h o s e n ,
basedon what functions are to be allowed and what other
f u n c t i o n sa r e n o t t o b e a l l o w e d .
T h e / / C O P Y S Ps t a t e m e n tr e q u i r e sv a l u e so f 5 o r 7 i n
p o s i t i o n s2 , 3 , a n d 4 . T h u s , a u t h o r i z a t i o nf i e l d s ( f o r e x a m p l e ,x 5 5 5 , x 5 7 5 , x 7 7 7 l ' a l l a l l o w / / C O P Y S P . ( N o t e
t h a t t h e s ev a l u e sa l s oa l l o w o t h e r f u n c t i o n s t h a t i n v o l v e
copyingto or copying from any spool queue.)

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

CreateAuthorization Record

Commenta
s r en o t a l l o w e do n t h e A U T H O RI Z E c o n t r o l
s t a t e m e nitf t h e r ea r en o p a r a m e t e ri n
scluded.

To createa new authorizationrecordin the file, an authorizationchangerecordthat hasblanksin the old password
f ield must be readin the systeminput device. lf the new
passwordis unique,an authorizationrecordwith the new
p a s s w o r du,s e rl D . a n d a u t h o r i z a t i o ni s p l a c e di n t h e f i l e .

lf $OCOPY(with userauthorizationrequired)is executed
in a batchpartitionasa resultof beingput on the reader
q u e u ef r o m C C P ,f u n c t i o n st h a t w e r en o t a u t h o r i z e u
dn d e r
C C Pa r en o t a l l o w e di n t h e b a t c hp a r t i t i o n .

ChangeAuthorizationRecord

Figure4-94.2showsa samplelistingof the contentsof the
A U T H O Rl Z t i l e .

T o c h a n g ea n a u t h o r i z a t i orne c o r di n t h e f i l e . a n a u t h o r i z a tion changerecordmust be readin the systeminput device
w i t h o l d p a s s w o r do,l d a u t h o r i z a t i o nas n, do l d u s e rl D
f ieldsthat matchthe recordbeingr-rodated
in the f ile. The
recordis updatedwith the new password,
new authorizat i o n s .a n d n e w u s e rl D . P a s s w o r dasu, t h o r i z a t i o nasn, d / o r
u s e rl D s i n a n y c o m b i n a t i o n
c a nb e u p d a t e di n t h i s m a n n e r . l f a p a r t i c u l afri e l d i s n o t t o b e c h a n g e dt ,h e o l d a n d
n e w f i e l d sm u s tm a t c h .

DeleteAuthorizationRecord
T o d e l e t ea n a u t h o r i z a t i orne c o r di n t h e f i l e ,a n a u t h o r i z a tion changerecordmust be readin the systeminput
d e v i c ew i t h o l d p a s s w o r do,l d a u t h o r i z a t i o nasn, do l d
u s e rl D f i e l d st h a t m a t c ht h e r e c o r db e i n gd e l e t e di n t h e
f i l e ;t h e n e w p a s s w o rfdi e l d m u s tb e b l a n k . T h e o l d p a s s w o r d b e c o m eisn v a l i dw h e nt h e a u t h o r i z a t i orne c o r di s
deleted.

A S S I G NA C L A S S N U M B E R T O A P R O G R A M
(CLASSIFY}
T h e C L A S S I F Y s t a t e m e n ti s v a l i d o n l y w h e n t h e s p o o l f i l e
copy program is executed in a batch partition.
I t m a y n o t b e d e s i r a b l ef o r e v e r Vu s e r ( w i t h a u t h o r i z a t i o n
t o p l a c ej o b s o n t h e r e a d e rq u e u e )t o b e a b l e t o e x e c u t e
every program in the system. Program classescan be used
t o r e s t r i c t i n d i v i d u a lu s e r so f $ O C O P Y u n d e r C C p t o o n l y
a s u b s e to f t h e p r o g r a m sb e c a u s eu s e r sc a n e x e c u t eo n l y
t h o s e p r o g r a m si n t h e c l a s s ( e sf)o r w h i c h t h e y a r e a u t h o r i z e d . F o u r p r o g r a mc l a s s e s( 0 t h r o u g h 3 ) a r e a v a i l a b l e .
T h e h i g h e r t h e p r o g r a m c l a s sn u m b e r , t h e h i g h e r t h e
a u t h o r i z a t i o nr e q u i r e dt o e x e c u t et h e p r o g r a m i n t h e b a t c h
p a r t i t i o n . P r o g r a mc l a s sa u t h o r i z a t i o nl e v e l sa r e a t s o
n u m b e r e d0 t h r o u g h 3 . A u s e r c a n e x e c u t ea p r o g r a m i f
t h e c l a s sn u m b e r o f t h e p r o g r a m i s l e s st h a n o r e q u a l t o
t h e a u t h o r i z a t i o nl e v e l o f t h e u s e r .

The end of the authorization change records is indicated
by the next $OCOPY control statement read in the svstem
i n p u t d e v i c e . B e f o r e t h i s s t a t e m e n ti s p r o c e s s e da, l i s t i n g
of the information in the AUTHORIZ f ile is printed on
t h e s y s t e mp r i n t e r i f L I S T - y E S w a s s p e c i f i e do n t h e
AUTHOR IZE control statement.
W h e n a n e r r o r i s d e t e c t e di n a n a u t h o r i z a t i o nc h a n g er e c o r d .
a message
w i t h c a n c e la n d c o n t i n u e o p t i o n s i s d i s p l a y e d
o n t h e s y s t e mc o n s o l e .
A n O C L F I L E s t a t e m e n td e s c r i b i n gt h e a u t h o r i z a t i o nf i l e
( N A M E - A U T H O R I Z ) m u s t b e i n c t u d e di n t h e O C L w h e n
t h e A U T H O R I Z E c o n t r o l s t a t e m e n ti s t o b e u s e d . T h e
file cannot be shared when referencedbv this controt
statement.

Spool File Copy Program-$OCOPY

4-196.3

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

Programclasses
aredefinedin whateverwav bestsuits
the needsof the user. Programs
shouldbe classified
accordi n g l y ,a n d i n d i v i d u aul s e r s h o u l db e a s s i g n eadu t h o r i z a t i o n
levelsthat allow them to executeonly the appropriate
p r o g r a m sT. h e f o l l o w i n gc o n s i d e r a t i o n
s o u l db e
sh
observed:
A u s e r w i t h p r o g r a mc l a s sa u t h o r i z a t i o nl e v e l3 m a y
execute any program in the system.
A program of class0 may be executed by any user who
is authorized to place jobs on the reader queue.
A l l p r o g r a m ss u p p l i e db y I B M ( e a c hr e l e a s ea) n d a l l
p r e v i o u s l yu n c l a s s i fe d p r o g r a m sd e fa u l t t o c l a s s0 .

A c l a s sn u m b e ra s s i g n etdo a n R - m o d u l eh a sn o m e a n i n g
w i t h r e s p e ctto t h a t R - m o d u l e x c e p t h a t t h e c l a s sn u m b e r
i s i r a n s f e r r etdo e v e r yp r o g r a m( O - m o d u l ec)o m p i l e du s i n g
t h a t R - m o d u l eW
. h e na p r o g r a mi s c o m p i l e di,t i s a s s i g n e d
a c l a s sn u m b e re q u a lt o t h e h i g h e sct l a s sn u m b e ro f a l l t h e
R - m o d u l eisn c l u d e dd u r i n gl i n k - e d i t i n gT. h u s .a p r o g r a m
can be assigned
a classnumberthat will be preserved
t h r o u g hr e c o m p i l a t i oinf t h a t c l a s sn u m b e ri s a s s i g n etdo
o n eo f t h e R - m o d u l etso b e i n c l u d e d .
Program
c l a s sn u m b e r sa r ek e p t i n t h e m o d u l ea t t r i b u t e s
i n t h e l i b r a r yd i r e c t o r ya n da r es h o w ni n a $ M A I N T l i s t i n g
of the O-librarydirectory. lSee$MAtNT in Part4 of this
manual.)

4-196.4

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

* E

t+o
4
IJJ II

6
rh
6v)
0VrV)V)V)
6
U O U O U U C I
U c ) U U U U U c ]
> z >- z > > z > z >- > > > t z

/--\
/ @ \
\J,/

UJ
O U

I
g

()=

q
0
6
6 o v ) 0 q
u O c ) O u c ] u O O u u u u u O
> - z z z > z > z z > > >
> - > z

*

@

T -

z u

-6

I \ I
\ : /

o

o

* o

@

u Ou,O

J f F

OO

C )O O O

> z > z z z z z z z > 2

O
E

q o

6

UJOu uO

t t =

r
tf

o
^

\ y

v

+
I
:z

L

A

o
!

d't
* o

o 0 v 1 6 4 0
6 q 6 q 0 q 0 o
U U I . I J U U U O U U U U U U U L !

N

U
cIu

* o
I t F

=

a

.

G
N

a
o
6 A 6 A 6 0 6
c f c ] O O U O U O U T I I U U J U U U

z z z z > z > z

rnq
rh
At
06
O O U O o O O U U C ) u O u u c ]
Z Z > 2 Z Z Z > - > Z > Z
> > Z

z

^
/ o \
\ - , 1

o

J

V

:

=
i

O
P

\_-,/

o

.
n

j
O

- z
c

v

v

O
G

)

^

:

. !

) - o =

f

;

* =
I
U

=
F

* o
d
uuU
l
our
d Q
uJ=

F

'

q

a - o ;

o
.t

6 0 a
6 a q q 6 q q
o
U U U I J U U O + U U U U U J U O

> > > z > z z >

q
0
aorh
v 10
u O O O C O u O u u u O u u O
> z z z z z > z
> > > - z > t =

< t

I

N

\

)

c
O

-c

-.
-c

:

;

L

O

o
E

o
#
r

o
a

,

E
P
a

o
G

o
o

o

y

v

^

U

v

Y

o

o

c

c

'F

'tr

O

G

' N-

'Ni

-c

-c

_
O

o

;

.

O

o
>

i

O

q

a

'F

'

:

N

;

N

=

N

N

J

f

/ d \

< F
r f

a

:

o o

; d N o a z z 4 N d d l i N c ) r

U <

J

- _ _
_
O O C ) O C J O L J - C J O b L J O J a , i

z z z z z z z z z z > z z z z

:

N

\ " ' l

o

F
U
0
=

6
a 4 d e
U U U Z H

: I <
< O O
L ) - <

J O ( 9 O d
H O < J <
= c f 3 c ] t

z

O

o

;

3
-

6

-

G

_c

X

.

^

+

;

Y

r

:

:

^

:

n

E

o ^

-

e

-!

P

o

+
a

x

e
t

o

:
-

o

c

lz
.9

-c

v

J

G

' o O @ o ' F r L ) > E I O U ? l f \ ( J
. f ) < I o \ t @ > o € n u ; z > - o
c F ! F H c c - F n O + e ) I o + c o
@ o - i = E N d I N : Z F c D d o , >

:

N

,

-

lz

6 O
t h d
< O
d 3

f

e

v

^

o

c

a ) 0 ) Z
O H U <
L ) u z : E

,

v

i

.=

e
e u z z
u - C l e

l

O
L J
@
I

^

:
9
P

o
o

c
.F
o
.!

a

'.

/ _ \

=

J
) z
u c )
6 o q ,

=

g

c

u

I
*

I

o

\ : /

ud

F
C )

d

t *
r:)

E
.E

(,o

N

=

c

* O
t + F

z

Z
O

.!

oo
@ooo@

o

=

c
'F

r:

I
uJ
F

(,

)

o

U

€

q)

v
e

_c

Y

O
-

€= x )

H U

It

-o

P

P

v

_c

t r , ^

Y

L

--c
=
v

c

o
a

f

:
-

^

>

J

at

G

9

;

utJ.

t-o
z t

I
F

-*

o

0)

=

:

J

o

)
.t
o

6

x.v

r

0)

f

/. @\

-J
U

g

P
-

r
6

.
a

frE
'-::

::
Y

@

\
=

Rl

t

o
6

$

G
N

'-

o

_c

3 ^
-

o o o oooo
t

F

=

l

t o l

Figure4-94.2. Sample Listingof the AUTHORIZ File
Spool FileCopy Program-$OCOPY

4-196.5

P a s eo f G C 2 1- 5 1 6 2 - 1
l s s u e d 2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

O C LC O N S I D E R A T I O N S
T h e f o l l o w i n gO C L s t a t e m e n tasr er e q u i r e dt o l o a dt h e
$OCOPYsystemserviceprogram:
ll LOAD $OCOPY.cooe
// RUN
The codeyou supplydependson the locationof the simul a t i o na r e ac o n t a i n i n g
t h e s p o o lf i l e c o p y p r o g r a m .p o s s i b l e
c o d e s a rFe1 ,R 1 , F 2 , R 2 .

EXAMPLES
Figure4-95 through 102.2 areexamplesof the OCL statementsand control statements
neededto:
o C o p y a n e n t i r e s p o o l f i l e f r o m d i s k t o m a g n e t i ct a p e
o

P r i n t s e l e c t e dj o b s t e p sf r o m t h e p r i n t q u e u e

.

Punch selectedjob steps from the punch queue

o C o p y a f i l e t o t h e r e a d e rq u e u e
.

Copy selectedjobs from the reader queue

o C o p y a d i s p l a y o f t h e r e a d e rq u e u e t o a f i l e
o

R e s t o r ea p r i n t o r p u n c h q u e u e f i l e t o t h e s p o o l p r i n t o r
punch queue

Copy a job stepfrom one spoolfile to anotherspoolfile
a Change
t h e A U T H O Rl Z f i l e
a A s s i g na c l a s sn u m b e rt o a p r o g r a m

4-196.6

Explanation:
o T h e s p o o lf i l e c o p y p r o g r a mi s l o a d e df r o m F 1 .
o O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e n a m eo f t h e o u t p u t f i l e i s $ S p O O L
(NAME-$SPOOL).
- T h e o u t p u tf i l e i s c o p i e dt o t a p ed r i v e1 ( U N I T - T l
).
- T h e o u t p u tf i l e i s c o p i e dt o a n u n l a b e l e tda p e
( RE EL . NL ) .
- T h e t a p ei s r e w o u n da t E O J( E N D - R E W I N D ) .
a Controlstatement:
- T h e e n t i r es p o o lf i l e i s c o p i e d( C O p y S p ) .
- T h e a r e ac o n t a i n i n g
t h e s p o o lf i l e i s D 4 ( F R O M - D 4 ) .
- The spoolfile is copiedto magnetictape (TO-TApE).
Figure 4-95. OCL and Control Statements to Copy an Entire Spool
File from Disk to Magnetic Tape

Explanation:
o The spool file copy program is loaded from F 1.

o Controlstatement:
- Job stepsarecopiedfrom the print queueof the spool
f i l e( C O P Y P R T O ) .
- T h e a r e ac o n t a i n i n g
t h e s p o o lf i l e i s D 3 ( U N I T - D 3 ) .
- Only thosejob stepson the print queuewith the
j o b n a m eB I L L I N G S( J O B N - BLlL I N G S )s, t e p n a m e
) ,df o r m st y p eA B C
L I S T I N G( S T E P N - L I S T I N G
an
( F O R M S N O - A B Ca)r ec o p i e d .
- T h e o u t p u t i s p r i n t e d( O U T P U T - P R I N T ) .
Figure 4-96. OCL and Control Statements to print Selected Job
Steps from the Print Oueue

Spool File Copy Program-$OCOPY

4-'197

Explanation:
T h e s p o o lf i l e c o p y p r o g r a mi s l o a d e df r o m F 1 .
O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e tsh e f i l e i s P U N C H Q
(NAME-PUNCHO}.
- The output file is containedin the 1442
IUNIT-14421.
a Controlstatement:
- Job stepsarecopiedfrom the punchqueueof the
s p o o lf i l e ( C O P Y P C H O ) .
- T h e a r e ac o n t a i n i n g
t h e s p o o lf i l e i s D 3 ( U N I T - D 3 ) .
- Only thosejob stepswith cardtype )(YZ arepunched
(CARDNO-XYZ}.
- The output is punchedin the sameformat asthat
p u n c h e db y t h e s p o o lp u n c hw r i t e r ( O U T P U T - P U N C H ) .
- lf multiplecopiesarespecified.the numberis reduced
by 1. Otherwise,the job stepis removedfrom the
p u n c hq u e u ea f t e ri t i s c o p i e d( R E M O V E - Y E S ) .
Figure 4-97. OCL and Control Statements to punch Selected Job
Steps from the Punch Oueus

4-198

Explanation:
o T h e s p o o lf i l e c o p y p r o g r a mi s l o a d e df r o m F 1 .
o I n p u t f i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e tsh e i n p u tf i l e i s
lNpUTl
( N A M E - I N P U )T. l
- T h e a r e at h a t c o n t a i n st h e f i l e i s D 1 ( U N I T _ D 1 ) .
lts
n a m ei s D 1 D l D 1( p A C K - D 1 D 1 D t ) .
o Controlstatement:
- Jobsare placedon the spoolfile readerqueue
(COPYRDRO}.
- T h e a r e at h a t c o n t a i n st h e s p o o lf i l e i s D 2 ( U N I T - D 2 ) .
- T h e f i l e n a m e dI N P U T l ( F I L E - l N p U T l c o n t a i n s
)
the
jobs that are placedon the readerqueue.
- The lengthof the recordson the spoolreaderqueue
i s 9 6 b y t e s( R E C L - 9 6 ) .
- The sourceof the recordsis identifiedasa file
(I N P U T . F
ILE).
Figure 4-98. OCL and Control Statements to Copy a File to the
Reader Oueue

Spool File Copy Program-$OCOPY

4-199

Explanation:
o The spoolf ile copy programis loadedfrom F1.
o O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e tsh e f i l e i s R E A D E R O
(NAME-READERO}.
- T h e a r e at h a t c o n t a i n st h e f i l e i s D 1 ( U N I T - D 1 ) .T h e
n a m eo f t h ea r e ai s D l D l D l ( P A C K - D 1 D 1 D 1 ) .
o Controlstatement:
- Jobsarecopiedfrom the spoolfile readerqueue
(OUTPUT-FILE}.
- T h e a r e at h a t c o n t a i n st h e s p o o lf i l e i s D 2 ( U N I T - D 2 ) .
Figure 4-99. OCL and Control Statoments to Copy a File from the
Reader Oueue

Explanation:
o T h e s p o o lf i l e c o p y p r o g r a mi s l o a d e df r o m F 1 .
o O u t p u tf i l e ( O C Ls e q u e n c e ) :
- T h e n a m et h a t i d e n t i f i e tsh e f i l e i s D I S P L A Y O
(NAME-DISPLAYO).
- T h e a r e at h a t c o n t a i n st h e f i l e i s D 2 ( U N I T - D 2 ) .l t s
nameis D2D2D2 (PACK-D2D2D2).
- T h e f i l e o c c u p i e s1 t r a c k ( T R A C K S - 1 ) .
o Controlstatement:
- A displayof the readerqueueis copiedto the output
file(Q-RO).
Figure 4-1OO. OCL and Control Statoments to Copy a Display of
the Reador Queue to a File

4-200

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued28 September 1979
By TNL: GN21-5674

Explanation:
o T h e s p o o l f i l e c o p y p r o g r a m i s l o a d e df r o m F 1 .
I

o

tnout file (OCL sequence):
- T h e n a m e t h a t i d e n t i f i e st h e f i l e i s R E S T O R E
( N A M E . RE S T O R E ) .
- T h e a r e at h a t c o n t a i n st h e f i l e i s D 1 ( U N I T - D 1 ) . T h e
n a m eo f t h e a r e ai s D l D l D l ( P A C K - D 1 D l D 1 ) .

a Control statement:
- T h e p r i n t o r p u n c h q u e u e r e c o r d sc o n t a i n e di n t h e
file are restored to the respectivespool print or punch
q u e u e( R E S T O R E ) .
- T h e s p o o l f i l e t h a t c o n t a i n st h e q u e u e t o w h i c h t h e
recordsare to be restored is located on main data area

D 2( U N I T - D 2 ) .
Figure 4-101. Restore Print or Punch Oueue Records

Explanation:
o T h e s p o o lf i l e c o p y p r o g r a mi s l o a d e df r o m F 1 .
o Control statement:
- T h e j o b s t e p so n t h e p r i n t q u e u e ( O - W Q )a r e c o p i e d
from the spoolf ile on D1 (FROM-Di ) to the print
q u e u eo f t h e s p o o l f i l e o n D 2 ( T O - D 2 ) .
Figure4-102. Copy the PrintQueuefrom OneSpoolFile to
Another

Spool File Copy Program-$OCOPY

4-2O'l

Pageof GC21-5162-1
lssued28 September1979
By TNL; cN2t-5674

Explanation:
o The spoolf ile copy programis loadedfrom F I.
I n p u t a n d u p d a t ef i l e ( O C Ls e q u e n c :e )
- T h e n a m et h a t i d e n t i f i etsh e f i l e i s A U T H O R I Z
(NAME-AUTHORIZ).
- T h e a r e at h a t c o n t a i n st h e f i l e i s D 2 ( U N I T - D 2 ) .
- The nameof the areaisD2D2D2 (pACK-D2D2D2).
Controlstatement:
- The authorizationchangerecordsfollow the control
s t a t e m e n(tA U T H O R I Z E i)n t h e s y s t e mi n p u t d e v i c e
and areusedto changethe AUTHORlZ file.
- A l i s t i n go f t h e c o n t e n t so f t h e A U T H o R I Z f i l e i s
printedon the systemprint devicewhen the changes
t o t h e f i l e a r ec o m p l e t e( L I S T - y E S ) .
Authorizationchangerecords:
- The first record(NP37)is a passwordthat allows
changes
to be madeto the AUTHORlZ f ile.
- The secondrecordcontainsa blank in eachof the
four leftmostcolumnsto indicatethat CSFM is to be
a new passwordin the file. The authorizationcode
associated
with the passwordis 1700 andthe user
l D i sJ O N E S .
- The third recordindicatesthat the password(56MW)
in the file is to be changedto LCK7. The authorizat i o n c o d e( 2 7 7 7 1 a n dt h e u s e rl D ( S M I T H )s t a yt h e
same.
- The fourth recordcontainsa blank in eachof the
5, 6, 7, and 8 positionsto indicatethat the password
(OPH0)is to be deletedfrom the file.
F i g u r e 4 - 1 0 2 . 1 . C h a n g et h e A U T H O R I Z F i t e

4-202

Pageof GC21 -5162-1
lssued 28 September 1979
By TNL: GN21'5674

Explanation:
The spoolfile copy programis loadedfrom F1.
Controlstatement:
- T h e p r o g r a mP A Y R O L( P R O G R A M - P A Y R O iLs)t o
be assigned
a classnumber.
- The PAYROL programis in the O library($OCOPY
a s s u m et sh e L I B R A R Y - Od e f a u l t ) .T h e O l i b r a r y
i s i n s i m u l a t i oanr e aR 2 ( U N I T - R 2 ) .
- The PAYROL programis to be assigned
classnumber
3 (CLASS-3).
- T h e n a m eo f t h e s i m u l a t i o n
a r e ao n R 2 i s R 2 R 2 R 2
(PACK-R2R2R2),
Figurc 4-1O2.2. Assign a Class Number to e Program

U S I N GT H E S P O O LF I L E C O P YP R O G R A MU N D E RC C P
The systemcannotexecutethe spoolfile copy program
underCCPwith the name$OCOPY. Usethe library
program($MAINT) or the rename$OCOPY
maintenance
prompt duringsystemgeneration
to changethe program
nameso that the first characteris not a dollarsign($).
lf $OCOPYis to be executedunderCCP,the renamed
modulesmust resideon the CCPprogrampack.
Whenthe spoolfile copy programis executedasa CCP
task,the filesaccessed
for the variousfunctions{for
e x a m p l et,h e c o n t r o lf i l e .d i s p l a yq u e u ef i l e ,p r i n t q u e u e
file, readerqueuefile, restorefile, and the punchqueuefile)
m u s tb e d i s kf i l e s

Spoof File Copy Program-$OCOPY

4'2O2|l

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued28 September ,|979
By TNL: GN21-5674

, nd
O u t p u tf i l e s( D I S P L A Y OP. R t N T O .p U N C H O a
READERO)can be accessed
eitherasconsecutive
output or
asconsecutive
add. lf accessed
asconsecutive
add,the
filescan be sharedbetweenbatchand CCppartitionswhen
the filesareclosedinsteadof havingto wait until CCp is
shutdown. The consecutive
add access
appears
to be
consecutive
output because
the recordsareaddedfrom the
beginningof the f ile. lf it is desirable
to add recordsfrom
the logicalend of the file, ratherthan from the beginningof
the file. OUTPUT-ADDcan be specifiedon the appropriate
controlstatement.The add access
from the beginningof
the file will not causeany messages
to be issuedthat warn
o f o v e r l a y i negx i s t i n gr e c o r d si n t h e f i l e d u r i n gC C ps t a r t - u p .
Certainfunctionsof the spoolfile copy programrequire
morethan 10K bytesof main storage.(SeeFigure4-94tor
the storagerequirements
of the variousfunctions.)The
T A S K S I Z Ep a r a m e t eorf t h e P R O G R A Ms t a t e m e ni tn t h e
CCPassignment
set must be usedto specifythe required
storagesizewhen it exceeds10K. For a descriptionof the
TASKSIZE parameter.refer to the IBM System/3Model lS
CommunicationsControl Program SystemReference
Manual, cC21-7620.

Whenrequested
underCCPfrom the systemconsoleor
f r o m a t e r m i n atl h a t i s n e i t h e ra 3 2 7 8M o d e lI o r 2 , n o r a
3277 Model 1 or 2, the spoolcopy programreadscontrol
statements
only from a file. The nameof that file may be
givenasthe first field of datawith the programrequesr.
l f a f i l e n a m ei s n o t s u p p l i e da, d e f a u l tn a m eo f C O N T R O L
i sa s s u m e d .
The following functions of the spool file copy program are
not supported when requestedunder CCp from the system
console or f rom a terminal that is not a 3275 or a 3277:
o D i s p l a y i n gt h e s p o o l q u e u e st o t h e r e q u e s t i n gt e r m i n a l .
o Entering jobs onto the reader queue from the requesting
terminal.
o

lssuingmessagesto the requestingterminal. These
messages
will go instead to the system console.

For a complete list of terminals supported by CCp, refer to
the IBM System/3 Model | 5 Communications Control
Program System Reference Manual, GC21-7620.

ProgramRequest
UserAuthorization
Whenthe spoolf ile copy programis requested
underCCp.
datamay be suppliedwith the programrequest.A maximum of two fields,separated
by a comma,can be entered.
The f irst field of data is the nameof a file from which the
control statements
for the spoolfile copy programwill be
read. lf this field is entered,the lengthof the file name
can be from 1 through8 characters.A FILE starement
with that namemust be includedin the CCp startupOCL.
The secondfield of data is a 4-character
passwordthat
grantsthe userauthorizationfor variousfunctionsof the
spoolfile copy program.The passwordis requiredif the
configurationrecordprogramoption is in effect requiring
$OCOPYuserauthorization.(See$CNFIG in part 4 of
this manual.)The followingexamplesof programrequest
showhow the fieldsof programdata must be enterect:
OCOPY

No passwordand no
C O N T R O Lf i l e n a m eg i v e n .
O C O P Yf i l e n a m e
C O N T R O Lf i l e n a m eg i v e n
with no password.
OCOPY,pswd
Password
givenwith no
C O N T R O Lf i l e n a m e .
O C O P Yf i l e n a m e , p s w d C O N T R O Lf i l e n a m eg i v e n
with password.

4-202.2

l f t h e $ O C O P Yu s e ra u t h o r i z a t i oonp t i o no f $ C N F I Gi s
in effect,authorizationis requiredfor the useof the spool
file copy programunderCCP. The functionsthat $OCOpy
can performareassociated
with the password
entered
with the programrequest.Authorizationcan be granted
for the followingfunctions:
o Requestthe spoolfile copy programunderCCP.
o Accessthe readerqueueunderCCP.
.

Accessthe print queueunderCCP.

o Accessthe punchqueueunderCCP.
.

Changethe $OCOPYauthorizations
and assignclass
numbersto programs.

Paseof GC21-5162-1
lssued28 September
1979
ByTNL: GN21-5674
Authorization for accessto each queue is further granted
for the following functions:
o Copy jobs and/or job stepsto the queue.

Copy jobsand/orjob stepsfrom the queue.

The screenis alwayserasedfor the followingconditions:
o The first write to the screenafter the spoolfile copy
programis loaded
o G o i n gt o a n d f r o m E N T E RR D R OD A T A m o d e
( / / C O P Y R D R OI N P U T . T R
EMINAL)

Removejobs and/orjob stepsfrom the queue.
o D u r i n gD I S P L A Ym o d e( l l D I S P L A Y )
Authorizationfor copyingjobs onto the readerqueueis
further grantedfor the purposeof executingdifferent
classes
of programsin the batchpartition. A programcannot be executedif it is classified
higherthan the program
classauthorizationlevelassociated
with the password
that wasgivenwith the programrequest.
P a s s w o r dasr em a i n t a i n e idn t h e A U T H O R I Zf i l e . W h e n
the spoolf ile copy programis first loadedunderCCP,
this f ile is openedwith a directSet(DG) access
and is
searched
for the passwordgivenin the programrequest
data. lf the passwordis not found in the file, the useris
not authorizedto requestthe spoolf ile copy program. lf
the passwordis found, the authorizationinformation
associated
with it is usedto verify that the useris authorizedfor the requested
functions. Any time the userattemptsto executean unauthorized
function,the spool
f i l e c o p y p r o g r a mt e r m i n a t ew
s i t h a c o d e4 1 . A n O C L
F I L E s t a t e m e nwt i t h N A M E - A U T H O R I Zm u s tb e s p e c i f i e d
in the startupOCL for CCPif $OCOPYuserauthorization
isrequired.

Usingthe Spool File Copy Programfrom a Terminal

When the spool file copy program is requestedunder CCP
from a 3275 or a3277 terminaland a file name issupplied
in the f irst field of program data, control statementsare
read from that file. The requestingterminal can be used
f o r d i s p l a y i n gt h e q u e u e s ,e n t e r i n gj o b s o n t h e r e a d e rq u e u e ,
or issuingmessages.Control statementswill not be read
f r o m t h e t e r m i n a l u n l e s st h e r e a d i n go f t h e C O N T R O L
f ile is terminated by a control statement error. Otherwise,
w h e n a n E N D s t a t e m e n ti s r e a d f r o m t h e f i l e o r w h e n e n d
of file is detected, the spool file copy program goesro
end of job.
When the spool file copy program is requestedfrom a3275,
o r a 3 2 7 7 t e r m i n a l a n d n o c o n t r o l f i l e n a m e i s s p e c i f i e di n
t h e f i r s t f i e l d o f p r o g r a md a t a , t h e U O S P C S E N T E R
C O N T R O L S T A T E M E N T m e s s a g ei s s e n t t o t h e t e r m i n a l
and the cursoris set to position 1 of line 1. The terminal
operator then keys the program control statement into
the first 80 positions. The format of the control statements and the rules of continuation are the same as prev i o u s l y d e s c r i b e di n t h i s m a n u a l . T h e E N T E R k e y o n t h e
terminal is pressedto complete the entry of the program
control statement. The control statement is then logged
in the system history area.

Whenrequested
from a 3275 or 3277 terminal,the spool
file copy programerases
the screenfor eachmessage.
An
option of the configurationrecordprogram(see$CNFIG
in Part 4 of this manual)causes
the screento not be erased
f o r t h e f o l l o w i n gf u n c t i o n s :
Promptingfor control statements
D i a g n o s i negr r o r s
Promptingfor datato be enteredon the readerqueue

Spool File Copy Program-$OCOPY

4-202.3

T h i s p a g ei n t e n t i o n a l l V
left blank.

4-202.4

P a g eo f G C 2 1 - 5 1 6 2 - l
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN2l-5674

Respondingto Error Messages

PlacingJobson the ReaderOueuefrom a Terminal

The spoolfile copy programdiagnoses
errorsin control
statements
aswell aserror conditionswhich may occur
duringthe executionof the program.

The spoolfile copy programallowsthe terminaloperatorto
key OCL or data onto the spoolreaderqueue. When
I N P U T - T E R M I N Ai sLs p e c i f i eodn t h e C O P Y R D R O
controlstatement,the programsendsthe UO SP RO
E N T E RR D R O D A T A m e s s a gt e
o t h e t e r m i n aal n dp o s i t i o n st h e c u r s o rt o l i n e 1 . T h e t e r m i n aol p e r a t o cr a nt h e n
key an 8o-byteOCL or datastatement.The terminal
operatorthen presses
the ENTER key to enterthe statement into the system.Jobsareplacedon the readerqueue
i n a m a n n e rs i m i l a rt o t h a t o f t h e s p o o lr e a d e r .

lf an error is found in a control statement,the
U O S P X X C O N T R O LS T A T E M E N TE R R O Rm e s s a gi e
s
issuedto the terminal. The response
to this message
is to
correctand reenterthe control statement.No option is
required.
lf an error occursduringexecutionof the program,the
U O S P X X E N T E RR E C O V E R YO P T I O NY Y Y Y m e s s a g e
is issuedto the terminalfor which the spoolfile copy
programis executing.The XX indicatesthe kind of error.
The YYYY indicatesthe allowableoptionsto the message.
The followingarethe allowableoptionsto messages
and
t h e i rm e a n i n g :
Option

Meaning

0

Closethe function (andthe associated
files)and processthe next control
statement

1

Retry the function

2

Closethe function (andthe associated
f i l e s )a n de x i t t o e n d - o f - j o b

function,two
To terminatethe copy-to-reader-queue
consecutive
are required.
/. statements

Displayingthe SpoolOueues
Whenthe spoolfile copy programis p,arfer.pllnn
the display
f u n c t i o n ,t h e d i s p l a yc a n b e d i r e c t e dt o t h e t e r m i n a l
( O U T P U T - T E R M I N A Lt h) a t m a d et h e p r o g r a mr e q u e s t .
T h e d i s p l a yb e g i n so n l i n e3 o f a M o d e l1 t e r m i n aal n d o n
l i n e2 o f a M o d e l2 t e r m i n a l .T e n l i n e sa r ed i s p l a y e idn c l u d i n gt h e h e a d i n gl i n e . T h e f o r m a to f t h i s d i s p l a yi s t h e s a m e
a st h a t a v a i l a b lteo t h e s y s t e mo p e r a t o w
r h e nt h e D I S P L A Y
s p o o lq u e u ec o m m a n di s e n t e r e d .T h i sd i s p l a ys h o w st h e
statusof the spoolqueues,not the dal:aon the spoolqueues.

( c l o s et h e
lmmediate xit to end-of-job
associated
files)
The error messages
aredisplayedon the screen.Whena
message
requiresa decisionor action,you respondvia the
keyboardby enteringthe option desiredand then pressing
t h e E N T E Rk e y .
The message
lD (UO SP XX) which identifiesthe error that
in the IBM SystemRModel 15 System
is
described
occurred,
Messages,
GC21-5076and the IBM System/3CommunicaManual, GC21-5170.
tions Control Program Messages

Spool File Copy Prc,gram-$OCOPY

4-203

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued28 September
1979
ByTNL: cN21-5674
T h e u s e r c a n e n t e r t h e f o l l o w i n g c h a r a c t e r ss t a r t i n gi n l i n e 1
position 1 to alterthe display:
Terminal
Operator
Keys

Resulting Display

For6

P r e s s i n gt h e F c h a r a c t e rk e y a n d t h e E N T E R
k e y , o r t h e E N T E R k e y a l o n e c a u s e st h e d i s p l a y
t o p a g ef o r w a r d i f t h e r e a r e a d d i t i o n a ls t e p so n
t h e q u e u e . T e n n e w l i n e sa r e d i s p l a y e di n c l u d i n g t h e h e a d i n g . T h e d i s p l a yc a n b e p a g e d
forward until the end of the queueis reached.
A r e s p o n s ea t t h i s t i m e r e s t a r t st h e d i s p l a y a t
t h e b e g i n n i n go f t h e q u e u e . l f t h e j o b s t e p
d i s p l a y e do n t h e l a s t l i n e o f t h e c u r r e n t d i s p l a y
i s a l t e r e dt h r o u g h a C H A N G E c o m m a n d o r i t s
p o s i t i o n o n t h e q u e u e i s c h a n g e dw h i l e i t i s
b e i n gd i s p l a y e d ,t h e n t h e d i s p l a y i s r e s t a r t e da t
t h e b e g i n n i n go f t h e q u e u e e v e n t h o u g h a f o r ward responsewas keyed. This is done so that
t h e q u e u e p o i n t e r sc a n b e r e e s t a b l i s h e b
dy t h e
spool f ile copy program.

Fnn

T h e F c h a r a c t e ra l o n g w i t h a d e c i m a l n u m b e r
c a u s e st h e d i s p l a y o f t h e q u e u e t o b e p a g e d
f o r w a r d t h e n u m b e r o f p o s i t i o n si n d i c a t e db y
n n . T h e d e c i m a ln u m b e r c a n b e a v a l u eo f 1
t h r o u g h 9 9 . l f p a g i n gf o r w a r d e x c e e d st h e e n d
o f t h e q u e u e ,t h e E N D O F O U E U E m e s s a g ei s
d i s p l a y e da n d a f o r w a r d r e s p o n s ea t t h i s t i m e
r e s t a r t st h e d i s p l a y f r o m t h e b e g i n n i n go f t h e
q u e u e . T h e q u e u e d i s p l a yc a n a l s o b e r e s t a r t e d
f r o m t h e b e g i n n i n ga s p r e v i o u s l yd e s c r i b e d
(under F or 6) if the job stepon the lastline of

CCPAssignment
Set
T h e f o l l o w i n gs t a t e m e n tcso u l db e p r o v i d e di n t h e C C P
assignment
set. The exactstatements
that you usedepends
o n h o w y o u i m p l e m e ntth e s p o o lf i l e c o p y p r o g r a mu n d e r
CCP.
/ / T E R M A T T R 1 A T T Rl D - 0 4 , B L K L - n n n .
DATAFORM.MESSAGE
| // SYMFTLE'?

N A M E C O N T R O L , D I S KLFEI - ' n a m e s
o f f i l e st o b e u s e df o r C O N T R O Lf i l e ;
t h e y m u s tb e d e f i n e di n F I L E s t a t e m e n t sd u r i n gC C PS T A R T U P '

// SYMFILE2

N A ME - RE A D ER O , DI S K FI L E - ' n a m e s
o f f i l e st o b e u s e df o r R E A D E R Of i l e ;
t h e y m u s tb e d e fi n e di n F I L E s t a t e m e n t sd u r i n gC C PS T A R T U P '

/ / S Y M FI L E 2

N A ME - P RI N T O , DI S K FI L E - ' n a m eosf
f i l e st o b e u s e df o r P RI N T Of i l e ;t h e y
m u s tb e d e f i n e di n F I L E s t a t e m e n t s
d u r i n gC C PS T A R T U P '

/ / S Y M FI L E 2

N A ME - P U N C H O I. S
DK FI L E - ' n a m eosf
f i l e st o b e u s e df o r P U N C H Of i l e ; t h e y
m u s tb e d e f i n e di n F I L E s t a t e m e n t s
d u r i n sC C PS T A R T U P '

// SYMFILE2

N A ME D I S P L A Y O , IDS K FI L E - ' n a m e s
o f f i l e st o b e u s e df o r D I S P L A Y Qf i l e ;
t h e v m u s t b e d e f i n e di n F I L E s t a t e m e n t sd u r i n gC C PS T A R T U P '

t h e d i s p l a y i s a l t e r e dd u r i n g t h e d i s p l a y .

C

T h i s c h a r a c t e rc a u s e st h e d i s p l a y f u n c t i o n t o b e
t e r mi n a t e d .

WQ

These two characterscausethe reader queue
s t a t u st o b e d i s p l a y e d .

RO

These two characterscause the reader oueue
s t a t u st o b e d i s p l a y e d .

PO

T h e s et w o c h a r a c t e r sc a u s et h e p u n c h q u e u e
s t a t u st o b e d i s p l a y e d .

I END

I

4-204

T h e s et h r e e c h a r a c t e r sc a u s et h e s p o o l f i l e
c o p y p r o g r a mt o t e r m i n a t e .

'The

T E R M A T T R B L K L p a r a m e t e rm u s t b e a m i n i m u m o f g 1 7 .
T h e T E R M A T T R A T T R T D p a r a m e t e rm u s t b e 0 4 ( A T T R I D - 0 4 )
a n d b e n o n - D F F . T h e T E R M A T T R D A T A F O R M p a r a m e t e rm u s t
b e M E S S A GE { D A T A F O R M - M E S S A G E ) .
2Th"
S Y M F I L E s t a t e m e n t sa r e n o t r e q u i r e di f t h e p R O G R A M s t a t e m e n t l i s t s a l l f i l e n a m e st h a t w i l l b e r e f e r e n c e db y t h e s p o o l f i l e
c o p y p r o g r a m . T h e s p e c i f i c f i l e t o b e u s e d c a n t h e n b e s p e c i f i e do n
t h e F l L E p a r a m e t e ro f t h e s p o o l f i l e c o p y p r o g r a m c o n t r o l s t a t e m e n t . l f S Y M F I L E s t a t e m e n t sa r e n o t u s e d a n d c o n s e c u t i v eo u t o u t
f i l e s a r e l i s t e d i n t h e P R O G R A M s t a t e m e n t ,t h e n o n l y o n e c o p y o f
the spool file copy program can be loadedunder CCp at a time. A
FILE TEMPORARILY UNAVAILABLE message
i s i s s u e di f
a d d i t i o n a l p r o g r a m r e q u e s t sf o r O C O P Y a r e e n c o u n t e r e dw h i l e
OCOPY is executingunder CCP.
Note: lf the spool file copy program is to be loadedfrom a pacK
other than the systempack, you must first usethe copy function of
t h e l i b r a r y m a i n t e n a n c ep r o g r a m ( $ M A I N T ) t o c o p y a l l m o d u l e s
startingwith $OC (NAME-$OC.ALL) to the obiect tibrary of that
p a c k . T h e d a t a m a n a g e m e n tm o d u l e s i n c l u d e d b y t h e s p o o l f i l e
copy program must be located on either the program pack or the
s y s t e mp a c k .

P a s eo f G C 2 1 - 5 1 6 2 - 1
'1979
lssued28 September
Bv TNL: GN21-5674

// SYMFILEI

// PROGRAM,

N A M ER
- ESTOR
E , DI S K FI L E - ' n a m e s
o f f i l e st o b e u s e df o r R E S T O R Ef i l e ;
t h e y m u s tb e d e f i n e di n F I L E s t a t e m e n t sd u r i n gC C PS T A R T U P '
N A ME- O C O P Y , P GDMA T A . Y E S ,
FILES.'CONTROL/CGi
RE A D ER O / C G :P RI N T O / C O I
P UN C HO / C O ?Or S pU V O I C O I
RE S T ORE / C G , A U T H OI R
Z l D G'
P A C KS Y S T E M , T A S K S I Z
1E
26

How to Request$OCOPYFrom a Terminal
T o e x e c u t et h e s p o o lf i l e c o p y p r o g r a mu n d e rC C Pf o r t h e
p r e c e d i nags s i g n m e n
se
t ts t a t e m e n t(si f s y m b o l i cf i l e sa r e
l p e r a t om
r u s te n t e rt h e f o l l o w i n g
u s e d )t,h e t e r m i n a o
statements:
/ FI L E
/ FI L E
/ FI L E
/ FI L E
/ FI L E
/ FI L E

C O N T R O L , n a moef t h e f i l e g i v e ni n t h e
C O N T R O LS Y MF I L E s t a t e m e n t
R E A D E R O , n a moef t h e f i l e g i v e ni n t h e
R E A D E R OS Y M FI L E s t a t e m e n t
P R l N T O , n a moef t h e f i l e g i v e ni n t h e
P R I N T QS Y M F L
I Estatement
P U N C H O , n a moef t h e f i l e g i v e ni n t h e
P U N C H QS Y MF I L E s t a t e m e n t
D l S P L A Y O , n a moef t h e f i l e g i v e ni n t h e
D I S P L A Y OS Y M FI L E s t a t e m e n t
R E S T O R E , n a moef t h e f i l e g i v e ni n t h e
E S Y M FI L E s t a t e m e n t
RESTOR

OCOPY

'The

S Y M F I L E s t a t e m e n t sa r e n o t r e q u i r e di f t h e P R O G R A M s t a t e m e n t l i s t s a l l f i l e n a m e st h a t w i l l b e r e f e r e n c e db y t h e s p o o l f i l e
c o p y p r o g r a m . T h e s p e c i f i cf i l e t o b e u s e dc a n t h e n b e s p e c i f i e do n
t h e F I L E p a r a m e t e ro f t h e s p o o l f i l e c o p y p r o g r a m c o n t r o l s t a t e -

m e n t . l f S Y M F I L E s t a t e m e n t sa r e n o t u s e da n d c o n s e c u t i v e
output
f i l e sa r e l i s t e di n t h e P R O G R A M s t a t e m e n t t, h e n o n l y o n e c o p y o f
the spool file copy program can be loadedunder CCPat a time. A
F I L E T E M P O R A R I L Y U N A V A I L A B L E m e s s a g ies i s s u e di f
a d d i t i o n a l p r o g r a m r e q u e s t sf o r O C O P Y a r e e n c o u n t e r e dw h i l e
O C O P Y i s e x e c u t i n gu n d e r C C P .
2CCP
d o " , n o t a l l o w a p r o g r a m r e q u e s to f a $ x x x x x p r o g r a m f r o m a
t e r m i n a l . T o e x e c u t eu n d e r C C P ,t h e s p o o l f i l e c o p y p r o g r a m m u s t
b e r e n a m e dt o a n a m e ( O C O P Y f o r e x a m p l e ) t h a t d o e s n o t b e g i n
a d o l l a rs i g n ( $ ) .
.with
" T h e f i l e s a c c e s s e da s C O ( c o n s e c u t i v eo u t p u t ) c a n a l s o b e a c c e s s e d
a s C A ( c o n s e c u t i v ea d d ) . T h i s a l l o w s t h e a d d i n g o f r e c o r d st o t h e
n d o f t h e f i l e a s w e l l a s s h a r i n go f t h e f i l e a f t e r i t i s c l o s e d .
l oO
gN
i cTaR
le O
*. C
L/CG
c a n a l s ob e C O N T R O L / D G .
5RTADERO/CG
, EADERO/DG,
c a n a l s ob e R E A D E R O / C O R
_R E A D E R O / l S ,o r R E A D E R O / l S L .
" T h e T A S K S I Z E p a r a m e t e rm u s t b e s p e c i f i e dw h e n t h e f u n c t i o n
r e q u i r e sm o r e t h a n 1 0 K b y t e s .
Note: ll the spool file copy program is to be loadedtrom a pack
o t h e r t h a n t h e s y s t e mp a c k ,y o u m u s t f i r s t u s et h e c o p y f u n c t i o n o f
t h e l i b r a r y m a i n t e n a n c ep r o g r a m( $ M A I N T ) t o c o p y a l l m o d u l e s
s t a r t i n gw i t h $ O C ( N A M E - $ O C . A L L )t o t h e o b j e c t l i b r a r y o f t h a t
p a c k . T h e d a t a m a n a g e m e n tm o d u l e s i n c l u d e d b y t h e s p o o l f i l e
c o p y p r o g r a m m u s t b e l o c a t e do n e i t h e r t h e p r o g r a m p a c k o r t h e
s y s t e mp a c k .

Spool File Copy Program-$OCOPY

4-205

Pageof GC21-5162-1
lssued28 September1979
ByTNL: GN21-5674
Examples

Terminal Operator Keys

MessageReturned

The following example shows the statementsthat the
terminal operator keys to place the job named FIRST on
the spool reader queue (the symbolic files were previously

II COPY FROM.Fl,TO.PRINT,
LIBRARY-ALL,NAME-DIR

UO SP RO ENTER
RDRO DATA

g i v e ni n t h e a s s i g n m e sn et t ) .

i/ END

UO SP RQ ENTER
RDRO DATA

/.

UO SP RO ENTER
RDRO DATA

I.

UO SP CS ENTER
CONTROL
STATEMENT

TerminalOperatorKeys

Message
Returned

/ FIL E C O N T R O L , C O N T R O L l A C C E P T E D
PROCEED
/ F I L ER E A D E R O , R D R F L l

ACCEPTED
PROCEED

/ F I L EP R I N T O , P R T F L I

ACCEPTED
PROCEED

/FILEPUNCHO,PCHFLl

ACCEPTED
PROCEED

/FILEDISPLAYO,DSYFLl

ACCEPTED
PROCEED

/FILE RESTORE,REST1

A C C E P T E DP R O C E E D

OCOPY ,pswd

U O S PC S E N T E R
C O N T R O LS T A T E M E N T Considerationsfor Terminating the Spool File Copy

/ / E N D i f a d d i t i o n a l$ O C O P Y f u n c t i o n s a r e r e q u i r e d ,
they can be given here before you specify END.
Multiple copies of the spool file copy program can execute
concurrently under CCP and/or in batch partitions.

Program under CCP

/ / C O P Y R D R OU N I T . D 2 ,
R E C L . 9 6I,N P U T . T E R M I N A LU O S PR O E N T E R
R D R OD A T A

U O S PR O E N T E R
R D R OD A T A

T h e v a r i o u sc o m b i n a t i o n so f c o n t r o l s t a t e m e n tc o n d i t i o n s
a n d t h e o p e r a t i n gm o d e d e t e r m i n ew h e t h e r t h e s p o o l f i l e
copy program will terminate when its functions are complete
or will read additional control statementsf rom the requesti n g t e r m i n a l . T h e f o l l o w i n g r u l e sa p p l y t o t h e s ec o n d i t i o n s
and operating modes:

/ / L O A D$ M A I N T , F 1

U O S PR O E N T E R
R D R OD A T A

o The spool file copy program terminates whenever an END
statement is read.

// RUN

U O S PR O E N T E R
R D R OD A T A

o

/ / F I R S TJ O B P A R T I T I O N - D ,

coRE.12

lf end of file is receivedwhen the spool file copy program
i s r e a d i n gf r o m a C O N T R O L f i l e , t h e p r o g r a m t e r m i n a t e s
unlessthe reading of the f ile was initiated by a
COPYCTR L statement read from the terminal.

o When a control statement error is detected, the next
control statement is read from the requestingterminal;
the spool file copy program terminates if the control
statement was not requestedfrom a 3275 or a3277
t e r mi n a l .

4-206

T h e f o l l o w i n gt a b l ep r o v i d e sa s u m m a r v :

Operatingmode
Readingcontrol statementsfrom a file
$OCOPYhasa 3275 or a 3277 terminal
Control statement
conditions
END statement

Readingcontrol
statementsfrom the
requesting
terminal

$OCOPYdoesnot
havea 3275 or a
3277 tetminal

ReadingCONTROL
file via program
request

Reading
CONTROL
file via COPYCTRL

A

A

A

A

EOF receivedwhile
readingcontrol file
Controlstatementerror

A
A

Legend:
A-Go to EJ
B-Read next control starementfrom the requestingterminal
X-lnvalidcondition

Spool File Copy Program-$OCOPY

4-207

Recover Index Program-$RINDX
P R O G R A MD E S C R I P T I O N
The recoverindex programrecovers
addedrecorosto an
i n d e x e df i l e .
The recoverindex programis usedto recoverthe records
a d d e dt o a n i n d e x e df i l e i f , f o r a n y r e a s o nt,h e p r o g r a m
addingthe recordsis terminatedbeforeend of joo.
The recoverindex programshouldbe executedassoonas
p o s s i b laef t e rt h e a b n o r m atle r m i n a t i o n .
The functions of the recover index program for each file
o r g a n i z a t i o na r e :
I n d e x e df i l e
- lf addedkeysexist for the file when the
abnormal
t e r m i n a t i o n o c c u r s ,$ R I N D X u p d a t e st h e e n d - o f - i n d e x
a n d e n d - o f - d a t ap o i n t e r s . F i l e i n f o r m a t i o n - d e f i n e d
a s f i l e l a b e l ,f i l e t y p e , p a c k l a b e l ,a n d f i l e d a t e - i s
printed. The lastadded key for this file is also
printed.
- lf keys has not been added when the abnormal
termin a t i o n o c c u r r e d ,o n l y t h e f i l e i n f o r m a t i o n i s p r i n t e d .
C o n s e c u t i v ef i l e l
- lI a consecutive file is detected, only the file
information is printed.
Direct filel
- ll a direct file is detected, only the file information
is printed.
l f t h e r e c o v e ri n d e x p r o g r a mc a n n o t f i n d t h e f i l e i d e n t i f i e d b y t h e O C L F I L E s t a t e m e n t ,t h e f i l e i n f o r m a t i o n
a n d t h e F I L E N O T A V A I L A B L E m e s s a g ei s p r i n t e d .

t

Yo,
u s e t h e f i l e r e c o v e r y f r o m p h y s i c a la d d r e s sf u n c t i o n o f t h e
c o p y"/ u
dn
u m p p r o g r a m ( $ C O P Y ) t o r e c o v e rc o n s e c u t i v eo r d i r e c t f i l e s
if an abnormal termination occurswhen the system is adding to a
c o n s e c u t i v ef i l e o r c r e a t i n ga d i r e c t f i l e .

4-204

FILEIDENTIFICATION
Eachindexedfile for which recordsareto be recovered
. h eo n l y
m u s tb e i d e n t i f i e db y a n O C L F I L E s t a t e m e n tT
y
o
u
i
n
c
l
u
d
e
f
i
l
e
n
a
m
e ,u n i t
t
h
a
t
m
u
s
t
i
s
t
h
e
description
p
a
c
k
F
l D . Y o u m a y a l s oi n c l u d eO C L I L E s t a t e '
c o d e ,a n d
mentsfor other than indexedfiles;however,the recover
index programdoesnot attemptto recoverrecordsin other
f i l e o r g a n i z a t i o n sT.h e f o l l o w i n ge x a m p l es h o w sa F I L E
statementfor eachfile to be checkedfor recordrecovery:

5n
) dt h e $ l N D E X 4 0
T h e$ l N D E X 4 5f i l e ( N A M E - $ l N D E X 4 a
he
f i l e ( N A M E - $ l N D E X 4 0a)r ew o r k f i l e su s e dt o d e c r e a st e
processing
time for sortingthe indexesof largeindexedf iles.
l f y o u d o n o t s u p p l ya $ l N D E X 4 5o r a $ l N D E X 4 0F I L E
statement,the systemattemptsto allocatethe work space.
F o r a d d i t i o n ailn f o r m a t i o nr e g a r d i ntgh e $ l N D E X 4 5a n d
the $f NDEX40 work files, seeFile Facilitiesin Part 2.
T h e f o l l o w i n gp r i n t o u ti s a r e s u l to f p r o c e s s i nega c hF I L E
statementshownin the previousexample:
$ R I N D X_ 1 , 5 / D F I L E R E C O V E RPYR O G R A 1D4A T E _ X X / X X / X X
FILE
LABEL
C O l . lE
SC
DIRECT
I N4501,
I N4502
I N4503
IN4504
I N4505
I N4506
I N4507

FILE PACK
TYPELABEL

c
D

DlDXDX
D],D1,D1,
D],D1,D],
D1D],D],
Dl,D],D1
D],D],D1,
D1D1,D],
Dl,D ],Dl,
Dl,Dl,Dl,

FILE
DATE

LASTADDKEY
INCLUDED

o 2 1 , 9 76
021,976
o 2 L 9 76
o 2 1 , 9 16
o 2 L 9 16
o 2 1 , 9 16
021,916
o 2 L 9 76
02L67 6

00971
0 0 20 3 1
0 0 0 41,31,
0 0 0 05 1 , 9 1
00000721,1,
000000721,1,
F I L E N O T A V AI L A B L E

TII'4E_OO.OO.25

A L L FI L E S PROCESSED

R e c o v e rI n d e x P r o g r a m - $ R I N D X

4-2Og

T h e C l U L x x m e s s a goec c u r sw h e na l l o f t h e f o l l o w i n g
conditionsare oresent:
o T h e s y s t e mi s p r o c e s s i nagF I L E s t a t e m e n t .

C O N SD
I E R A T I O N SA N D R E S T R I C T I O N S
o l f m o r et h a no n e f i l e h a s t h es a m en a m e ,u s eD A T E o r
L O C A T I O Nt o f u r t h e ri d e n t i f yt h e f i l e y o u i n t e n dt o
check.

o The describedfile cannotbe found.
o A T R A C K So r R E C O R D So a r a m e t ei rs n o t i n c l u d e do n
the FILE statement.
l f t h e r e c o v eirn d e xp r o g r a mc a n n o tf i n d t h e f i l e i d e n t i f i e d
by the FILE statementh
, e f i l e i n f o r m a t i o na n dt h e F I L E
N O T A V A I L A B L E m e s s a gi e
sprinted.
After all OCL FILE statements
havebeenprocessed,
an
D e s s a gi e
A L L F I L E SP R O C E S S Em
s p r i n t e d .T h e i n d e xi s
then sortedand the VTOC (volumetableof contents)
updated.
N o t e : A f t e rt h e A L L F I L E SP R O C E S S Em
D e s s a gi e
s
printedd
, o n o t c a n c e$l R I N D X o r s t a r tt h e n e x t j o b p r i o r
to actualend of job. Processing
continueswith sortingthe
i n d e xa n d u p d a t i n gt h e V T O C .

OCLCONSIDERATIONS
The followingOCL statements
areneededto load and execute the recoverindex program:
//
//
II
//

LOAD$RlNDX.code
S W I T C Hl x x x x x x x ( t h i ss t a t e m e nits o p t i o n a l )
F I L E N A M E - x x x x x x x x , U lNT - x x . P A C K - x x x x x x
RUN

o l f a d i s k l / O e r r o ro c c u r sd u r i n gt h e e x e c u t i o no f
$ R l N D X , t h e f i l e i n f o r m a t i o na n de r r o rm e s s a gDeI S K
l / O E R R O Ri s p r i n t e d .A s y s t e mm e s s a gt e
h e no c c u r s ;
o o t i o n sa r e :
- Continueprocessing
with the next file
- Cancelthe job
o l f m e s s a gDeD b P( K e y s o r tD u p l i c a t eK e y )o c c u r sd u r i n g
t h e e x e c u t i o no f $ R l N D X , i t m a y i n d i c a t et h a t t h e p r o g r a mw a sa b n o r m a l l yt e r m i n a t e d u r i n gt h e p r o c e sos f
s o r t i n gt h e i n d e x . C o n t i n u ep r o c e s s i nugn t i l e n d o f j o b
f o r $ R I N D X . l f t h e f i l e i s n o t k n o w nt o h a v ed u p l i c a t e
keys.usethe copy/dumpprogram($COPY)with
REORG-NO
a n d a n O M I T o r D E L E T Ep a r a m e t et ro
r e b u i l dt h e i n d e x .
o Recoveryof the lastrecordof a file that spansa disk
sectorbeyondthe sectorthat containsthe key is optional. lf you chooseto recoverthis record,you must includea SWITCHstatementin the OCL. Otherwise,the
programshiftsthe last recordpointersto excludethis
key and record,therebyensuringthat only valid records
arerecovered.
The SWITCHstatementmust causeexternalindicator1
to be on. Externalindicators2 through8 can be either
o n o r o f f. F o r e x a m p l e :
/ / S W I T C Hl x x x x x x x

The codeyou supplydependson the locationof the simulation areacontainingthe recoverindex program. Possible
c o d e sa r eR 1 . F l , R 2 , F 2 .

Whenyou includethis statementand the lastrecord
meetsthe previouslydescribedconditions,the record
may be invalidbecause
the programcannotdetermine
whetheror not it is complete.
F o r m a x i m u mr e c o v e r yt ,h e k e y si n a n i n d e x e df i l e
shouldbe at the end of eachrecord.
a lf an abnormalterminationoccurswhen a key(s)was
addedto the file but not written to the disk.the endo f - i n d e xp o i n t e rw i l l n o t i n c l u d et h i s k e y ( s )a f t e rt h e
systemhasexecutedthe recoveryindex program.

+210

EXAMPLES
In the followingexample.the recoverindex programis
loadedfrom R2. The printout showsthat keyswereadded
to eachof the filesexcept1N4403beforethe abnormal
termination.
//
/ /
/ /

LOG PRINTER
LOAD $RINDX,R2
F I L E N A M E - $ I N D E X 4 5 ' U N I T _ D ZP' A C K _ D 2 D 2 D 2 I T R A C K S _ 3 0

//
//
//

F I L E N A M E - I N 4 5 O ] , r U N I T _ D 1P,A' C K _ D ] , D ] , D 1 ,
F I L E N A M E - I N 4 5 O 2 I U N I T _ DP
1A
' rC K - D ] , D ] , D ] ,
Fi LE NAME_IN45O3rUNIT_Dl,rPACK-D1,D1,D],

/ /

F I L E N A M E _ I N 4 4 O l , I U N I T _ D 1P
' rA C K - D X D ] , D ] ,

//
//
//

FILE NAME_IN44O2'UNiT-DP
1 ,Ar C K - D ] , D l , D ] ,
F I L E N A M E _ I N 4 4 0 3 r U N I T _ DP1 A
. 'C K - D ] , D 1 , D ] ,
RUN

$ R I N D X_ 1 , , 5 / DF I L E R E C O V E RPYR O G R A MD A T E FILE
LASEL
I N4401,
IN4402
N4403

N450r,
N4502
I N 4 50 3

FILE PACK
TYPELASEL
I
I
I

D1,D1D1,
Dl,D1D1,
D1,D1,D1,
D1,D1,D1,
DI,D],D],
DLDl,Dl,

XX/XX/XX TIME_OO.OO.25

FILE
DATE

L A S TA D DK E Y
INCLUDED

0 2 2 6 76
022676
022616
022676
022616
022616

000000000000000000000971'
0000000000000000000002031,
00971,
002031,
00041,31,

ALL FILES PROCESSED
$ RI N D X O ] ,
I
I,DDKS
S E G I N K E Y S O R T / M E R G_E I N 4 4 O 1 ,
$ RI N D X O 1
I
1, DD KS
B E G I N K E Y S O R T / M E R G- E I N 4 4 O 2
$ Ri N D X O I ,
I
], DD KS
B E G I N K E Y S O R T / M E R G- E I N 4 4 O 3
$ RI N D X O 1
I
1, DD KS
S E G I N K E Y S O R T / M E R G_E I N 4 5 O ] ,
$ RI N D X O I ,
i
1, DD KS
_
I
N
4
5
0
2
S
O
R
T
/
M
E
R
G
E
BEGINKEY
$ RI N D X O I ,
I
1, DD KS
S E G I N K E Y S O R T / M E R G- E I N 4 5 0 3

I
1, CT EJ
0 2 / 2 6 / 1 6 0 0 . 0 0 . 1 , 90 0 . 0 2 . 4 7

$RINDXO],

RecoverIndex Program-$R|NDX

4'211

ReassignAlternate Track Program-$RSALT
PROGRAM
DESCRIPTION
The reassign
alternatetrack programhasthe following
function:
Reassign
alternatetrackson a 3340 data modulefor use
on System/360or System/370.
Whenit is necessary
to transporta 3340 data modulefrom
System/3to System/360or System/370.you mustexecute
the reassign
alternatetrack program($RSALT)beforeyou
executethe DOS/OSinitializationprogram.
On a 3340 datamoduleinitializedon System/3,thereare
4 0 a l t e r n a t ter a c k so n c y l i n d e r s1 6 7a n d 1 6 8 . O n a
System/360or System/37O3340 data module, there are24
alternatetrackson cylinders208 and 209. Consequently,
if a 3340 datamoduleinitializedon System/3hasmore
than 24 defectiveprimarytracks,it cannotbe initializedby
System/360or System/370.
Note: Datainterchange
is not supportedbetweenthe
System/3and the System/360or System/37O.
so this programcannotbe usedfor that purpose.System/3dataexisting on the data modulebefore$RSALT is run will be lost.

C O N T R OL S T A T E M E N TS U M M A RY
you mustsupplydependon the
The control statements
desiredresults.
Funstion
Reassign
Alternate
Tracks

Control Statements
(code

END

+212

)

ALTAuNtr-l'.oo.s')'.PAcK-l
lttt .!
l'names''
tnr-r-)

P A R A M E T E RS U M M A R Y
Parameter

Description

code
{
I
UNIT-('codes'
)

S p e c i f i e st h e l o c a t i o n o f t h e 3 3 4 0 d a t a m o d u l e . P o s s i b l ec o d e sa r e D l , D 2 ,
D 3 o r D 3 1 . D 4 o r D 4 1, a n d A L L .

(nr-r-)

Specifiesthe name of the data module you want to modify.

P A C K '.n{a1m" 'e.s}'
I

,

P A R A M E T E RD E S C R I P T I O N S
UNIT Parameter
( code )
T h e U N I T p a r a m e t e(rU N I T -( ' c o d e s ' , ,) s p e c i f i etsh e l o c a -

I ar-r- )

tion of the 3340 data module you want to modify. $RSALT
c a n m o d i f y a m a x i m u m o f t h r e e 3 3 4 0 d a t a m o d u l e sd u r i n g
o n e e x e c u t i o no f t h e p r o g r a m . T h e c o d e y o u s u p p l y d e p e n d so n t h e n u m b e r o f d a t a m o d u l e st h a t y o u w a n t t o
modify. For example:
For one data module,specifyUNIT-code
F o r t w o d a t a m o d u l e s ,s p e c i f y U N I T - ' c o d e , c o d e '
F o r t h r e e d a t a m o d u l e s ,s p e c i f y U N I T - ' c o d e , c o d e , c o d e '

PACK Parameter

T h e P A C K p a r a m e t e r( P A C K - { :' u
n -a"m e ,s]' 'J ) , . t t , t n e p r o g r a m
t
the name of the data moduleto be modified. The name
m u s t n o t e x c e e d6 c h a r a c t e r sa n d c a n b e a n y o f t h e s t a n d a r d
System/3 charactersexcept apostrophes,commas, and
l e a d i n go r e m b e d d e db l a n k s .
W h e n m o r e t h a n o n e d a t a m o d u l e i s m o d i f i e d ,t h e a s s o c i a t e do a c k n a m e a n d d a t a m o d u l e c o d e m u s t b e i n t h e
s a m er e l a t i v ep o s i t i o n w i t h i n e a c h p a r a m e t e r . F o r e x a m p l e ,
i n t h e f o l l o w i n g s t a t e m e n tt h e n a m e D 2 D 2 D 2 i s a s s o c i a t e d
with unit code D2. Also, the name D3D3D3 is associated
with unit code D3:
// ALTA UNIT-'D2,D3"PACK.'D2D2D2,D3D3D3'

l f U N I T - A L L i s s p e c i f i e d ,$ R S A L T m o d i f i e s a l l d a t a m o d u l e st h a t a r e o n l i n e a n d n o t b e i n g u s e d b y o t h e r p a r t i t i o n s .
Code

l f U N I T A L L i s s p e c i f i e d ,P A C K p a r a m e t e rn a m e sm u s t b e
s u p p l i e df o r a l l d a t a m o d u l e st h a t a r e t o b e m o d i f i e d .

tfeaning

D1

Modifv data module on drive 1

D2

Modifv data module on drive 2

D3or D31

Modify data moduleon drive 3

D4 or D41

Modify data module on drive 4

ALL

M o d i f y a l l a v a i l a b l ed a t a m o d u l e s

T h e r e a s s i g na l t e r n a t et r a c k p r o g r a mc o m p a r e st h e n a m e i n
t h e P A C K p a r a m e t e rw i t h t h e n a m e o n t h e d a t a m o d u l e t o
e n s u r et h a t t h e y m a t c h . l f n o t , t h e p r o g r a mh a l t s w i t h a n
error messaoe.

l f t h e I P L w a sp e r f o r m e df r o m d r i v e1 , $ R S A L Tw i l l n o t
a c c e pD
t 1 a sa v a l i dc o d e .

R e a s s i g nA l t e r n a t e T r a c k P r o g r a m - $ R S A L T

4-213

F i g u r e 4s - 1 0 3 , 4 - 1 0 4a, n d4 - 1 0 5a r ee x a m p l eos f O C L a n d
control statements
requiredto executethe $RSALT
program.

Explanation:
o T h e r e a s s i ganl t e r n a t ter a c kp r o g r a mi s l o a d e df r o m F l .
o T h e d a t am o d u l em o u n t e do n d r i v e4 ( U N I T - D 4 )i s
modified to System/360-system/370
format.
o T h e n a m eo f t h e d a t am o d u l ei s c o m p a r e dw i t h D 4 D 4 D 4
(PACK-D4D4D4).
Figure 4-103. Modify One Data Module

Explanation:
The reassign
alternatetrack programis loadedfrom F 1.
T h e d a t am o d u l e sm o u n t e do n d r i v e3 a n d d r i v e4
(UNlT-'D3,D4')are modifiedto System/360-system/370
format.
o The nameof eachdata moduleis comparedwith its
a s s o c i a t ePdA C Kp a r a m e t enra m e( p A C K - , D 3 D 3 D 3 ,
D4D4D4'1.
Figure 4-104. Modify Two Deta Modules

4-214

Explanation:
o The reassign
alternatetrack programis loadedfrom Fl.
o T h e d a t am o d u l e so n d r i v e s2 , 3 , a n d4 ( U N I T _ A L L )
are to be modified to System/360-system/370
format.
o The nameon eachdata moduleis compared
with its
associated
PACK parametername(PACK-,D2D2D2,
D3D3D3,D4D4D4'}.
Figure 4-105. Modify Multiple Data Modules

ReassignAlternat€ Track program-$RsALT

4-215

SimulationAreaProgram-$SCOpy
P R O G R A MD E S C R I P T I O N
T h es i m u l a t i o n
a r e ap r o g r a mh a st h e f o l l o w i n gf u n c t i o n s :
o C O P Y A R E Ac o p i e st h e e n t i r ec o n t e n t so f o n e s i m u l a t i o n
a r e at o a n o t h e rs i m u l a t i o n
area.
C L E A Rc l e a r sa l l t h e d a t af r o m a s i m u l a t i o n
a r e aa n d
b u i l d sa s i m u l a t e d
c y l i n d e r0 ( o p t i o n a l l yp r o v i d e s
v o l u m el D a n do w n e rl D l .
N E W N A M Ec h a n g etsh e n a m e( v o l u m el D ) a n d / o r
o w n e rl D o f a s i m u l a t i o n
area.
N A M E Sp r i n t sa n d / o rd i s p l a y tsh e n a m e( v o l u m el D ) o f
e a c ha v a i l a b lsei m u l a t i o n
a r e aa n d m a i nd a t aa r e a .
M O V Ec o p i e st h e e n t i r ec o n t e n t so f o n e s i m u l a t i o n
area
t o a n o t h e rs i m u l a t i o na r e a c, l e a r st h e s i m u l a t i o na r e a
from which the contentswerecopied,and buildsa
s i m u l a t e cd y l i n d e r0 i n t h e s i m u l a t i o n
a r e ac o p i e df r o m .
C O P Y I P Lc o p i e sI P L r e c o r d sf r o m o n ev o l u m et o
a n o t h e rv o l u m e .

4-2',t6

C O N T R O LS T A T E M E N TS U M M A R Y
The control statements
you must supplydependon the
desiredresults.
Functions

Control Statements

COPYAREA

mN
eA
] ME-name]
/ / C O P Y A R E AF R O M - c o d e , T O - c o d e , A R E A - n a m e [ . P A C K -[ n, TaO

f]
[svsrer,,r-{fit
CLEAR

// CLEARFROM-code[,PACK.nam
[ ,eA]R E A - n a m e[], C L R N A M E - n a m e[ ,]t D - n a m e l

r

r.HEcK\l

I,TYPE-{( -Y
' o R c EJ l
L
NEWNAME

NAMES

// NEWNAMETO-code,AREA-name,TONAME-name[,PACK-name][,lD-name]

l-pnrrurI
/ / N A M E SI D I S P L A Y
I

[eorH I
MOVE

mN
e ]A M E - n a m e[ .]l D - n a m e ]
/ / M O V E F R O M - c o d e , T O - c o d e , A R E A - n a m e [ . P A C K -In, TaO

[,t"ttt*
COPYIPL

{l5t}]

t,cLRNAME.namel

// COPYIPLFROM-code,TO-code,PACK-name
// END

SimulationAreaProgram-$SCOPY 4-217

Figure4-106liststhe possiblecodes.thatcan be supplied
in eachof the appropriateparameters
for gSCOpy. Before
usingthesecodes,you shouldbe familiarwith the format
of eachvolumeand the assignment
of the codesasdescribed
i n P a r t3 o f t h i s m a n u a l .
Disk Drive
Type and
Designation

Main Data
Area Codes

SimulationArea
Codesl

3340 drive I
3340 drive 2
3340 drive3
3340 drive4

D1
D2
D3or D31
D4or D41

D 1 AD
, I B ,D 1 CD
, 1D
D2A,D2B.D2C,D2D
D3E,D3A
D4E,D4A

3344 drive 3
v o l u m e1
v o l u m e2
volume3
v o l u m e4

D3or D31
D32
D33
D34

D 3 E ,D 3 A
D 3 F ,D 3 B
D 3 G ,D 3 C
D 3 H ,D 3 D

3344 drive 4
v o l u m e1
v o l u m e2
v o l u m e3
v o l u m e4

D4 or D41
D42
D43
D44

D 4 E .D 4 A
D4F,D4B
D 4 G .D 4 C
D 4 H ,D 4 D

r

I n s t e a do f a s i m u l a t i o n a r e a c o d e , a 5 4 4 4 u n i t c o d e ( F l , R l ,
F2, R2l may be used, and when used, it refers to the simulat i o n a r e a c u r r e n t l y a s s i g n e dt o t h a t c o d e i n t h e p a r t i t i o n i n
which $COPY is beingexecuted.

Figure 4-106. Main Data Area and Simulation Area Codes

4-218

PARAMETER
SUMMARY
Parameter

Description

COPYAREA
FROM-code

l d e n t i f i e st h e s i m u l a t i o na r e ab e i n g c o p i e d . S e e F i g u r e4 - 1 0 6 f o r t h e p o s s i b l e
codes.

TO-code

l d e n t i f i e st h e s i m u l a t i o na r e a r e c e i v i n gt h e c o p y . s e e F i g u r e4 - 1 0 6 f o r t h e p o s s i b l e
codes.

PACK-name

ldentifies the name of the main data area associatedwith the simulation area
receivingthe copy.

AREA-name

l d e n t i f i e st h e n a m e o f t h e s i m u l a t i o n a r e a b e i n g c o p i e d .

TONAME-name

Specifiesa name change for the simulation area receivingthe copy.

svsreru
{{fs

Specifieswhether IPL information is to be copied.

CLEAR
FROM-code

ldentifiesthe
simulation
a r e ab e i n gc l e a r e d .S e eF i g u r e4 - 1 0 6f o r t h e p o s s i b l e
codes.

PACK-name

Specifiesthe nameof the main dataareaassociated
with the simulationarea
to be cleared.

AREA-name

Specifiesthe simulationareato be cleared.This parametercannotbe specified
if the simulationareadoesnot havean assigned
name. PlD00l must be specified
to clearan areausedfor distributionof programsfrom the IBM program
library/PlD.

CLRNAME-name

Specifiesthe nameto be givento the simulationareabeingcleared.This parameter must be specifiedif the simulationareadoesnot havean assigned
name. The
n a m eo f t h e s i m u l a t i o na r e a i, f p r e v i o u s ldy e fi n e d ,w i l l r e m a i nt h e s a m ei f t h i s
parameteris not specified.

lD-name

Enablesyou to usea 1O-character
namein additionto the simulationareaname
t o f u r t h e ri d e n t i f ya s i m u l a t i o n
area.

TYPE-CHECK

Tellsthe programto checkfor activefiles or librariesand halt if any are
found beforeclearningthe simulationarea.

TYPE-FORCE

Tellsthe programto clearthe simulationareawithout checkingfor activefiles
or libraries.

Simufation Area Program-$SCOPY

4-2'l.9

Parameter

Description

NEWNAME
TO-code

specifies the name of the simulation area being renamed. see Figure 4-106 for the
possiblecodes.

PACK-name

Specifiesthe name of the main data area associatedwith the simulation area being
renamed.

AREA-name

Specifiesthe existing name of the simulation area being renamed.

TONAME-name

Specifiesthe new name being given to the simulation area. The name may be up
to 6 charactersin length and contain any combination of standard System/3
charactersexcept apostrophes,embedded blanks, and embedded commas (due to
their delimiter function). See Appendix A for a list of standard System/3
characters.

lD-name

Enablesyou to assigna lGcharacter name in addition to the area name to
further identify the simulation area.

NAMES
PRINT
DISPLAY
BOTH

T h e P R I N T p a r a m e t ei rn d i c a t etsh a t t h e n a m e so f a l l o n l i n es i m u l a t i o n
areas
areto be printedon the deviceassigned
asthe systemprint device(PRINTER
statement).The DISPLAY parameterindicatesthat the namesof all online
simulationareasareto be displayedon the displayscreen.The BOTH parameter
indicatesthat the namesof all onlinesimulationareasare to be printedand displayed. lf no parameteris specified,the simulationareanamesareprinted.
lf an areais unavailable,
its volumelD is left blank and a message
will indicate
the reason.UsingDISPLAY.an additionalscreenis usedto displayexception
output.

MOVE
FROM-code

ldentifiesthe simulationareabeingmoved. SeeFigure4-106for the possible
codes.

TO-code

l d e n t i f i e tsh e s i m u l a t i o n
g o v e di n f o r m a t i o n .S e eF i g u r e4 - 1 0 6f o r
a r e ar e c e i v i nm
the possiblecodes.

PACK-name

ldentifiesthe nameof the main dataareaassociated
with the simulationarea
receivingthe movedinformation.

AREA-name

Specifiesthe nameof the simulationareabeingmoved.

TONAME-name

Specifiesa name change for the simulation area receiving the moved information.

+220

Parameter

Description

lD-name

Namecan be a maximumof 10 characters
and is usedto further identifythe
simulationareabeingmoved.
tpecifieswhetherIPL informationis to be copied.

SvSTEM
{l5S}
CLRNAME-name

Usedto assigna nameto the areafrom which the informationhasbeenmoved.

COPYIPL
FROM-code

ldentifiesthe main dataareacontainingtheIPL recordsto be copied. SeeFigure
4-106for the possiblecodes.

TO-code

ldentifiesthe main dataareareceivingthe IPL records.SeeFigure4-106for the
possiblecodes.

PACK-name

ldentifiesthe nameof the maindataareareceivingthe IPL records.

Simulation Area Program-$SCOPY

4-221

PARAMETER DESCRIPTIONS-COPYAREA

PARAMETERDESCRIPTIONS_CLEAR

FROM and TO Parameters

FROM Parameter

) e n t i f i etsh e s i m u l a T h e F R O M p a r a m e t e(rF R O M - c o d ei d
tion areathat containsthe informationto be copied. The
TO parameter(TO-code)identifiesthe simulationareathat
is to receivethe copy. Possible
codesarethosefor the
simulationareasand the 5444 unit codes.SeeFigure4-106
for possiblecodes.

) e n t i f i e tsh e s i m u l a T h e F R O Mp a r a m e t e(rF R O M - c o d ei d
tion areato be cleared.Codesthat may be usedarethose
for the simulationareasand the 5444 unit codes. See
F i g u r e4 - 1 0 6f o r p o s s i b l ceo d e s .

PACK Parameter
PACK Parameter
The PACK parameter(PACK-name)
identifiesthe nameof
the main dataareaassociated
with the simulationarea
receiving
the copy. This is the nameassigned
by the disk
i n i t i a l i z a t i opnr o g r a m( $ l Nl T ) .

The PACK parameter(PACK-name)
specifies
the nameof
the main dataareaassociated
with the simulationareathat
is to be cleared.This is the nameassigned
by the disk
i n i t i a l i z a t i opnr o g r a m( $ lN I T ) .

AREA Parameter
AREA Parameter
T h e A R E A p a r a m e t e(rA R E A - n a m ei )d e n t i f i etsh e n a m e
of the simulationareathat is to be copied.
/Uote.'Usinga COPYAREAor MOVE statement,the
r e c e i v i nsgi m u l a t i o na r e ai s a s s i g n etdh e o w n e rl D o f t h e
simulation
a r e ab e i n gc o p i e df r o m .

The AR EA parameter(AR EA-name)specifiesthe nameof
the simulationareathat is to be cleared.This parameter
name. The
cannotbe specifiedif the areahasno assigned
AREA parametermust be specifiedas PlD001in order to
clearan areausedfor distributionof programsfrom the
I B M p r o g r a ml i b r a r y .

CLRNAME Parameter
TONAME Parameter
T h e T O N A M Ep a r a m e t e(rT O N A M E - n a m ei s) u s e dt o
changethe nameof the simulationareathat is to receive
(see
the copy. The namemay containup to 6 characters
CLRNAME Parameterunder CLEAR for explanationof
v a l i dn a m e s ) .l f t h e T O N A M Ep a r a m e t ei rs o m i t t e d ,t h e
nameof the simulationareathat is to be copiedis used.

SYSTEMParameter
The SYSTEMparameteris usedto copy IPL information.
l f S Y S T E M - Y E iSs s p e c i f i e dt h. e I P L i n f o r m a t i o nf r o m
c y l i n d e r0 o f t h e v o l u m ef r o m w h i c ha n I P L w a sp e r f o r m e d
( D 1 , D 3 , o r D 3 1 ) i s c o p i e dt o c y l i n d e r0 o f t h e v o l u m e
r e c e i v i ntgh e c o p i e di n f o r m a t i o n .l f S Y S T E M - N O
is
s p e c i f i e dt h, e I P L i n f o r m a t i o ni s n o t c o p i e d . l f t h i s
parameteris not specified,SYSTEM-NOis assumed.

) ecifies
sp
T h e C L R N A M Ep a r a m e t e(rC L R N A M E - n a m e
given
name
be
the
to
to the simulationareathat is to be
cleared.The namemay be up to 6 characters
in lengthand
containany combinationof standardSystem/3characters
exceptapostrophes,
embeddedblanks,and embedded
commas(dueto their delimiterfunction). SeeAppendixA
for a list of standardSystem/3characters,Someexamples
o f v a l i da r e an a m e sa r e : 0 , F 0 0 0 1 ,O 1 2 ,4 1 8 9 , a n d A B C .
lf this parameteris not specified,the nameof the simulation areais the namepreviouslydefined. lf a namehasnot
beenpreviouslydefined,CLRNAME must be specified.

lD Parameter
T h e l D p a r a m e t eern a b l e ys o u t o i n c l u d ea m a x i m u mo f 1 0
characters
in additionto the areanameto further identify
a volume. The characters
can be any combinationof
(seeAppendixA) except
standardSystem/3characters
blanks,and commas(dueto their delimiter
apostrophes,
functionl. The informationis strictlyfor volumeidentification;it is not usedby the systemfor checkingpurposes.
lf no parameteris specified,the owner lD areain the
v o l u m el a b e li s b l a n k .

TYPE Parameter

SYSTEMParameter

The TYPE parameterspecifies
the type of clearthat is to
b ed o n e . l f T Y P E - C H E C K
i s s p e c i f i e da, c h e c ki s m a d ef o r
activefilesor libraries.lf any arefound, the systemissues
an error message.lf TYPE-FORCEis specified,the areais
clearedwithout a checkfor activefilesor libraries.All
l i b r a r i eas n dd a t af i l e sa r ed e l e t e d .( D e f a u l ti s T Y P E - C H E C K . )

The SYSTEMparameteris usedto copy IPL information.
lf SYSTEM-YES
i s s p e c i f i e dt h
, e I P L i n f o r m a t i o nf r o m
c y l i n d e r0 o f t h e v o l u m ef r o m w h i c ht h e I P L w a sp e r f o r m e d
( D 1 , D 3 o r D 3 1 ) i s c o p i e dt o c y l i n d e r0 o f t h e v o l u m e
r e c e i v i ntgh e c o p i e di n f o r m a t i o n .l f S Y S T E M - N O
i ss p e c i f i e d ,t h e I P L i n f o r m a t i o ni s n o t c o p i e d . l f t h i s p a r a m e t e r
i s n o t s p e c i f i e dS, Y S T E M - N O
i sa s s u m e d .

PARAMETER DESCRIPTIONS-NEWNAME
CLRNAME Parameter
TO Parameter
The TO parameter(TO-code)identifiesthe simulationarea
that is to be renamed.Possible
codesarethosefor the
simulationareasand the 5444 unit codes.SeeFiqure4-106
for the possiblecodes.

T h e C L R N A M Ep a r a m e t e(rC L R N A M E - n a m ei s)u s e dt o
assiga
n n a m et o t h e s i m u l a t i o n
a r e af r o m w h i c ht h e i n f o r mationhasbeenmoved. The namemay be up to 6 characters. SeeCLRNAME ParameterunderCLEAR for an
e x p l a n a t i oonf v a l i dn a m e s .l f n o p a r a m e t ei rs s p e c i fe d ,
the areais clearedand the namepreviouslyassigned
is used.

PACK Parameter
P A R A M E T E RD E S C RI P T IO N S - C O P YP
IL
The PACK parameter(PACK-name)
specifies
the nameof
the maindataareaassociated
with the simulationareabeing
r e n a m e dT
. h i s i s t h e n a m ea s s i g n ebdy t h e d i s k i n i t i a l i z a t i o n p r o g r a m( $ l N l T ) .

AREA Parameter
T h e A R E A p a r a m e t e(rA R E A - n a m es)p e c i f i etsh e e x i s t i n g
nameof the simulationareathat is to be renamed.

lD Parameter
T h e l D p a r a m e t e(rl D - n a m es) p e c i f i etsh e o w n e rl D t h a t
is to be givento the simulationareafrom which information wasmoved. lf no pbrameteris specified,the owner lD
in the volumelabelis left blank.
rVote.'Usinga COPYAREAor MOVE statement,the
receiving
areais assigned
the owner lD of the areabeing
copiedfrom. The owner lD namemay be up to 10 characters in length. See/D ParameterunderCLEAR for an
e x p l a n a t i oonf v a l i dn a m e s .

FROM and TO Parameters
n a t aa r e ac o d e )i d e n t i T h e F R O M p a r a m e t e(rF R O M - m a i d
fiesthe volumecontainingthe IPL recordsthat areto be
copied. The TO parameter(TO-maindataareacode)
identifiesthe volumethat is to receivethe IPL records.
SeeFigure4-106for the possiblecodes.
Note: COPYIPL cannotbe executedto the volumefrom
w h i c ha n I P L w a sp e r f o r m e d .F o r e x a m p l ei,f a n I P L w a s
performedfrom D ISK 1 (F 1 or R 1), you cannotspecifyD 1
on the TO parameter.Also,if an IPL wasperformedf rom
D I S K 3 ( F 1 o r R 1 ) ,y o u c a n n o ts p e c i f yD 3 o r D 3 1 o n t h e
TO parameter.

PACK Parameter
The PACK parameter(PACK-name)
identifiesthe nameof
the main dataareathat is to receivethe IPL records(the
n a m ew a sa s s i g n ebdy t h e d i s k i n i t i a l i z a t i opnr o g r a m

($rNrr)).

TONAMEParameter
TheTONAME parameter(TONAME-name)specifiesthe new
n a m et o b eg i v e nt o t h es i m u l a t i o a
n r e a .T h en e wn a m em a y
be up to 6 charactersin length. SeeCLRNAME Parameter
underCLEAR for anexplanationof validnames.

Simufation Area Program-$SCOPY

4-223

P A R A M E T ER D E S C RI P T I O N S _ N A M E S

P A R A M E T ER D E S C RI P T I O N S - M O V E

PRINT Parameter

FROM and TO Parameters

T h e P R I N Tp a r a m e t ei rn d i c a t etsh a t t h e n a m e so f a l l o n l i n e
simulationareasareto be printedon the deviceassigned
as
t h e s y s t e mp r i n t d e v i c e( P R I N T E Rs t a t e m e n t ) .T h e
D I S P L A Yp a r a m e t ei rn d i c a t etsh a t t h e n a m e so f a l l o n l i n e
simulation
a r e a sa r et o b e d i s p l a y e o
d n t h e d i s p l a ys c r e e n .
T h e B O T Hp a r a m e t ei rn d i c a t etsh a t t h e n a m e so f a l l o n l i n e
simulation
a r e a sa r et o b e p r i n t e da n dd i s p l a y e d l. f n o
parameteris specified,the simulationareanamesare
p r i n t e d . l f a n a r e ai s u n a v a i l a b l iet ,s v o l u m el D i s l e f t
blankand a message
will indicatethe reason.Using
D I S P L A Y ,a n a d d i t i o n asl c r e e ni s u s e dt o d i s p l a ye x c e p t i o n
output.

) e n t i f i e tsh e s i m u l a T h e F R O Mp a r a m e t e(rF R O M - c o d ei d
tion areathat is to be moved. The TO parameter(TO-code)
identifiesthe simulationareathat is to receivethe moved
codesarethosefor the simulation
information. Possible
areasand the 5444 unit codes. SeeFigure4-106for the
possiblecodes.

PACK Parameter
identifiesthe nameof
The PACK parameter(PACK-name)
simulationareathat
with
the
data
area
associated
the main
is to receivethe movedinformation. The namewasassigned
n r o g r a m( $ l N l T ) .
b y t h e d i s ki n i t i a l i z a t i o p

AREA Parameter
T h e A R E A p a r a m e t e(rA R E A - n a m es)p e c i f i etsh e n a m eo f
the simulationareato be moved.

TONAME Parameter
T h e T O N A M Ep a r a m e t e(rT O N A M E - n a m ei s) u s e dt o
changethe nameof the simulationareathat is to receive
the information. lf no parameteris specified,the nameof
the simulationareathat is to be movedis used. See
CLRNAME Parameterunder CLEAR for an explanation
o f v a l i dn a m e s .

OCLCONSIDERATIONS
The followingOCL statements
areneededto loadthe
simulation
a r e ap r o g r a m :
// LOAD $SCOPY,code
i/ RUN
The codeyou supplydependson the locationof the simu_
l a t i o na r e ac o n t a i n i n tgh e s i m u l a t i o n
a r e ap r o g r a m .p o s s i b l e
codesare R 1, F 1, R2, and F2.

EXAMPLES
F i g u r e 4s - 1 0 7t h r o u g h4 - l l 3 a r ee x a m p l eos f c o n t r o ls t a t e _
mentsusedto performspecific functionsof the simulation
areaprogram.
F i g u r e 4s - 1 1 4t h r o u g h4 - 1 1 7a r ee x a m p l eos f t h e N A M E S
d i s p l a yf u n c t i o n .

Explanation:
A f t e r a c h e c kf o r a c t i v ef i l e sa n d l i b r a r i e s( d e f a u l its
T Y P E - C H E C Kt)h, e s i m u l a t i o n
a r e a( D 2 C )i s c l e a r e d .l t i s
g i v e na v o l u n r el D o f D 2 C D 2 Ca n d a n o w n e rl D o f
B A C K U P F1 . T h i si s a n e x a m p l eo f t h e C L E A Rt h a t i s
t o b e r u n a f t e rt h e e n t i r ev o l u m eh a sb e e ni n i t i a l i z e d
by $lNlT.
F i g u r e 4 . 1 O 7 . C L E A R E x a m p l e : C l e a r i n ga S i m u l a t i o n A r e a

Simulation Area Program-$SCOPY

4-225

Explanation:
A f t e r v e r i fi c a t i o nt h a t t h e v o l u m el D o n t h e s i m u l a t i o n
a r e a( D 1 C )i s P l D 0 0 1 ,t h e s i m u l a t i o n
a r e ai s c l e a r e da n d
g i v e na v o l u m el D o f D l C D l C . T h eo w n e rl D i s a l l b l a n k s
a n dt h e c h e c kf o r a c t i v ef i l e sa n d l i b r a r i e iss b y p a s s e o .
This is an exampleof the control statementneededto
c l e a ra s i m u l a t i o n
p r o g r a mfsr o m t h e I B M
a r e ac o n t a i n i n g
p r o g r a ml i b r a r y / P l D .
F i g u r e 4 - 1 O 8 . C L E A R E x a m p l e : C l e a r i n ga n A r e a C o n t a i n i n g
IBM Programs.

Explanation:
A f t e r v e r i f i c a t i o tnh a t t h e v o l u m el D o f a r e aD 1 A i s
F l F l F l . t h e s i m u l a t i oanr e a( D 1 A )i s c o p i e dt o t h e s i m u l a t i o n a r e a( D 2 C ) . T h e e n t i r es i m u l a t i o n
a r e ai s c o p i e d
i n c l u d i n gc y l i n d e r0 , t h e v o l u m el D , a n dt h e o w n e rl D i f
i t w a sp r e s e not n D 1 A .
Figure4-1O9. COPYAREA Example: Copy an Entire Simulation
Area

4-226

Explanation:
The entire R2 simulationarea(assigned
to the partition
i n w h i c h$ S C O P Yi s r u n n i n g )i s c o p i e dt o t h e s i m u l a t i o n
a r e a( D 3 H )a n d i s g i v e na v o l u m el D o f B K U p R 2a n d a n
owner lD of the R2 areaif one exists. After the copy is
c o m p l e t et,h e R 2 s i m u l a t i o n
a r e ai s c l e a r e do f a l l d a t a .
i t s o w n e rl D f i e l d i s b l a n k ,a n d i t r e t a i n si t s v o l u m el D
of R2R2R2. The R2 simulationareais now readyto be
the receiving
areaof a COpyAREA or anotherMOVE.
Figure4-110. MOVE Example: Copy an Entire Simulation
Area
with New Volume lD

Explanation:
The IPL (initialprogramload) recordsand the 3340 microcodearecopiedfrom cylinder0 of volume 1 to cylinder0
of volume33. A checkis madebeforethe copy to ensure
that the volumelD of volume33 is D33D33.
Figure 4-1 1 1. COPYIPL Example: Copy Cylinder 0 from
Votume I
to Volume 33

Explanation:
This control statementenablesyou to print on the system
p r i n t d e v i c et h e v o l u m el D o f a l l o n l i n ea n d a v a i l a b l e
volumes.This control statementalsoprovidesthe capability
to print an exceptionline, if needed.givingthe reasonfor
a n y u n a v a i l a b sl ei m u l a t i o na r e a .
Figure4-112. PRINT Example: print lD Information

Simufation Area Program-$SCOPY

4-227

Explanation:
A f t e r v e r i f y i n gt h a t t h e n a m e( v o l u m el D ) o f t h e s i m u l a t i o n a r e a( D 2 B )i s R 1R 1R 1 , t h e p r o g r a mc h a n g etsh e n a m e
( v o l u m el D ) o f t h e s i m u l a t i o na r e af r o m R 1R 1 RI t o
BACKUP.
F i g u r e 4 - 1 1 3 . N E W N A M E E x a m p l e : C h a n g i n gV o l u m e l D

4-224

I|
c

3340

A R E AN A M E S

$SCO
PY
M
M
.
S
S
E. l H u .
Tl
E G I P A C KE a
U
D
D1, Dl,D1,D1, F ] , F J , F 1 , R ] , R ] , R 1 P I D O O ] ,
PIDOO],
D2 D2D2D2 F 2 F 2 F 2 R2R2R2 BACKUP
D2DD2D

E,yt'ttnl tvv

Li NE
1,
2
3
4
5
6
7
I
JU
1 1

J J

L2

Item

Explanation

Il

Operatorresponse
C -

Canceldisplayand returnto readthe
next control statement

F -

Pageforwardto next display

B -

Pagebackwardto previousdisplay

T h e f i r s td i s p l a ys c r e e nw i l l h a v ea C i n t h i s
p o s i t i o ni f t h e r ei s n o s u b s e q u e n
d ti s p l a y .
I t w i l l h a v ea n F i n t h i s p o s i t i o nt o i n d i c a t e
thata subsequen
d ti s p l a yc o n t a i n i n g
addit i o n a li n f o r m a t i o ni s a v a i l a b l eT. h e l a s t
output pagewith availabledatawill have
a C i n t h i sp o s i t i o n .

a

The systemdate

E

T h e s y s t e mt i m e ( i f f u l l t i m e s u p p o r t )

tr
tr
tr

Maindataareacode
The lD of thevolume
T h ev o l u m el D o f t h e s i m u l a t i o n
area

Figure4-114. Example of Output from a NAMES Disptay

Simufation Area Program-$SCOPY

4-229

lt

3:,44a

F

V O L U M EE

D31,
D32
D33
D34

D3D3D3
D32D32
D33D33
D34D34

g
DRIVE 3
S
I M A R E AE
E
D3A D3AD3A
D3B D3BD3B
D3C D3CD3C
D3D D3DD3D

Item

Explanation

tl

Operatorresponse
C -

Canceldisplayand returnto readthe
next control statement

F -

Pageforward to next display

B -

Pagebackwardto previousdisplay

SiM
D3E
D3F
D3G
D3H

The first displayscreenwill havea C in this
positionif there is no subsequent
display.
It will havean F in this positionto indicate
that a subsequent
displaycontainingadditional informationis available.The last
output pagewith available
datawill havea
C in this position.

z

Type of disk drive

g

Disk drivenumber

!T

Maindataareacode

tr

The volumelD of the main dataarea

tr

The simulationareacode

E

The volumelD of the simulationarea

tr

Thesethree linesaredisplayedonly if drive
3 is a 3344

Figuro 4-115. Examplc of Output from a NAMES Dirplay

4-230

PY
$SCO
AREA
D3ED3E
D3FD3F
D3GD3G
D3HD3H

LI NE
1,

2
3
4
5
6
1
I
9
1r0
1r1,
1,2

F 3340
M I \ , I / D DY/Y

A R E AN A M E S

Epncr E n

$ S C OP Y L I N E
.1
H H . M I , IS
. S
!

2
En
Ec
ED
D ] , D 1 , D 1 . , D 1F. ,1 F 1 , F 1 , B A D V O L D1,CD1.,CD].,DD1.,D3
D2 Nor 0N LTNEGI
4
5
A

1
I
lr0
1t1'

1,2

Item

Explanation

It

D r i v eD l w a sa v a i l a b l et h; e r e f o r et.h e
v o l u m el D i s d i s p l a y e d .

a
E

tr
tr
tr
t

S i m u l a t i o na r e aD l A w a sa v a i l a b l et h; e r e f o r e ,i t s v o l u m el D i s d i s p l a y e d .
S i m u l a t i o na r e aD l B h a dn o v o l u m el D ;
therefore,BAD VOL is displayed.
S i m u l a t i o na r e aD 1 Cw a sa v a i l a b l et h; e r e f o r e ,i t s v o l u m el D i s d i s p l a y e d .
S i m u l a t i o na r e aD I D w a sa v a i l a b l et h; e r e f o r e ,i t s v o l u m el D i s d i s p l a y e d .
Volume D2 is not ready;therefore,its
v o l u m el D a n dt h e v o l u m el D s o f t h e s i m u l a t i o na r e a sa r en o t d i s p l a y e d .
The F (forwardcode)appearsindicating
t h a t a s u b s e q u e nd ti s p l a yc o n t a i n i n g
a d d i t i o n ailn f o r m a t i o ni s a v a i l a b l e .

Figure 4-116. Example of NAMES Display with Exception Output

SimulationAreaProgram-$SCOPY

4-231

LINE

3340
E X C E PI T
ON AREAS
S S C O P Y lJ
O V O L L A B E L D1B
z
I LABLE DZAI D2BI D2CI DzD
NAVA
3
4
5
6
1
B
9
lr0
1r1,

1'2

Item

Explanation

E

T h e C ( c a n c ecl o d e )a p p e a risn d i c a t i n g
that
t h i s i s t h e l a s td i s p l a yp a g e .

A

S i m u l a t i o na r e aD 1B d i d n o t h a v ea v a l i d
v o l u m el a b e l .

fl

T h e d e s i g n a t esdi m u l a t i o n
a r e a sw e r en o t
a v a i l a b lteo $ S C O P Y .

Figure4.117. Exampleof Exception Output with NAMES Display
Statement

4-232

Tape In itialization Program-gTl N I T
P R O G R A MD E S C R I P T I O N
T h et a p ei n i t i a l i z a t i opnr o g r a mh a st h e f o l l o w i n gf u n c t i o n s :
.

Checklabeledtapesfor a volumelabeland an unexpired
f i l e b e f o r ew r i t i n ga n e w v o l u m el a b e l .
C l e a rl a b e l e do r u n l a b e l etda p e sb y b y p a s s i nC
gHECK
a n d u n c o n d i t i o n a l liyn i t i a l i z i n tgh e t a p e .
D i s p l a yt h e v o l u m ea n d h e a d e lra b e l s .

The tape initializationprogramprepares
magnetictapesfor
use. This programwritesIBM standardvolumelabelson
tape in order for tapedata management
to perform IBM
standardlabelprocessing.
All tapesmust be initializedbeforeuse, Tapesthat have
b e e ni n i t i a l i z e d
n e e dn o t b e r e i n i t i a l i z eudn l e s sy o u w a n t t o
write a new volumelabelor usea tapethat containsa
p e r m a n e nf ti l e f o r o u t p u t . T h i s p r o g r a mc a ne i t h e ri n i t i a l i z e
( C L E A Ro r C H E C K )o r d i s p l a y( D l S p L A y ) o n et a p ep e r
u n i t d u r i n gt h e s a m ep r o g r a mr u n .

Tape Initialization Program-$TlNlT

4-233

C O N T R O LS T A T E M E N TS U M M A R Y
you mustsupplydependon the
The control statements
desiredresults.
Functions

C."at"l S,","]n""tt

Check for an
e x p i r e df i l e a n d a
label, then write a
new label.

il voLUNrrj;;f .REEL-{
):""" },rt"rr-.r..*t

(l)

o[

I r+!
'

[o'.,{tr}]

(H:n)-]

l,oerusrrv-{:33
II t.ro-**..
"*l

// END

W r i t ev o l u m el a b e l
without checking
for old label.

(ffiI

I

I_

{tr}l

'
u voL,,,",.cLEAR
[,o,.,,
{)":"**"f
lljl,REEL

xx
'xx
lxTfl'
,,=:[";.;
( T1 )

D i s p l a yv o l u m ea n d

O a
tlabers' , voLrr,r-lii
header
{#:l
l,r"r. ",rr,-J[,o.*r,r"
lzoo)J

l\ + ;/ \

L

(@1ll

[-''"'1il'iJ

// END

@ lf Oensityis not specified,the defaultfor 7-tracktape units is 800 bpi;the defaultfor 9-tracktapeunits is
1600 bpi. Other defaultsareunderlined.
T h e D E N S I T Yp a r a m e t eorn d i s p l a yv o l u m el a b e li s v a l i do n l y f o r 7 - t r a c kt a p eu n i t s .
Valid densityfor 7-tracktapeunits is 200,556, and 800 bpi. Valid densityfor 9-tracktape units is 800 bpi
o r 1 6 0 0b p i .

4-234

PARAMETER
SUMMARY
Parameters

Description

T Y P EC H E C K

C h e c k t o s e ei f t h e f i l e h a s e x p i r e d ; t h e n w r i t e a n e w l a b e l . D o n o t u s et h i s o n
b l a n k t a p e sb e c a u s et h e p r o g r a ma t t e m p t s t o r e a d a b l a n k t a p e , c a u s i n gt a p e
r u n a w a y . O n m u l t i f i l ev o l u m e s o
, n l y t h e f i r s tf i l e i s c h e c k e d .

Optional
(select

TYPE.CLEAR

o n e )e

W r i t e a n e w v o l u m e l a b e l w i t h o u t c h e c k i n gf o r a n e x p i r e d f i l e .

TYPE.DISPLAY

P r i n t t h e c o n t e n t so f t h e v o l u m e l a b e l a n d t h e h e a d e rl a b e l s .

UN lT-code ,equireO
|

S p e c i f i e sw h i c h t a p e d r i v e c o n t a i n st h e t a p e t o b e i n i t i a l i z e d . P o s s i b l ec o d e sa r e :
f 1 , f 2 , T 3 , a n d T 4 . A s e p a r a t eV O L s t a t e m e n ti s n e e d e df o r e a c h t a p e u n i t t h a t
c o n t a i n sa t a p e t o b e i n i t i a l i z e d ,c h e c k e d ,o r d i s p l a y e d .

REEL NL

R e q u i r e df o r
I
) TYPE-CHECK
REEL-xxxxxx) anO
TYPE-CLEAR

ASCil-YESI

S p e c i f i e st h a t a n u n l a b e l e dt a p e i s t o b e p r e p a r e d .
S p e c i f i e tsh e v o l u m es e r i a ln u m b e rt h a t t h e t a p e i n i t i a l i z a t i o np r o g r a mw r i t e so n
tape. Must be A.Z, O 9, $, #, or @.
T h e t a p e i s w r i t t e n i n A S C I I c o d e . T h i s i s i n v a l i df o r 7 - t r a c k t a p e .

/ optional
ASCil NO )

T h e t a p e i s w r i t t e n i n E B C D I C c o d e . l f t h e A S C I I p a r a m e t e ri s o m i t t e d , N O
isassumed.

DENSITY.2OO

T h e t a p e i s w r i t t e n a t a d e n s i t yo f 2 0 0 b p i ( b i t s p e r i n c h ) . T h e f i l e w r i t t e n o n
this tape unit must be written at this density.

DENSITY.556 Ootional

The tape is written at a densityof 556 bpi (bits per inch). The file written on
this tape unit must be written at this density.

(select

DENSITY.SOO

o n e)

DENSITY.l600

I

ID - x x x x x x x x x x O O t i o n a l
I

T h e t a p e i s w r i t t e n a t a d e n s i t yo f 8 0 0 b p i ( b i t s p e r i n c h ) . T h e f i l e w r i t t e n o n
this tape unit must be written at this density.
T h e t a p e i s w r i t t e n a t a d e n s i t yo f 1 6 0 0 b p i ( b i t s p e r i n c h ) . T h e f i l e w r i t t e n o n
this tape unit must be written at this density.
P r o v i d e sa n a d d i t i o n a l i d e n t i f i c a t i o nf i e l d . T h i s f i e l d i s n o t p r o c e s s e db y t h e
s y s t e m . A m a x i m u m o f 1 0 c h a r a c t e r sc a n b e u s e d i f A S C I I - N O i s s p e c i f i e d . l f
A S C I I Y E S i s s p e c i f i e d ,1 4 c h a r a c t e r sc a n b e u s e d .
I n d i c a t e st h e n u m b e r o f f i l e s f o r w h i c h h e a d e rl a b e l sa r e t o b e d i s p l a y e d . l f t h i s
p a r a m e t e ri s o m i t t e d , 0 0 1 i s a s s u m e d .T h e c o d e n n n c a n b e 1 t o 9 9 9 ( l e a d i n g

:l[il.p,.na,

z e r o sa r e n o t r e q u i r e d ) . l f F I L E S A L L i s s p e c i f i e da, l l l a b e l sa r e p r i n t e d .

e

ft f V p e i s r r o ts p e c i f i e dT,Y P E - C H E C K
i sa s s u m e d .

T a p e I n l t i a l i z a t i o nP r o g r a m - $ T l N l T

4-235

OCL CONSIDERATIONS

M E S S A G E SF O R T A P E I N I T I A L I Z A T I O N

T h e f o l l o w i n g O C L s t a t e m e n t sa r e n e e d e dt o l o a d t h e t a p e
i n i t i a l i z a t i o np r o g r a m .

N o t u : f h e f o l l o w i n g m e s s a g ei s p r i n t e d i f t h e p n n t e r i s
n o t a l l o c a t e dt o a n o t h e r p a r t i t i o n .

ll LOAD$TlNlT,cooe
// RUN
T h e c o d e y o u s u p p l y d e p e n d so n t h e l o c a t i o n o f t h e
s i m u l a t i o na r e ac o n t a i n i n gt h e p r o g r a m . p o s s i b l ec o d e s

Message

Meaning

INITIALIZATION

T h i s m e s s a g ies p r i n t e dw n e n
initialization
of a tapeis
c o m p l e t e . x x i n d i c a t e st n e
u n i t ( T 1, f 2 , T 3 , o r T 4 ) o n

ON
xx COMPLETE

a r eR l , F 1 , R 2 , F 2 .

w h i c h t h e i n i t i a l i z a t i o ni s
complete.

PRINTOUTOF VOLUME LABEL
T h e f o l l o w i n g s a m p l ej o b s s h o w t h e f o r m a t o f d a r a p n n t e d
b y t h e t a p e i n i t i a l i z a t i o np r o g r a m f r o m a g - t r a c k t a p e u n i t
a n d f r o m a 7 - t r a c kt a p e u n r t .
N o t e : f h e t a p e v o l u m e f o r e a c h u n i t c o n t a i n sf i v e f i l e s .
hr.i,

,rtNlr,FL

V
F i : l i Briyf,Jir i:i i ; - t i :l j ^ jl i: I )
y(i! iiii
r rt s _ a l l , u ^ " l i _ i
vUL

II yY Pl rL-- rl .l rS\pr t' !ry , f

ILr )-ALl ,-ttl_r.,

r

IAP E LAtlLaLDl SpLAy

U{ I I- TI
-----

F

F

F ! ! q r r r r - r u r l rl r l i a

1.,

q!q I
llJl
:l!l
cq!l
L0cl

7- !f 1
! lrz5
11t15
/t.-tt
711tt

:-----------

TAPT LAi]TL DISPLAY

-----

FM

F

F

r r L r - l c r r rr r r i r

A J

5 tq-

J0 ii I
c002
OJO]
JCJ4
J005

F I r EI
FILt2
FtLES
FILI4
FtLts

FILt

l l- a- it l5)
711)
a,3t\
7tlLt

77Ji)
/-tl5
lltt
/'zt,
tt..

IAt, F

LATJFL

U\IT-T]

;i i;--;iii-i Jrnili r[, f
0.JOI
JdO2
OJOJ
OOO4
JJJ>

FILEI
F ILE2
FILEJ
FILE4
FIL'r

r r ( E

rr0
JOor
o0o2
or0r
0004
0Jo5

4-236

. ^ ' . l.l l.f :!

r l L t - l - t \ l

FrLEr
r -I L r z
F I L EI
FIrrc
Fr r F )

tAPr2
IArFz
tro[)
tA),2
rap.)

t ) IS P L A I
f ILI

sri,r oare-

qqgl
771!t
C q gl
U|)t
C
!
!
I
l
, J u c i i l. lr i;ti i
O u ur
tt1t5

PEC
FCRI

TLK
ATTR

77tb
tiiii
t 'trl ti il 1
tiiii

r l L ,

s e, i i i r
r|pt-4
iacg+
iapr+
iic-r;
iaptc

/DI'ITAPECI
/DIlTAPECI
/or'tTAPECI
/DMTAP€CT
/ D r i .l a P € c I

I If{E-JO.Or.38

- ------F
PfC PLITK
LEAC
LE\C

J0I00
c0020
000 30
0c040
00050

DATL _ ]

00524
0J 100
000r0
00030
000 50

REC
i JL K
F C R P AI I R

c0cE

C ' J5 2 4
00 t00
000 )0
o0080
J J O5 r

DATt__tll11/77

/DHIAPECI
/DtITAP€OI
,/DHIAPECI
/OHTAP€OI
/IJt'IIAPECI

r trE-00.02.45

t r | tR CCTJE
l , L K

iEFn ii ,*
u
D
F
i
F

/ D MI A P E c l
/ D I . II A P E c l
/ D H T A PE
/DI{ IAP Ec l
/ O I I T A P €C I

E A D E R 2 - - - - - - - F E ( B L C C K3 t q c R q t \ G p R r R J 0 B N A T { F S I E P N A { E
Le f c
L E A C I E C F N I Q U EC N I R L
UU 1 0 J
iJ00 2 0
000 3 0
0 00 4 0
J J J i,J

F

STEPNAI{E

r IrE-O0.02-42
(hItlr

F F L

€ A D € R . 2- - - ---- --- RECCFIJING
PRTR
JO8\AMF
I E C F N I C U EC N T R L

I/II/J1

FILL sLRIAL_I!PL4

V { J l C F { . A l l c- rx ipal ipi -l

0052e
00 lco
00090
00J 80
000 50

SItPNAitt

L h ^ E i  Trpt-J
JCol
t Jrl
lapi:
/ 1 . 1 , / l ' . . t - t ' r l
, . . 1

r+s**
45LII TlPI LABiI

B
fJ
B
3
il

F
fF

5LRIAL-T!pE2

r ,{
l--------V ' ) L C T t E A I EE X p t R t F I L L
!ti)
rr^Tt
DAIE
St,ciAf

0ccl
!)tl
Q:!!
9v!l
lJcl

r IPE-00.02.34

T h A E PC O D E
--------------F
F a J t R
--r F ( c r L C K R f C C R C t \ GP R I R
t s LL
E!l
J.JdJ\AME
F CR l u A T T R L E ^ C L E N C I E C F T \ I Q U E
CNTPL

7' /7l 1I :1 5 r A P E I
tApr-i
2r31514o1i
7 / J I 5 r a p rI
77llr raPEi

U\II_I2

D A T E - t 1 , ,1 1 . 1 7 7

SFRTAL-T!ptl

r <
l------VUL CRLAIF FXPIRT
FILF
5ti]
UAIL
JATL
stRIAL

5 t0

OOOIFTLEI
OOO2FILE2
JJO] FILEJ
0J0{ FILEr
O O O 5F I L E 5

l lLE

B
!r
c
d
s

. f L

- - - - - r - , E A 0 f R
2----------i ] L C C K C E C O R IDN G ? $ ( I R J U S N A M t S I E P \ A r E
L € N G I E C F N T C U CEN T R L

LrAc

J0r00 0J524
0 0 0 2 00 0 1 3 0
0 0 0 3 00 J r r ? 0
J J o c J00080
0 0 , 1 5 00 0 0 5 0

/DHTAPECI
/DMTAPEOI
/DHTAPECI
/ o f l ' t A P € CI
/DH]APECI

M E A N I N GO F V O L U M EL A B E L I N F O R M A T I O N
Heading

Meaning

Volume Label
FILE SERIAL

T h e v o l u m es e r i a ln u m b e r ( f r o m t h e R E E L p a r a m e t e r ) .

OWNERCODE

A d d i t i o n a li d e n t i f i c a t i o n( f r o m t h e l D p a r a m e t e r ) .

H e a d e r1 L a b e l
FILE SEO

S e q u e n c en u m b e ro f t h e f i l e o n t h e v o l u m e .

FILE-IDENTIFIER

T h e f i l e n a m eo f t h e f i l e o n t a p e . T h i s i s t h e n a m ef r o m t h e L A B E L p a r a m e t e r
of
t h e O C L F I L E s t a t e m e nw
t h e n t h e f i l e w a sc r e a t e d .

VOL SEO

The sequence
n u m b e ro f t h i s v o l u m e I n a m u l t i v o l u m ef i l e .

CREATE DATE

The date this file was created.This is a Juliandate. The format yyddd
is
whereyy
i s t h e l a s tt w o d i g i t so f t h e y e a r a n d d d d i s t h e d a y i n t h e y e a r .
E x a m p l e : j 7 3 1 5 = t h e 3 1 5 t 1 -dra y o f 1 9 7 7 o r N o v e m b e r1 r j , 1 9 7 7 .

EXPIREDATE

T h e d a t e t h i s f i l e e x p i r e s .T h i s J u l i a nd a t e i s t h e c r e a t i o n . d a tpel u s t h e n u m b e r o f
d a y ss p e c i f i e db y t h e R E T A T Np a r a m e t e o
r n the ocL FrLE statement.

FILE SERIAL

T h e s e r i a ln u m b e ro f t h e t a p e v o l u m e . T h i s i s t h e s a m ea s t h e S E R I A L f i e l d i n
t h e v o l u m e l a b e l . H o w e v e r f, o r m u l t i v o l u m ef i l e s ,i t i s t h e s a m ea s t h e S E R I A L
f i e l d o f t h e f i r s t v o l u m e ' sv o l u m el a b e l .

H e a d e r2 L a b e l
REC FORM

BLK ATTR

T h e r e c o r df o r m a t o f t h i s f i l e ( f r o m t h e R E C F I Mp a r a m e t e or n t h e o C L F I L E
s t a t e m e n tw h e n t h i s f i l e w a s c r e a t e d ) . T h e f o r m a t s a r e :
F -

F i x e dl e n g t h

V -

V a r i a b l el e n g t h

U -

U n d e f i n e dl e n g t h

B l o c ka t t r i b u t e s :
B

-

B l o c k e dr e c o r d s

S

-

S p a n n e dr e c o r d s

R

-

B l o c k e d a n d s p a n n e dr e c o r d s

b l a n k-

N e i t h e rb l o c k e dn o r s p a n n e d

/i/ofe.' Spanned recordscannot be created on Svstem/3.

Tape Initialization'rogram-$TlNlT

4-237

Heading

Meaning

REC LENG

R e c o r dl e n g t h( f r o m t h e R E C L p a r a m e t e or n t h e O C L F I L E s t a t e m e n w
t henthis
f i l e w a s c r e a t e d) .

BLOCK LENG

B l o c k l e n g t h( f r o m t h e B L K L p a r a m e t e or n t h e O C L F I L E s t a t e m e n w
t henthis
file wascreated).

R E C O R D I N GT E C H N I O U E

T

-

O d d p a r i t yw i t h t r a n s l a t i o n

C

-

Odd parity with conversion

E

-

E v e np a r i t y w i t h o u t t r a n s l a t i o n

ET

-

E v e np a r i t y w i t h t r a n s l a t i o n

blankPRTR CNTRL

P r i n t e rc o n t r o l c h a r a c t e r .T h i s f i e l d i s b l a n k o n t a p e sc r e a t e do n S y s t e m / 3 .
F o r t a p e sc r e a t e do n o t h e r s y s t e m s t, h e c h a r a c t e r sa r e :
A

-

ASCII control characters

M

-

M a c h i n ec o n t r o l c h a r a c t e r s

blank JOBNAME/STEPNAME

4-234

O d d p a r i t y w i t h o u t t r a n s l a t i o no r c o n v e r s i o n

No control characters

l d e n t i f i e st h e j o b t h a t c r e a t e dt h e t a p e . T h e J O B N A M E f i e l d c o r r t a i n tsh e j o b
n a m ea n d t h e S T E P N A M Ef i e l d c o n t a i n st h e n a m e o f t h e s t e pw i t h i n t h e j o b .
T h e J O B N A M E i s b l a n k i f J O B N A M E i s t h e s a m ea s S T E P N A M E .

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued 28 Seotember 1979
By TNL: GN21-5674

TapeErrorSummaryProgram-$TvES
P R O G R A MD E S C R I P T I O N
T h et a p ee r r o rs u m m a r yp r o g r a mh a st h e f o l l o w i n g
function:
Displaymagnetictapeerrors
The IBM System/3Model 15 keepsan accountof errors
that occuron the tapedrives.This error informationis
storedon one of the customerengineertrackslocatedon
the volumefrom which an IPL is performed.The Tape
Error Summaryprogramprovidesa summary.by volume
and by unit, of temporaryreadand write errors.
This programdoesnot resetthe disk areathat containsthe
errorstatistics.Therefore,you shouldperiodicallyrun
$TVES to preventthe overlayingof dataon the track.
(Thesystemwill not issuea message
if the data is overlaid.)
Thereareno control statements
necessary
for this program.
After beingloadedfrom the programor systempack,the
tapeerror summaryprogramreadsthe datafrom the disk
and sortsit by volumeand unit. Whenall the data is read
o r t h e a v a i l a b lm
e a i ns t o r a g e
i s f i l l e d ,t h e e r r o rd a t ai s
printed. lf no tapeerrorsarerecorded.the message
T H E R EA R E N O V A L I D T A P EE R R O R SL O G G E Di s
printed.

Tape Error Summary Program-$TVES

4-239

E R R O RL O G G I N GF O R M A T

S U M M A RI Y
' I A G N E T iT
CA P E E R R O RS T A T I S T I C SB Y V O L U M E
D A T E 0 3 / 2 7/ 7 6

o

o

@

VOLUI'IE SIO
TEMP
SERIAL COUNT READ
T1,
T APE ] ,
TAPE3

o

TEMP
WRITE

0651,2 0ooo
0028
0001,6
o00o
0001,
OOO21, OOOO OOOI,

@

WRITE
SKIP
oo28
ooot
OOOI,

S U M M A RMYA G N E T I T
C A P E E R R O RS T A T I S T I C SB Y T A P E U N I T
DATE 03/21/76

@

TAPE
UNIT

o

e

o

@

SIO
TEMP TEMP WRITE DIAG
COUNT READ '.JRITE SKIP
TRACK

T1,

06528

T4

OOO21., OOOO

o o o0

o o2 9

oo29

o oo 0

OOOI,

OOO],

OOOO

/l

\9

F o r a n y f i l e t h a t h a s m o r e t h a n t w o v o l u m e so n a u n i t , , , , , , i s p r i n t e d
a s t h e v o l u m e s e r i a lf o r a l l v o l u m e so n t h a t
u n i t e x c e p t t h e l a s tv o l u m e .
For a tape that is not being used by tape data management
,,.,,, is printed as the volume serial.
F o r n o n - l a b e l e dt a p e s * * * * * *
the volume serial.

i s p r i n t e d a s t h e v o l u m e s e r i a l . F o r t a p e sw i t h n o n s t a n d a r dl a b e l s ,N S p r i n t e d
is
as

@ fn. numberof tapeoperationsperformed(SlO meansStart l/O).
@ T.rnporuryreaderrors.
O

T.roor.ry write errors.

.^
\9 Writeskipscaused
by temporary
writeerrors.
O

oiunno.,ictrack errors. This is usedby rBM customerengineers.

OCLCONSIDERATIONS
The followingOCL statements
areneededto load the tape
e r r o rs u m m a r yp r o g r a m
// LOAD $TVES,code
// RUN
The codeyou supplydependson the locationof the simul a t i o na r e ac o n t a i n i n tgh e p r o g r a m .p o s s i b lceo d e sa r e
R 1 .F 1 .R 2 , F 2 .

4-240

VTOC ServiceProgram-$WVTOC
P R O G R A MD E S C R I P T I O N
The VTOC serviceprogramhasthe followingfunction:
Compress
a VTOC
F o r p o s s i b l iem p r o v e dp e r f o r m a n cien f i l e a c c e stsi m e .a l l
f i l e d i r e c t o r ye n t r i e sa r em o v e dt o t h e b e g i n n i n og f t h e
V T O C ( v o l u m et a b l eo f c o n t e n t s ) .

C O N T R OL S T A T E M E N TS U M M A R Y
The control statements
you must supplydependon the
desiredresults.
Function

Control Statements

M o v ea l l a c t i v ef i l e d i r e c t o r y
entriesto the beginningof the
VTOC

SA C K - n a m e , U N l T - c o d e
/ / C O M P R E Sp
END
//

P A R A M E T E RS U M M A R Y
Parameter

Description

PACK-name
UNIT-code

Name of the main data area
Location of the area. Possiblecodes are those for the main data areas.

P A R A M E T E RD E S C RPI T I O N S
PACK Parameter
T h e P A C Kp a r a m e t e(rP A C K - n a m et e) l l st h e p r o g r a mt h e
nameof the main dataareaon which the VTOC is to be
compressed.The VTOC serviceprogramcomparesthe
n a m ei n t h e P A C Kp a r a m e t ewr i t h t h e v o l u m el a b e lo f t h e
areato ensurethat they match.

UNIT Parameter
T h e U N I T p a r a m e t e(rU N I T - c o d et)e l l st h e p r o g r a mt h e
locationof the VTOC to be compressed.possiblecodes
arethosefor the main dataareas.

VTOC Service Program-$WVTOC

4-241

OCLCONSIDERATIONS
The followingOCL statements
areneededto load the
VTOC serviceprogram:

Figure4-95 showsthe control statements
neededto
compressa VTOC.

// LOAD $WVTOC.code
// RUN
The codeyou supplydependson the locationof the
simulationareacontainingthe VTOC serviceprogram.
P o s s i b fceo d e sa r e R 1 , F 1 , R 2 , F 2 .

Explanation:
.

EXAMPLES
Figure4-118 showsthe OCL statements
neededto load
the VTOC serviceprogram.

The maindataareacontainingthe VTOC to be compressedis named00003 (PACK-00003in the COMPRESS
statement).

o The main dataareacontainingthe VTOC to be comp r e s s eids o n v o l u m e1 o f d r i v e3 ( U N I T - D 3 )
Figure 4-119. Control Statements for Compressing a VTOC

Explanation:
V T O Cs e r v i c e
p r o g r a mi s l o a d e df r o m F 1 .
Figure 4-94. OCL Load Sequenca for VTOG Servicl program

+242

AppendixA. IBM System/3StandardCharacter
Set

Character
Blank
d

Hexadeciaml
Equivalent

40

&

$

*

-l
(minus)

%
- (underscore)

7

O

Hexadecimal
Equivalent

Character

Hexadecimal
Equivalent

#

7B

o

D8

@

7C

R

D9

7D

S

E2

4C

7E

T

E3

4D

7F

U

E4

4A
4B

(

Character

' (apostrophe)

4E

A

c1

4F

B

c2

W

E6

50

c

C3

X

E7

5A

D

C4

5B

E

c5

z

E9

5C

F

C6

0

FO

5D

G

C7

1

F1

5E

H

C8

2

F2

5F

C9

3

F3

60

Doo

4

F4

E5

E8

61

J

DI

5

F5

6B

K

D2

6

F6

6C

L

D3

7

F7

6D

M

D4

8

F8

6E

N

D5

9

F9

6F

o

D6

7A

P

D7

O n t h e C R T a X ' D 0 ' d i s p l a ya
s sa n & .

A p p e n d i x A . I B M S y s t e m / 3 S t a n d a r d C h a r a c t e rS e t

A-1

A-2

Appendix B. CalculatingFile Size

The factorsthat control file sizeareexplainedin the t8M
System/3 Disk Conceps and Planning Guide, GC21-7571.
The structureof a file (sequential,
direct,or indexed)on
the maindata areaof a 3340 or 3344 is virtuallyidentical
to the structureof a file on the 5445. The maindata area
on a 3340consistsof 48 recordsper track and 166 cylinders;eachmaindataareaon a3344 consistsof 48 records
per track and 186 cylinders;the 5445 consistsof 20 records
(sectors)per track and 200 cylindersper disk pack.

DATA AREA TRACK REOUIREMENTS
Sequential,
direct,and indexeddataareasareall structured
the same. FigureB-1showsthe numberof tracksneeded
to storea givennumberof logicalrecords,usingvarious
logicalrecordlengths.

F o l l o w i n gi s a l i s t o f s i m i l a r i t i ebse t w e e nt h e 5 4 4 5 , 3 3 4 0 ,
and 3344:
o I n d e xe n t r i e sa r ec a l c u l a t euds i n gt h e f o l l o w i n gf o r m u l a :
key length+ 4.
o Indexand dataareasarecontainedon wholetracks.
a Indexedfileswith indexesof 16 tracksor more have
spacereserved
for a track index.
o Spannedrecordsare used.
o The indexareamust haveat leastone extra record
(sector)for a delimiter or at leastthreeextra records
(sectors)if additionswill be madeto the file
o Thereare 20 tracksper cylinder(3980trackson the
5 4 4 5 ; 3 3 2 0t r a c k so f m a i nd a t aa r e ao n t h e 3 3 4 0 ; 3 7 2 0
tracksof main dataareaon the 3344).
The followingtablesand discussion
includethe specific
informationnecessary
to evaluatefile sizeon the 3340 or
3344 maindataarea.

A p p e n d i x B . C a l c u l a t i n gF i l e S i z e

B-1

N U M B E RO F T R A C K S I
Logical Record
Length 50
J34t)

Logical Record
Length 64
534U

Numberof
Logical
Records

5/,45

33r',4

5445

3344

500
1000
1500
2000
2500
3000
3500
4000
4500
5000
5500
6000
6500
7000
7500
8000
8500
9000
9500
10,000
10,500
11,000
11 , 5 0 0
12,000
12,500
13,000
13,500
14,000
14,500
15,000
15,500
16,000
16,500
17.000
17,500
18,000
18,500
19,000
19,500
20,000
21,000
22,OOO

5
10
15
20
25
30
35
40
44
49
54
59
64
69
74
79
84
88
93
98
103
108
113
118
123
127
132
137
142
147
152
157
162
167
171
176
181
186
191
196
206
215

3
5
7
I
1'.!
13
15
17
19
21
23
25
27
29
31
33
35
37
39
41
43
45
47
49
51
53
55
57
60
62
64
66
68
70
72
74
76
78
80
82
86
90

7
13
19
25
32
38
44
50
57
63
69
75
82
88
94
100
107
113
119
125
132
138
144
150
157
163
169
175
182
188
194
200
207
213
219
225
232
238
244
250
263
275

3
6
8
11
14
16
19
21
24
27
29
32
34
37
40
42
45
47
50
53
55
58
60
63
66
68
71
73
76
79
81
84
86
89
92
94
97
99
102
105
110
115

tThe

and

Logical Record
Length100
3340
and

Logical Record
Length 128
334U
and

il45

334,4

il45

3344

5445

334'4

10
20
30
40
49
59
69
79
88
98
108
118
127
137
147
157
167
176
186
196
206
2',15
225
235
245
zil
264
274
2U
293
303
313
323
333
342
352
362
372
381
391
411
430

5
I
13
17
21
25
29
33
37
41
45
49
53
57
62
66
70
74
78
82
86
90
94
98
102
106
110
114
119
123
127
131
135
139
143
147
151
155
159
163
171
180

13
25
38
50
63
75
88
100
113
125
138
150
163
175
188
200
213
225
238
250
263
275
248
300
313
325
338
350
363
375
388
400
413
425
438
450
463
475
488
500
525
550

o
11
16
21
27
32
37
42
47
53
58
63
68
73
79
84
89
94
99
105
110
115
120
125
131
136
14'l
146
152
157
162
167
172
178
183
188
193
198
204
209
219
230

25
50
75
100
125
150
175
200
225
250
275
300
325
350
375
400
425
450
475
500
525
550
575
600
625
650
675
700
725
750
775
800
825
850
875
900
925
950
975
1000
1050
11 0 0

11
21
32
42
53
63
73
84
94
105
115
125
136
146
157
167
178
188
198
209
219
230
240
250
261
271
282
292
303
313
323
334
344
355
365
375
386
396
407
417
438
459

and

number of tracks for data recordsdoes not include indexes. For the 330

s i m u l a t i o na r e a .
F i g u r e B - 1 ( P a r t 1 o f 2 1 . D i s k R e q u i r e m e n t sf o r D a t a R e c o r d s

B-2

Logical Record
Length 256

3340
and

and 3344, this is the main data area,not the

N U M B E RO F T R A C K S .

Numberof
Logical
Records

23,000
24,OOO
25,000
26.000
27,OOO
28,000
29,000
30,000
31,000
32,000
33.000
34,000
35,000
36,000
37,000
38,000
39,000
40,000
41,000
42pOO
43,000
44,000
45,000
46,000
47.000
48,000
49,000
50,000
75,000
100,000
125,000
150,000
175,000
200,000
rThe

Logical Record
Length50
3340

LogicalRecord
Length il

and

il45

225
235
245
2il
2U
274
284
293
303
313
323
333
342
352
362
372
381
391
401
411
420
430
440
450
459
469
479
489
733
977
1221
1465
1709
1954

33/,4
94
98
't02
106
110
114
119
123
127
131
135
139
143
147
151
155
159
163
167
171
175
180
1U
188
192
196
200
204
306
407
509
611
713
814

5445
288
300
313
325
338
350
363
375
388
400
413
425
438
450
463
475
488
500
513
525
538
550
563
575
588
600
613
625
938
1250
1563
18 7 5
2188
2500

Logical Record
Length 100

Logical Record
Length 128

3340

3340

3340

and

and

and

3344
120
125
131
136
141
146
't52
157
162
167
172
178
183
188
193
198
204
209
214
219
224
230
235
240
245
250
256
261

39r
521
652
782
912
1042

5/,45
450
469
489
508
528
il7
567
586
606
625
645
665
684
704
723
743
762
782
801
821
840
860
879
899
918
938
958
977
14 6 5
1954
2442
2930
3418
3907

33p,4
188
196
204
212
220
228
237
245
253
261
269
277
285
293
302
310
318
326
334
342
350
359
367
375
383
391
399
407
611
814
101
8
1221
1425
1628

5tt45

575
600
625
650
675
700
725
750
775
800
825
850
875
900
925
950
975
1000
1025
1050
10 7 5
11 0 0
1125
11 5 0
1175
1200
1225
1250
1875
2500
3125
3750
4375
s000

3344
240
250
261
271
282
292
303
313
323
334
344
355
365
375
386
396
407
417
428
438
448
459
469
480
490
500
511
521
782
1042
1303
1563
1823
2084

Logical Record
Length 256

3340
and

il45
1150
1200
1250
1300
1350
1400
1450
1500
1550
1600
1650
1700
1750
1800
1850
1900
1950
2000
2050
2100
2150
2200
2250
2300
2350
2400
2450
2500
3750
5000
6250
7500
8750
10,000

3344
480
500
521
v2
563
584
605
625
646
667
688
709
730
750
771
792
813
834
855
875
896
917
938
959
980
1000
1021
1042
1563
2084
2605
3125
3646
4167

n u m b e r o f t r a c k s f o r d a t a r e c o r d sd o e s n o t i n c l u d e i n d e x e s . F o r t h e 3 3 4 0 a n d 3 3 4 . 4t h i s i s t h e m a i n d a t a a r e a ,n o t t h e s i m u l a t i o n a r e a .

Figure B-l lPart 2ot 2). Disk Requirements for Data Records

A p p e n d i x B . C a l c u l a t i n gF i l e S i z e

B-3

I N D E XA R E A T R A C K R E O U I R E M E N T S
I n d e x e df i l e sa l s or e q u i r et r a c k sf o r t h e f i l e i n d e x . T h e
followingchart showshow many keyscan be contained
o n o n et r a c ko f t h e f i l e i n d e x .

Key-Length

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

Numberof Keysper lndex Track
5445
3340 and 3344

'to20
840
720
640
560
500
460
420
380
360
340
320
300
280
260
240
240
220
220
200
200
180
180
180
160
160
160
160
'140

2448
2016
1728
1536
1344
't200
't104
1008
912
864
816
768
720
672
624
576
576
528
528
480
480
432
432
432
384
384
384
384
336

Sincethere is one key for eachlogicaldata recordin the
f i l e ,t h e n u m b e ro f t r a c k sr e q u i r e df o r t h e f i l e i n d e xi s
easilycalculatedfor a givennumberof logicalrecords.

T h e i n d e xa r e aa l s oi n c l u d e a
s d i s kt r a c k i n d e xi f t h e f i l e
i n d e xr e q u i r e s1 6 o r m o r et r a c k s . F i g u r eB - 2s h o w st h e
f i l e s i z e ss u p p o r t e d
b y o n e t r a c ko f t h e d i s kt r a c k i n d e x
for variouskey lengths.

File Capacity

Key-Lensth
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

lNumber
t *:i:l::iliL
1,040,400
705,600
5r 8,400
409,600
313,600
250,000
211,600
176,400
144,400
129,600
115,600
102,400
90,000
78,400
67,600
57,600
57,600
48,400
48,400
40,000
40,000
32,400
32,400
32,400
25,600
25,600
25,600
25,600
19,600

5,992,704
4,064,256
2,985,984
2,359,296
1,806,336
1,440,000
1, 2 1 8 , 8 1 6
1,016,064
831,744
746,496
665,856
589,824
518,400
451,584
389.376
331,776
331,776
218,7U
278,784
230,400
230,400
186,624
186,624
186,624
147,456
147,4ffi
147,456
147,456
11 2 , 8 9 6

Figure B-2. File Capacity for One Track of Disk Track Index

T R A C K I J S A G EF O R I N D E X F I L E S
W h e nl o a d i n ga n i n d e x e df i l e ,y o u s p e c i f ye i t h e rt h e n u m ber of recordsin the file or the numberof tracks. When
you specifythe numberof tracks,the systemdetermines
how the specifiedspaceis to be split amongdatatracks,
f i l e i n d e xt r a c k s a
, n dd i s k t r a c k i n d e xt r a c k s . F i g u r eB - 3
illustrateshow the systemsplitsan areaon the 3340 or
3344 whenthe TRACKS parameteris usedin the OCL
statement,and illustratesthe maximumrecordcapacities
f o r v a r i o u ss i z ei n d e x e df i l e s . R e m e m b et ro u s et h e s m a l l e r
of the two numbers: number of keys,or number of logical
data records.

Numberof
Tracks

5
5
5
5
5
5
10
10
10
10
10
10
50
50
50
50
50
50
100
r00
100
100
100
100
500
500
500
500
500
500
1,000
1,000
1,000
1,000
1,000
r,000
2,000
2,000
2,000
2,000
2,000
2.000
3,000
3,000

Key
Length

5
5
5
10
10
10
5
5
5
10
l0
t0
5
5
5
10
10
10
5
5
5
10
10
10
5
5
5
10
10
10
5
5
5
10
10
10
5
5
5
10
10
10
5
5

Logical
Record
Length

Disk Track
Index

g
128
256

u
128
256
&l
128
256
dl
128
256
64
128
256
04
128
256

u

128
256
64
128
256

u
128
256
a4
128
256
il
128
256

u
128
256
64
128
256

u

't28
256
il
128

Numberof
File Index
Tracks
I
1
I
1
1
1
2
1
1
2
1
1
7
4
2
I
5
3
13
7
4
18
l0
6
63

u
18
91
50
27
125
67
35
182
100
53
250
134
69
364
200
106
375
200

Number of
Data Tracks
4
4
4
4
4
4
8
9
9
I
9
I
43
46
48
41
45
47
87
93
96
81
90
94
436
465
481
408
449
472
874
932
964
817
899
946
1,749
1,865
1,930
1,635
1.799
1,893
2,624
2,799

Numberof
Keys

1,316
1,316
1,316
846
846
846
2,660
1,316
1,316
1, 7 1 0
846
846
9,380
5,348
2.660
7,758
4,302
2,574
17,444
9,380
5,348
15,534
8,622
5,166
u,u4
45,668
24,1U
78,606
43,182
23,310
167,972
90,020
47,O12
157,230
86.382
45,774
335,972
180,068
92,708
314,478
172,786
91,s66
n3,972
268,772

Numberof
LogicalData
Records

768
384
192
768
384
192
1,536
864
432
1,536
864
432
8,256
4,416
2304
7,8t2
4,320
2,256
16.704
8,928
4,608
15,552
I.eo
4,512
83,712
44,640
23,088
78,336
43,104
22,656
167.808
89,472
46,272
156,864
86.304
45,408
335,808
179.040
92,&0
313,920
172,704
90,864
503,808
268,704

Figure B-3 (Part 1 of 2). Sample Rocord Capacities of Indexed Files

A p p e n d i x B . C a l c u l a t i n gF i l e S i z e

B-5

Numberof
Tracks

Key
Length

3,000
3,000
3.000
3,000
3,320
3,320
3,320
3320
3.320
3.320

5
10
10
10
5
5
5
10
10
10

Logical
Record
Length
256
i
128
256
64
128
256

Disk Track
Index
1
l

104
il6
300
158
415
222
115
604
332
175

1
1
1
1
1
1

u

1

128
256

1
1

Numberof
File Index
Tracks

Figure B-3 (Part 2 of 2). Sample Record Capaciries of Indexed Files

C O R EI N D E X
T h e c o r ei n d e xi s a t a b l eo f p o i n t e r st o t h e i n d e xt r a c k so f
a n i n d e x e df i l e . T h e c o r ei n d e xi s b u i l t j u s t b e f o r ey o u r
C O B O Lo r R P Gl l p r o g r a mi s e x e c u t e d
a n d c o n t a i n sa, t
most,one entry for eachindextrack. FigureB-4shows
the numberof bytesof main storagerequiredfor a core
indexthat providesthe most efficientrandomprocessing
o f a n i n d e x e df i l e , u s i n gk e y l e n g t ha n d n u m b e ro f l o g i c a l
r e c o r d sa sv a r i a b l e s .
Key
Length
4
5
6
7
8
I
10
11
12
13
14
15
16
17
18
19
20

2

12
14
't6
18
20
33
36
39
42
45
48
68
72
76
80

u

110

(Numberof LogicalRecordr(in 1000s)
5
8
10
15
20

24
28
40
45
50
66
72
91
98
105
128
153
162
171
200
210
242

36
42
56
72
80
99
120
130
1il
180
192
221
252
266
320
336
374

42
56
72
90
100
121
144
169
196
210
240
289
324
342
280
399
462

60
84
104
126
150
187
216
247
280
315
368
425
486
513
580
609
704

84
105
136
171
200
242
288
325
378
420
480
561
630
665
760
798
924

S0
198
266
336
414
500
605
696
806
924
1,050
1,200
1,377
1.566
1,653
1,900
1,995
2,310

Figure B-4. Core Index Sizes for 3340 and 3344 Single Volume Indexed Files

B€

Numberof
Data Tracks

2,895
2,453
2,699
2,Ul
2,904
3,097
3,204
2,715
2,987
3,144

Number of
Keys

139,748
471,726
259,182
136,494
557,732
298340
1U,532
521,838
286.830
151,182

Numberof
LogicalData
Records

138,960
470,976
259,104
136,368
557,568
297,312
153,792
521,280
286,752
150,912

C A L C U L A T I N GF I L E S I Z E S( M A I N D A T A A R E A ) SUMMARY

4.

= n u m b e ro f i n d e xt r a c k s( r o u n dt o t h e n e x t
h i g h e sw
t h o l en u m b e r )

This sectioncontainsstep-by-step
explanations
of some
c o m m o nc a l c u l a t i o nosf f i l e s i z e s

Determiningthe Numberof Tracksin a Sequentialor
Direct File
1.

Numberof logicalrecordsx logicalrecordlength
= numberof characters

.

(from step 1)
Numberof characters
12,288 (numberof characters/track
)

Numberof records(from step3)
48 (numberof records/track)

Determiningthe Numberof Tracksof Disk Track Index
l f a n i n d e x e df i l e h a sm o r et h a n 1 5 i n d e xt r a c k s( f r o m
s t e p4 i n t h e p r e c e d i ncga l c u l a t i o n t)h, e f i l e w i l l h a v ea
d i s kt r a c k i n d e xi n a d d i t i o nt o t h e f i l e i n d e x . T h e f o l l o w ing two stepsshouldbe usedto determinethe numberof
tracksneededfor the disk track index:
1.

= numberof tracks(roundto the next highest
w h o l en u m b e r )

Numberof entriesper record(from step2 of precedi n gc a l c u l a t i o n )
x numberof recordsper track (48)
= keysper track

Determiningthe Numberof Tracksin an IndexedFile
(Main Data Area)
To determinethe numberof datatracksin an indexedfile.
the followingtwo stepsshouldbe used:
1.

2.

Numberof logicalrecordsx logicalrecordlength
= numberof characters
(from step 1)
Numberof characters
'l
2,288 (numberof characters/track
)
= numberof datatracks(roundto the next highest
w h o l en u m b e r )

The followingfour stepsshouldthen be followedto determ i n et h e n u m b e ro f f i l e i n d e xt r a c k si n a n i n d e x e df i l e :

2.

N u m b e ro f i n d e xt r a c k s( i f g r e a t etrh a n 1 5 )
= n u m b e ro f d i s kt r a c k i n d e xt r a c k s( r o u n dt o t h e
n e x t h i g h e sw
t h o l en u m b e r )

The total numberof tracksin an indexedfile can be
determinedby addingthe numberof datatracks,the
n u m b e ro f f i l e i n d e xt r a c k s a
, n dt h e n u m b e ro f d i s kt r a c k
indextracks.

ConvertingCylinder/Trackto Track Number
. ultiply
T o c o n v e r ct y l i n d e r / t r a ctko t r a c k n u m b e r m
c y l i n d e rn u m b e rb y t h e n u m b e ro f t r a c k so n e a c hc y l i n d e r
a n da d d t r a c kn u m b e r .

1.

K e y l e n g t h+ 4 = i n d e xl e n g t h

2.

256 (numberof characters/record)
I n d e xl e n g t h( f r o m s t e p1 )

Examples:

= numberof entriesper record(drop remainder)

S i m u l a t i o na r e a

3.

Numberof logicalrecords
@rd(fromstep2)
= numberof records(roundto the next highest
whole number;then. add one recordfor a delimiter, and two or more additionalrecordsif you
plan to add logicalrecordsto the file later)

6/1 = cylinder/track
6 x 2 + 1= 13
1 3 = t r a c kn u m b e r
Maindata areaon 3340 and 3344
6/1 = cylinder/track
6x20+1=121
1 2 1= t r a c kn u m b e r

A p p e n d i x B . C a l c u l a t i n gF i l e S i z e

B'7

ConvertingTrack Numberof Cylinder/Track
To converttrack numberto cylinder/track,dividetrack
numberby the numberof trackson a cylinder. The
quotient is the cylinderand the remainderis the
track.

Examples:
Simulationarea
1 3 = t r a c kn u m b e r
1 3 + 2 = 6 ( r e m a i n d1
e )r
6/1 is the cylinder/track
Maindataareaon 3340 and 3344
1 2 1 = t r a c kn u m b e r
121+20=6(remainderl)
6/1 is the cylinder/track

B€

(OCC)
AppendixC. OperatorControlGommands

O C CS U M M A R Y
All operatorcontrol commands(OCC)areenteredfrom
t h e C R T / k e y b o a r dB
. y u s i n gO C C ,y o u c a nc o m m u n i c a t e
with the systembefore,during,or after job execution.
You can alsousethe OCCfunction to entercommentsin
the systemhistoryarea. Eachcommentis identifiedby an
a s t e r i s ikn p o s i t i o n1 . A m a x i m u mo f 4 0 c h a r a c t e r isn, c l u d ing the asterisk,can be entered. For a completedescription
of OCC, seethe IBM System/3 Model l5 Operator's Guide,
GC21-5075.

I N F O R M A T I O NA B O U T S Y N T A X I L L U S T R A T I O N S
letters,numbers.and commasmust be entered
Uppercase
for the
indicatean abbreviation
asshown. Parentheses
item above. Do not enterbrackets,braces,or parentheses.
variables.
itemsrepresent
Lowercase
I t e m so r g r o u p so f i t e m sw i t h i n b r a c k e t s[ ] a r eo p t i o n a l e n t e ro n e o r n o n e .
one.
Itemsin braces{ ) arealternatives-enter
O p t i o n a il t e m st h a t a r eu n d e r l i n e idn d i c a t et h e d e f a u l t
v a l u e . l f n o n eo f t h e i t e m si s e n t e r e dt,h e d e f a u l tv a l u e
isused.
All operandsarepositional.Operandsmust be entered
in the order shown. lf any operand(exceptthe last)
i s o m i t t e d ,a c o m m am u s tb e e n t e r e di n i t s p l a c e .
Theremust be at leastone blank betweenthe command
and the operands.The first blankafter the operands
startterminatesthe operands.Theremust be only
blanksafter the lastoperand.

Appendix C. Operator Control Commands (OCC)

C'1

Pageof GC21-S162-1
lssued28 September1979
8y TNL: cN2t-5674

CANCEL
(cN)

Cancelsprogramexecutionin
a partition. The 2 or 3 follow_
i n gt h e P 1, P 2 , o r p 3 i n d i c a t e s
t h e o p t i o no f t h e c a n c e l .

fl

Cancelsspoolingsupport(at
I P Lo n l y ) .

SPOOL

(sP)
"RDRO
(*RO)
"PRTO

(*wo)

Cancelsthe entire queue.

*PCHO

("Po)
RDRo,{ ,-:on.r" _.f

(RO) ( characters**/

P R T o ,{ l l o n a m e - - 1 [ , s t e P n a m eI
(WO) (characters**/[rcharacters*J
pcHo- l looname I
* +f
(po) t characters

c-2

f-,stepnameI
*
l, characters
ll

Cancelsa job or job step,or
multiplejobs or job steps.

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

Command

CHANGE
(G)

I

Function

Operands

coRE,size,
tirtJl, {:".?:il;,..}
(enro
CPY,Inumber,
,{i:fil l '1,,o'n.,.,.,,
*1
characters*
( ,ro, |

f

-|
cRD,card,ro., {'"'n::il:',.
/
[fff],
FRM,rorm
s,,0,, o
*\
[*,* J, {'""#il;,,,f

[, steoname I
lrcharacters**J

the mainstorage
Changes
numberof
requirements.
copies,cardtype.forms
type, partitionassignment,
or iob priority of a job or
job stepor multiplejobs
or job stepson a queue.

[-,stePnameI
[-rcharacters*l
[, steonameI
[, characters*]J

fil
*-

.jobname
lll tH*t

tsl

j:onttt
RDRo.l
--|
(RO) I cnaracters)

'-lil

.}
iil,ll'{'.",.'.:il:,...
i?:i'{:"J.?il:,,..}

l-,stepnameI
l, characters*
J
[-,stepnameI
]l
[-,characters*

DATE
(DT)

{mi.i?'l
l::ffiJ't

Setsthe systemand partition
dates.

Appendix C. Operator Control Command (OCC)

C'2''l

P a g eo f G C 2 1 - 5 1 6 2 - l
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

DISPLAY
(D)

F,,,
lliil

I

LNJ

tast]
lHrsronv'[,t.rr-l
L
r [,

l(H)

l,uo,o

F:.
ll-T"

I enro
l(wo)
lecuo

D i s p l a y st h e s y s t e ms t a r u s ,
partition status, and
a r e an a m e s .

Displays the history of the
entire system or of one
through seventasks.
D i s p l a y ss e r v i c ea i d s o p t i o n s .

D i s p l a y sm a i n s t o r a g e .
Displaysthe contents of the
s p o o l i n gq u e u e s .

fg'r
DUMP
(K)

(''E-l
\ t, I I

irrll
I L J

[,DISK]
I svsrev
\ (s)

Dumpsany partition or all of
main storageto a printer. Or,
dumps all of main storage,the
SWA, part of the SHA, the
configuration records,the
PTF log sectors,microcode
levels,the error recording
d a t a , a n d t h e s a v e dt r a n s i e n t
a r e at o t h e $ S Y S D U M p f i l e .
(The transient area is included
only if a processcheck
occurred in the transient
area and the DUMP command
is given before end of job for
that partition.)

I Possibre
taskoperandsarep1,p2,p3,s, sp, occ, ccp,
ccs, ccu. c44,C55,C66,C77,C8g.
c99, CCC,cDD, CEE.CGG,CHH,
cMM' cPP' crr' cuu' cvv' cyvl^/'cxx, cYY,
cZZ. Themeaningof eachtask operandis incruded
in rhetBM system/3Moder
75 Operator'sGuide,GC21_5O7b.
c-2.2

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN2i-5674

Command
HALT
(HT}

HIPTY
(HP)

HOLD
(H)

I

Function

Operands

It1

C a u s e st h e p a r t i t i o n t o h a l t w i t h
an EJ or ES messageafter the
c u r r e n tj o b s t e p i s c o m p l e t e .

ll sH A -[,cce l ,,,..;

Causesthe system to halt or
$HACCP to be automatically
i n v o k e d b e f o r eu n p r i n t e d s y s t e m
h i s t o r y a r e ae n t r i e sa r e o v e r l a i d .

l;3
I

high-priority

Limits the priority of jobs placed
on the reader queue by $OCOPY
underCCP.

R D R o[,i 1 n t'" -,-l

P r e v e n t sa j o b , a j o b s t e p , o r
a n e n t i r e q u e u ef r o m b e i n g

(Ro) L'cnaracters
J

s c h e d u l e d{ o r i n p u t o r o u t p u t .

pRTo |-'jobname** [-"l"Pn'-t -J-l
f*oi [:tntracters**lrcharacters*ll

,.ro [,j?on'T"** [,':'onut"-J-l
-JJ
i;j-

l,charactersL'"ntracters**
Causesthe system to autom a t i c a l l yd e l e t e l - t y p e
( i n f o r m a t i o n a)l m e s s a g e s
to which therewas no res p o n s e( w h e n t h e r e s h o u l d
have been a response).

IDELETE
(t)

KEEP
(KP)

{'""J.lil:..,..}
l*oJo,

',##,
{:;::il:,,..}
[,.1J.11ffi."]

K e e p ss i n g l eo r m u l t i p l e p r i n t e d ,
p u n c h e d ,a n d e x e c u t e dj o b s t e p s
andlor jobs in the hold state on
the queue.

'.]
{:???il;,,..}
[:.l#:ffi
;.o',o,
NOHALT
(NHT}

HJ

C h a n g e st h e p r o c e s s i n gm o d e
of a partition from halt to no
h a l t o r a l l o w s s y s t e mh i s t o r y
a r e ae n t r i e st o b e o v e r l a t d
w i t h o u t o P e r a t o rn o t i f i c a t i o n

Appendix C. Operator Control Command (OCC)

C-3

P a g eo f G C 2 t - 5 1 6 2 - l
l s s u e d2 8 S e p t e m b e rl 9 7 g
By TNL: cN2t-5674

NOIDELETE
(Nl)

Causesthe system to cease
automatic deletion of l-type
messages
that receivedno
response.

PTY
(Y)

Changesthe priority for the
s y s t e mt a s k s : s p o o l i n g
( r e a d e r ,p r i n t w r i t e r , p u n c h
writer), partition'l , partition
2, and partition 3.

READER
( R DR }

C h a n g e st h e s y s t e mi n p u t
device for a partition.

RELEASE
(R)

l-,stepname l-l
[, ctraracters-.JJ

Releases
a job or job step,
m u l t i p l ej o b so r j o b s t e p so, r
an entirequeuefrom the hold
state.

[-,stenname I I
[.,characterslJ

RESTART
(T)

ffiru]
li,:- j
REUSE

flJ!,,.o".me[,stepname]

Restartsa job step'sprintedor
punchedoutput.
P R I ( W 1 )a n d P R 2 ( W 2 )a r ev a t i d
o p e r a n dos n l y i f a s e c o n d1 4 0 3
P r i n t e ri s i n s t a l l e d .

Causestrack groups that have been
printed or punched to be made
a v a i l a b l e . ( A l l o w s t h e a r e at o b e
reused.)

Gommand

SET

I

Operands

Function

I-n-l
'''"
I rr |

Overridesthe partition and
file shareareasizespecified
during systemgeneration.

t_9FtJ

START

(s)

-l

,,"".
['li
(sP)

,sizel[,track
sroro,ir31l
l!*.*r [,unit]

R D R[ , R O L L ]
(R)

til

tvol
['to'''

PR1 |

I

iHl'
I
(w2)
PCH
(P)

I

L

R e s t a r tssp o o l i n gi n t h e
partition.
designated
S t a r t ss p o o l i n ga t l P L .
Startsthe spooled
r e a d e rp, r i n t w r i t e r ,
o r p u n c hw r i t e r .
P R I ( W l ) a n d P R 2 ( W 2 )a r ev a l i d
operandsonly if a second1403
P r i n t e ri s i n s t a l l e d .

J

P1

Restartsprogramexecution
in a partition.

P2
P3

STOP
(P)

{ , P 1I

SPOOL< ,P2 >

(sP) t,ts)
RDR
(R)

PRrl-^srEF-l
(w)
l(ES) |
P R l | , P A GIE
( w l ) l ( P G )|

PR2l

(W2}L

J

I

T e r m i n a t essp o o l i n gi n
specifiedpartition.
Stopsthe spooledreader,
p r i n t w r i t e r ,o r p u n c h
writer.
P R 1( W 1 )a n dP R 2( W 2 )a r ev a l i d
operandsonly if a second1403
P r i n t e ri s i n s t a l l e d .

PcHFrEFI
(P) l_!ES)
I
P1
P2

Stopsprogramexecution
in a partition.

P3

Appendix C. Operator Control Commands (OCCI

C-5

TIME
(TM}

I r'r,l'"nrlr,
I

TLOG
(TL)

)ort

TRACE
(E)

J oo*F Fi ,svsrenr
(s)

I hhmmssI

loFFt
i

[

E n a b l eos r d i s a b l etsh e t r a n s a c t i o n
l o g g i n gr o u t i n e( t h i sr o u t i n em u s t
b e c u r r e n t l yl o a d e d ) .
E n a b l eos r d i s a b l etsh e s y s t e m
traceroutine (whichmust be
c u r r e n t l yl o a d e d ) .

AppendixD. SUBR15-LibraryEntry RetrievalSubroutine

The libraryentry retrievalsubroutinecan be incorporated
into a user-writtenprogramto retrievea singleentry or a
g r o u po f e n t r i e sf r o m a n y l i b r a r y . T h e u s e rs u p p l i essu c h
i n f o r m a t i o na st h e n a m eo f t h e e n t r y ,t h e u n i t c o n t a i n i n g
the library,and the libraryto be accessed.
Libraryentriesare passed
to the userprogramone record
at a time. The first recordreturnedto the userprogram
by SUBR15 for eachentry is an appropriateCOPYstatement;the lastrecordfor eachentry is a CEND statement.
The format of the recordsproducedby SUBR15 is the
sameasthat producedby the copy library-to-card
function
o f $ M A l N T . l f t h e r e c o r d sa r ew r i t t e nt o a d i s k f i l e ,t h a t
file can be processed
by the copy file-to-libraryfunction
of $MAlNT.
N o t e : l t S U B R1 5 i s u s e di n a p r o g r a me x e c u t i n g
under
control of the communications
control program(CCP),
the usermust ensurethat the libraryto be usedis not
b e i n gc h a n g e d
b y a n o t h e rp r o g r a mw h i l eS U B R l 5 i s r e a d i n g
from it.

Appendix D. SUBRl5-Library

E n t r y R e t r i e v a lS u b r o u t i n e

D-l

L I N K I N GS U B R 1 5W I T H R P GI I
S U B R l 5i s l i n k e dt o a u s e rR P Gl l p r o g r a m
v i aa n E X I T
s t a t e m e nf to l l o w e db y s e v e nR L A B L s t a t e m e n t s(.F o r
subroutinelinkageinformation,seethe IBM System/3
RPG ll Reference
Manual,SC2l-7b04.) TheseRLABL
s t a t e m e n tm
s u s tb e s p e c i fe d i n t h e f o l l o w i n qo r d e r :
Operation
Sequence Entry
RL A B L

ResultField
Entry
Field

Description
T h e n a m e o f a 1 - c h a r a c t ear l p h a m e r i c
R P G l l f i e l d t h a t c o n t a i n sa c o d e
i d e n t i f y i n gt h e l i b r a r y t o b e u s e d . T h e
code in the field can be:

S
P
O
R
RL A B L

Field

- Source
- Procedure
- Object
- Routine

The name of a O-characteralphameric
R P G l l f i e l d t h a t c o n t a i n st h e n a m e o f
the library entry to be retrieved. lf this
field contains five or fewer characters
f o l l o w e d b y a p e r i o d ( ' c c c c c . ' ) ,a l l
e n t r i e sh a v i n gn a m e sb e g i n n i n gw i t h
those charactersare copied. (This is
s i m i l a r t o t h e ' c h a r a c t e r s . A L L c' a p a bility of $MAlNT.) lf the first charact e r o f t h i s f i e l d i s a p e r i o d ,t h e n a l l
e n t r i e si n t h a t l i b r a r y a r e c o p i e d . ( T h i s
i s s i m i l a rt o t h e N A M E - A L L c a p a b i l i t y
of $MAlNT.)

RLABL

Field

The name of a 2-characteralphameric
R P G l l f i e l d t h a t c o n t a i n sa c o d e
i d e n t i f y i n gt h e u n i t l o c a t i o n o f t h e
library. The code in the field can be:
R 1 ,F 1 ,R 2 , F 2 .

RLABL

Field

The name of an 80- or 96-character
a l p h a m e r i cR P G l l f i e l d t h a t w i l l c o n tain each record processedby SUBR15.

Operation
Sequence Entry

7

ResultField
Entry

Description

RLABL

lNnn

A u n i q u eR P Gl l i n d i c a t o tro b e s e to n
if the libraryentry is not found or if the
librarydoesnot existon the specified
unit.

RLABL

lNnn

A uniqueRPG ll indicatorto be set on
when the requestfor retrievalis complete. (Whenthis indicatoris on, the
RPG | | programcan requestanother
entry or entries.)

RLABL

IN n n

A u n i q u eR P Gl l i n d i c a t o tro b e s e to n
when a recordis passed
to the RPG ll
p r o g r a mb y S U B R 1 5 .

ffote.' The three indicatorsaresetoff by SUBR15upon
receivingcontrol from the userprogram,

A p p e n d i x D . S U B R 1 5 - L i b r a r y E n t r y R e t r i e v a lS u b r o u t i n e

D-3

Example
T h ef o l l o w i n ge x a m p l es h o w sh o w a n R P Gl l p r o g r a mu s e s
SUBR15:

RPG C A L C UL A T IO N S P E CFI I C A T I O N S

Ford Gx21.S}2
P.nrod

75

-^. s Ll tl tl .. _

T h e L I B R Yf i e l dc o n t a i nas c o d e( S ,P . O , o r R ) t h a t
i d e n t i ife st h e l i b r a r y .
T h e N A M E f i e l d c o n t a i n st h e n a m eo f t h e l i b r a r ye n t r y
or entriesto be retrieved.
T h e U N I T f i e l dc o n t a i nas c o d e( R 1 , F 1 , R 2 ,o r F 2 l
t h a t i d e n t i f i e tsh e l o c a t i o no f t h e l i b r a r y .
The RECL96field is a 96-bytefield that containseacn
r e c o r dp r o c e s s ebdy S U B R 1 5 .
Indicato0
r 1 ( 1 N 0 1 )i s s e to n i f t h e l i b r a r ye n t r y i s n o t
found or if the librarydoesnot existon the specified
unit.
Indicator02 (1N02)is seton when the retrievalrequesr
iscomplete.
Indicator03 (1N03)is seton when a recordis passed
to
t h e R P Gl l p r o g r a m
by SUBR15.
I n d i c a t o 0r 3 i s u s e dt o c o n d i t i o n( v i at h e E X C P T
operationcode)writing the recordto a file, and to
conditionthe branchto LOOP1to requestanother
record.

76

lt

'n U.S A

18

19

80

p.q,ah f T-fT--fT--l
r-,,,..,..1 | I | | | I

L I N K I N GS U B R l 5W I T HA S S E M B L E R
L i n k a g et o S U B R1 5 f r o m a n a s s e m b l el ar n g u a gper o g r a m
i s v i a a b r a n c hi n s t r u c t i o n( t o S U B R '5l ) f o l l o w e db y a
seriesof parameters.An EXTRN statementwith an operand
o f S U B R 1 5i s a l s on e e d e d W
. h e nt h e s u b r o u t i n e
i se n t e r e d ,
t h e v a l u ei n i n d e xr e g i s t e1r ( X R 1 ) m u s tb e t h e a d d r e s s
f r o m w h i c ht h e d i s p l a c e m e n t (f so)r p a r a m e t e r5s, 6 , a n d 7
a r ed e t e r m i n e d (. L i n k a g eo f S U B R l 5 t o t h e a s s e m b l e r
programis accomplished
by the OverlayLinkageEditor
o f t h e S C P . F o r f u r t h e ri n f o r m a t i o na b o u ta s s e m b l e r
linkage,refer to the IBM System/3 EasicAssembler
ReferenceManual,SC21-7509,and to the IBM System/3
OverlayLinkageEditor ReferenceManual,GC21-7561.)
The seriesof parameters
can be codedasfollows:
Operation Operand
Entry
Sequence Entry
DC
DC

tL1',o'
AL2(address)

Description
The addressof a 1-byte field that
c o n t a i n sa c o d e i d e n t i f y i n g t h e
library to be used:

S
P
O
R
DC
DC

rL1',5'
AL2(address)

- Source
- Procedure
- Object
- Routine

The addressof the rightmost byte
of a 6-byte field that contains the
name of the library entry to be
retrieved. lf this f ield contains
five or fewer charactersfollowed by
a p e r i o d ( ' c c c c c . ' ) ,a l l e n t r i e sh a v i n g
n a m e sb e g i n n i n gw i t h t h e i n d i c a t e d
charactersare copied. (This is
'characters.ALL'
s i m i l a rt o t h e
c a p a b i l i t yo f $ M A l N T . ) l f t h e f i r s t
character of this field is a period,
t h e n a l l e n t r i e si n t h a t l i b r a r y a r e
c o p i e d . ( T h i s i s s i m i l a rt o t h e
N A M E - A L L c a p a b i l i t yo f $ M A l N T . )

DC
DC

1Ll',l',
AL2(address)

The addressof the rightmost byte of
a 2 - b y t e f i e l d t h a t c o n t a i n st h e u n i t
code of the library. The code in the
f i e f d c a n b e : R 1, F 1 , R 2 , o r F 2 .

DC
DC
or
DC
DC

1L1',79',
AL2(address)
lfor 80-charfieldl
rL1',95'
AL2(address)
lfor 96-charfieldl

The addressof the rightmost byte of
an 80- or 96-characterfield that will
contain each record processedby
S U B R15 .

Appendix D. SUBRl5-Library

E n t r y R e t r i e v a lS u b r o u t i n e

D-5

Pageof GC21-5162-1
lssued28 September
1979
By TNL: GN2t-5674

Seguence

7

D

Operation
Entry

0perand
Entry

Description

DC
DC
DC

XL1'OO'
XL1'mask'
XLl
'displacement'

I n d i c a t eosn eo f t h e f o l l o w i n g
errorsd
: e s i r e dl i b r a r ye n t r y i s n o t
f o u n d ;l i b r a r yd o e sn o t e x i s to n t h e
specifiedunit; or the svstemsource
get routine ($$SYSG)tcannotbe
found. The 'mask'is a byte with
o n e b i t o n a n ds e v e nb i t s o f f ; , d i s p l a c e m e n its' t h e d i s p l a c e m e n
f rto m
t h e v a l u ei n X R 1 o f a 1 - b y t ef i e l d .
l f S U B R l 5 d e t e c t st h e a b o v e
e r r o r st,h e b i t p o s i t i o ni n d i c a t e d
by the maskis set on in the byte
specifieb
d y t h ed i s p l a c e m e n t .

DC
DC
DC

XLl'00'
XL1'mask'
XL1
'displacement'

lndicatesthat the requestfor
service
i s c o m p l e t e .W h e nt h i s
c o n d i t i o ne x i s t st,h e a s s e m b l e r
programcan requestanotherentry
o r e n t r i e s .T h e u s eo f ' m a s k 'a n d
'displacement'
i s t h e s a m ea sf o r
parameter5. (You may want to
usethe samedisplacement
with
a d i f f e r e n tm a s k . )

C
DC
DC

xL1',00'
X L 1' m a s k '
XL1
'displacement'

Indicatesthat a recordhasbeen
passed
program
to the assembler
f r o m S U B R 1 5 .T h e u s eo f ' m a s k ,
a n d ' d i s p l a c e m e ni st 't h e s a m ea s
for parameter5. (You may wanr
to usethe samedisplacement
with
a d i f f e r e n tm a s k . )

& o t e ; S U B R I 5 s e t so f f t h e b i t si n d i c a t e di n p a r a m e t e r s
5, 6. and 7 eachtime it receives
control from the user
program.

E R R O RI D E N T I F I C A T I O N
l f a n e r r o ri s d e t e c t e dS, U B Rl 5 s e t sa l l t h r e eR p G l l
i n d i c a t o ros r a s s e m b l ebri t so f f . A n y o f t h e f o l l o w i n q
errorscan be detected:
o The unit specified is not R1 F 1 R2, or F2.
,
,
o The unit specified is not supportedon
the system.

o T h e l i b r a r ys p e c i f i e d
i sn o t S , p , O , o r R .
o The recordlengthspecifiedis not g0 or 96 bvtes.
T h e u n i t , l i b r a r y ,o r n a m ew a sc h a n g e d
b e f o r ee n d - o f requestwasreturned.
o T h e t h r e e R P G l l i n d i c a t o r so r a s s e m b l e r
bitsare not
untoue.
After one of these errors has been detected, or after a
n o - f i n d e r r o r , a r e q u e s tc a n b e m a d e t o S U B R 1 5 f o r
a n o t h e rl i b r a r y e n t r y .

o T h e p a c ko n t h e u n i t s p e c i fe d i s n o t i n i t i a l i z e o .

t$$SySG

is a system module {O-module}that is part of the SCp (system
c o n t r o l p r o g r a m m i n g )a n d i s r e q u i r e c t o b e o n t h e s y s t e m p a c k
from which an IPL is performed. $$SYSG is not linked
into the user,sobject program.

D-6

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r19 7 9
By TNL: GN21-5674

AppendixE. Transaction
Logging-$TRLOG

Transaction logging provides the ability for batch and CCP
programs to log data to a 9-track, 1600 bpi magnetic tape.
This givesthe user a convenient way to create an audit
trail, log transactions,saveprogram use statistics,save

Tape Considerations
T h e f i l e c r e a t e db y $ T R L O G i s a s i n g l ev o l u m e f i l e w i t h
s t a n d a r dl a b e l s . T h e f i l e c h a r a c t e r i s t i casr e :

terminal use statistics,and savedebug information.
N A M E $ T R L O G , R E EL . $ T R L O G , R E C L . 2 O 4 4 .
Transaction logging consistsof the following system support and assemblersubroutines.

B L K L . 2 0 4 8 , RE C F M - V B

L o a d i n s$ T R L O G
$TRLOG: This SCP program is loaded by the user into
p a r t i t i o n o n e a n d a t t a c h e dt o t h e s u p e r v i s o tro a c c e p ti n formation from the user program and write the tape
records.

SUBR82: This SCP subroutine is supplied for use by userwritten RPG ll programs.

SUBR8l: This SCP subroutine is supplied for use by userwritten COBOL and FORTRAN programs.
In each case,the user program defines the information to
be logged.
Note that transaction loggingprovides only the meansto
log transaction data to tape; it is the user's responsibility to
accessthe tape or to otherwise use or analyze the collected
information.

Using Transaction Logging
W h e n t r a n s a c t i o nl o g g i n gi s u s e d .d a t a i s p a s s e dt o t h e
s u p e r v i s o r( $ T R L O G ) b y m e a n so f t h e s u b r o u t i n e( S U B R 8 1
o r S U B R 8 2 ) . T h e s u p e r v i s o r{ $ T R L O G ) b l o c k s t h e d a t a
into variable length blocks with a maximum record length
of 2O4Obytes and a maximum block length of 2048 bytes.
W h e nt h e b l o c k i s f u l l , i t i s w r i t t e n t o t a p e . T h e u s e r ' s
program does not need to define a tape file for logging
transactrons.

T h e t r a n s a c t i o nl o g g i n gr o u t i n e .$ T R L O G , m u s t b e l o a d e d
i n t o p a r t i t i o n 1 , a n d t h e s t a r t a d d r e s so f p a r t i t i o n 1 m u s t
b e i n t h e f i r s t 6 4 K o f m a i n s t o r a g e .$ T R L O G r e q u i r e s6 K
o f m a i n s t o r a g e ,w h i c h i s p e r m a n e n t l ya l l o c a t e da s p a r t o f
t h e s u p e r v i s o r .T h i s 6 K o f m a i n s t o r a g ei s t a k e n a w a y f r o m
p a r t i t i o n 1 a n d c a n n o t b e r e u s e du n t i l t h e n e x t I P L o f t h e
s y s t e m . A m i n i m u m p a r t i t i o n s i z eo f 1 4 K i s t h e r e f o r er e q u i r e d t o s t a r t $ T R L O G ; t h e 6 K i s r e m o v e df r o m t h e
p a r t i t i o n , l e a v i n ga m i n i m u m P 1 s i z eo f 8 K .
T h e O C L f o r $ T R L O G m u s t i n c l u d e a F I L E s t a t e m e n tf o r
t a p e . T h e f o l l o w i n g O C L s t a t e m e n t sa r e r e q u i r e dt o l o a d
the $TR LOG program:
// LOAD $TRLOG.unit
/ / F I L E N A M E - $ T RL O G , R E EL $ T R L O G , U N | T - t a p e
// RUN
where unit is a 5444 unit code (F 1, R 1, F2, Rzl , and tape
i s a t a p e d r i v e u n i t c o d e ( T 1, T 2 , f 3 , f 4 1.
W h e n $ T R L O G h a s b e e n l o a d e d ,p a r t i t i o n 1 g o e st o E J .
After that, the partition can be used for other user
applications.
Whenthere is a needto run $TRLOG with the System
MeasuremenF
t a c i l i t y ( S 3 D S M F ) a n d / o r t h e s y s t e mt r a c e
f a c i i i t y ( $ T R A C E ) t h e l o a d i n gs e q u e n c ei s i m p o r t a n t .
T h e s e3 p r o g r a m st a k e t h e i r s p a c ef r o m P 1 , a n d t h e y m u s t
a l l b e l o a d e di n P l .

Appendix E. TransactionLogging-$TRLOG

E-l

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

1.

$ T R L O Gm u s tb e l o a d e df i r s t .

2.

S 3 D S M Fm u s tb e l o a d e dn e x t .

3.

$ T R A C Em u s tb e l o a d e dl a s t .

T h e s u p e r v i s owr ,i t h o r w i t h o u ts p o o ls u p p o r t$, T R L O G ,
S 3 D S MF , a n d$ T R A C Em u s ta l l r e s i d ew i t h i n t h e f i r s t
64K of main storage.

Controllin$
gTRLOG
O n c e$ T R L O G i s l o a d e dt,r a n s a c t i olno g g i n gi s c o n t r o l l e d
throughuseof operatorcontrolcommands.TLOG ON
activateslogging,and TLOG OFF deactivates
logging.
The followingeventsoccurfor eachcommand:

TLOG ON
- R e w i n dt a p e( p o s i t i o na t l o a dp o i n t ) .
- Checkfor propertape mounted,
standardlabel.f ile
n a m e$ T RL O G .
- Write headerlabelon the tape.
- Activatetapelogging.
- Sendmessage
to systemconsoleindicatingtapelogging
is active.

TLOG OFF
- Deactivate
tape logging.
- Sendmessage
to systemconsoleindicatingtapelogging
isinactive.
- W r i t et r a i l e rl a b e lo n t a p e .
- R e w i n da n d u n l o a dt h e t a p e .

While logging is active, a permanent tape error or end-ofreel condition causesa hard halt which indicatesthe error
condition. The operator can retry the operation or continue without logging. In either case, if extended restart
has been generated,the system will automatically restart
a l l p r o g r a m st h a t h a v eh a l t e d d u e t o t h e e r r o r .
The retry causesthe user program to check once again to
s e ei f l o g g i n gi s a c t i v e . l f a c t i v e ,l o g g i n gi s d o n e . l f n o t
active, logging is bypassedand execution continues.
When the option is selectedto continue without logging,
no furthei' attempts to log wiil be made by that user program until that program has been reloaded. This means
that no other logging requestswill be honored, even if
new and/or different transactionsoccur that request additional logging.

ProgrammingConsiderations
T h e s u b r o u t i n e s( S U B R 8 1 o r S U B R 8 2 ) a r e i n c l u d e di n
t h e u s e r ' ss o u r c ep r o g r a m d u r i n g c o m p i l a t i o n .
T h e R P G l l i n t e r f a c ei s d e v i c eS P E C I A L w i t h l a b e l
S U B R 8 2 o n t h e f i l e d e s c r i p t i o ns p e c i fi c a t i o n s . O u t p u t
specificationsare like any other sequential output.
The COBOL interface is:
C A L L S U B R 8 1 U S I N G n n n n n nd d d d d d
w h e r e n n n n n n i s d e f i n e da s P I C T U R E 9 9 C O M p 4 V A L U E
aaaa(length of the message),and dddddd is defined as
P I C T U R EX ( a a a a ) .
T h e F O R T R A N i n t e r f a c ei s :
CALL SUBR8l (nnnnnn.dddddd)

Operating Considerations
Programsusing transaction logging need only to invoke a
subroutine and passthe data to be logged. lf logging is
active, the data is moved into a 2K buffer. When the
buffer is full, or when there is insufficient space left for
the transaction, the buffer is written to tape. lf logging
is inactive,the request is ignored, and the user,sprogram
c o n t i n u e su n i n t e r r u p t e d .

w h e r e n n n n n n i s a 2 b y t e i n t e g e rp r e v i o u s l ys e t e q u a l t o
the number of bytes in the message.The variable dddddd
i s a n a r r a y o f i n f o r m a t i o n a t l e a s tn n n n n n b y t e s l o n g .
Therearetwo 2K buffersin $TRLOG. As one buffer f ills.
i t i s w r i t t e n t o t a p e w h i l e t h e o t h e r b u f f e r i s b e i n gf i l l e d .
Therefore, a buffer is always availableto the user program.
These buffers are not specified in the user program.
A d d i t i o n a l i n f o r m a t i o n a b o u t t r a n s a c t i o nl o g g i n gi s c o n tainedin the RPG ll, COBOL, and FORTRAN reference
manuals.

P a q eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

Appendix F. ProgramReferenceI nformation

SystemControl Programming,
STO4-5C2,
is shippedf rom
t h e P r o g r a mL i b r a r ya n d i n c l u d e sm a n yi n d i v i d u apl r o grams.The followingis a list of theseprogramsalongwith
the primarysourceof informationfor that program.Most
of the programsintendedfor customerusearedescribed
i n P a r t4 o f t h i s p u b l i c a t i o n .

Program
Name

Program

Primary
References
(Note 2)

Program
Name

Program

Primary
References
(Note 2)

$sG.. .

SystemGeneration

SystemGeneration

$SGFIX

ProgramTemporary

$SGLOG

Patch
PTF LiSt

SCPDataAreas
Handbook
SCPDataAreas
H andbook
SCPDataAreas
Handbook
SCPDataAreas
Handbook
SCPDataAreas
Handbook
SCPReference
SCPDataAreas
Handbook
SCPReference
SCPDataAreas
Handbook
SCPReference
SCPReference

(Note 1)

$TlNlT
$TRACE

ProgramTemporary
Fix
ProgramTemPorarY
Fix
ProgramTemPorarY
Fix
l n i t i a l i zT
oaPe
T r a c eR o u t i n e

$ T RL O G
$TRPRT

T r a n s a c t i oL
no g g i n g
P r i n tT r a c eE n t r i e s

$TVES
$WVTOC

T a p eE r r o rS u m m a r Y
VTOC Conversion

$SGPTF
The followingprogramsareinvokedwith a // LOAD OCL
statement:
$$otSt<
$$RSTR

$@MRGN
$@MRPT
$ALT
$BUILD
$CE...
$CNFIG
$COPY
$CPRNT
$DCOPY
$DELET
$DISK@
$DUMP
$FCOMP
$HIST
$INIT
$KLEAN
$LABEL
$MAINT
$MPXDV
$OLINK
$OCOPY
$RINDX
$RSALT
$SCOPY

D i s k R e b u i l dP r o g r a m

S C PD a t aA r e a s
Handbook
CheckpointRestart
SCPOperator's
Guide;SCP
Reference
M R J E / W S G e n e r a t i o n M R J ER e f e r e n c e
M R J E / W SP r i n tU t i l i t y
M R J ER e f e r e n c e
AlternateTrack
SCPReference
Assignment
A l t e r n a t eT r a c k R e b u i l d SCPReference
CEDiagnostics
CE Maintenance
Manual
C o n f i g u r a t i oR
n ecord
S C PR e f e r e n c e
Program
Copy/Dump
SCPReference
$ S Y S D U M PP r i n t
SCPOperator's
Program
Guide
Dump/Restore
SCPReference
F i l eD e l e t e
S C PR e f e r e n c e
DiskAddressCompare SCPDataAreas
Program
Handbook
SCPDataAreas
Dump Tapeand Disk
Handbook
File Compress
SCPReference
SystemHistory Display SCPReference
l n i t i a l i z eD i s k
S C PR e f e r e n c e
C h a i nC l e a n i n P
g r o g r a m S C PR e f e r e n c e
F i l e a n dV o l u m e
S C PR e f e r e n c e
L a b e lD i s p l a y
L i b r a r yM a i n t e n a n c e
S C PR e f e r e n c e
MacrosReference
Macroprocessor
O v e r l a yL i n k a g eE d i t o r O L E R e f e r e n c e
SCPReference
Spool File Copy
R e c o v elrn d e x
S C PR e f e r e n c e
Reassign
AlternateTrack SCPReference
SimulationArea Program SCPReference

$SGPTR
$SGPVR

The followingprogramcomponentsaredistributedwith
SCP5704-SC2but arenot loadedby meansof a
// LOAD OCL statement:
S U BR O 7
SUBROS
SUBROg
S U B R1 5
SUBR81
SUBR82

M I CR . 1 2 5 5
MICR-l255
MICR-1419
L i b r a r yE n t r YR e t r i e v a l
T r a n s a c t i oLno g g i n g
Subroutine
T r a n s a c t i oLno g g i n g
Subroutine
OPeratorControl
C o m m a n d s( O C C )
SPoolCommands
l/O Macros
M L / M PM a c r o s

MICR Reference
MICR Reference
MICR Reference
SCP Reference
SCP Reference
SCP Reference
SCP Operator's
Guide
S p o o l U s e r ' sG u i d e
Macros Reference
MLMP Reference

A p p e n d i x F . P r o g r a m R e f e r e n c eI n f o r m a t i o n

F-1

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
B y T N L : G N 2 1- 5 6 7 4

Note l: $SG. . . refersto systemgenerationfunctions
ex_
c l u d i n gt h o s e$ S Gp r o g r a m ss p e c i f i c a l llyi s t e d .
Note 2: Legend
SCPOperator's
Guide

IBM System/3 Model l5 operator's
Guide, GCZI-5O75

SCPDataAreas
Handbook

IBM System/3 Model lS System
Data Areas and DiagnosticAids,
S Y 2 1 - 0 0 5 2 .( T h ep r o g r a m ds e s c r i b e di n t h i s p u b l i c a t i o na r e
intendedfor useby the CE oro_
gramsupportrepresentative.
)

SpoolUser'sGuide

IBM System/3 Modet l5 Llser's
Guide to Spooting,GC2j-7632

OLE Reference

IBM System/3 Overlay Linkage
Editor ReferenceManual.
GC21-7561

MacrosReference

IBM System/3 Modet lS System
Con tro I Program mi ng M ac ros
ReferenceManual,GC21-7608

SystemGeneration

IBM System/3 Model l5 System
Generation ReferenceManual.
GC21.7616

M L M PR e f e r e n c e

I 8 M System/3 M ultil i ne/Mut tipoi nt
Binary SynchronousCommunications ReferenceManual.GC2l-7573

M R J ER e f e r e n c e

IBM System/3 Modet l5 MULTTLEAVING RemoteJob Entry/
Work Station Support Reference
Manual,GC21-5115

MICRReference

IBM System/3 Modets S, 10, 12,
and 15 1255 and l4l9 Magnetic
CharacterReadersReferenceand
Program Logic Manual, GC21-5j32

CE Maintenance
Manual

MDM - Volume lA CE Diagnostic
UserGuide(which is sentwith
the system)

F-2

Pageof GC21-5162-l
lssued28 September1979
By TNL: GN21-5674

lndex

/i CEND 4-129
// NEND 4jt29
/. statement 1-20. 1-96
/. statement(OCL) 1-13
/@ statement 1-20, 1-95
/@ statement(OCL) 1-12
$ALT (alternatetrack assignment
program) 4-7
$BUILD (alternatetrack rebuild
program) 4-12
$CNFIG
ASSIGN statement 1-21
during system goneration 3-9
$CNFIG (configurationrecord
program) 4-17
$COPY (copy/dump program) 4-27
$DCOPY (dump/restore program) 4-62
$DELET (file delete program) 4-71
$FCOMP (file compress program) 4-78
$HACCP (system history area copy
program) 4-93
$HIST (system history area display
program) 4-93
$lNDEX40 4-209
sf NDEX4s 2-24,4-209
program) 4-100
$lNlT (disk initialization
$KLEAN (chaincleaningprogram) 4-108
$LABEL(file and volume labeldisplay
program) 4-109
$MAINT (librarymaintenance
program) 4-117
$OCOPY (spool file copy programl 4-'167
SOCOPYfiles and subroutines 4-185
$RINDX (recoverindex program) 4-208
$RSALT (reassignalternatetrack
program) 4-212
$SCOPY (simulationarea program) 4-216
$SPOOL file 4-78
$TlNlT (tape initialization
program) 4-233
$TVES (tape error summary program) 4-239
$WVTOC (VTOC service programl 4-241
' (COMMENT)statement 1-99
r (COMMENT)statoment(OCL) 1-13
* parameterfor the LOAD statement
(ocL) 1-18

ACCESSstat€ment ($COPY)
CYLINDERparameter 4-33
DISP parameter 4-33
FROM parameter 4-33
RECL parameter 4-33
SECTORparameter 4-33
TRACK parameter 4-33
accessingadded records 2-7O
accessingsimulation ar€as 3-7
add files from one main data aroa to
another 4-78
adding a missing parameterto a
procedure 2-33
adding a statement to a procedure 2-33
adding source library entries 4-137
additional disk identification 4-102
advantagesof nested procedures 2-35
AFTER parameter 4-152
allocate considerationsand
restrictions 4-119
allocatedisk space 3-11
ALLOCATEstatement($MAINT)
allocation of disk work space 4-123
control statementsummary 4-118
DlRSlzE parameter 4-121
function 4-1 18
HISTORY parameter 4-122
OBJECT parameter 4-126
PACKO parametor 4-123
parametersummary 4-'l2O
restrictions 4-119
SOURCEparameter 4'124
SYSTEM parameter 4-121
TO parameter 4-'121
WORK oarameter 4-122
affocatework space for keysort 2-23
allocationlimit 4-121
ALT statement (SALT)
ASSIGN parameter 4-7
control statem€nt summary 4-7
PACK parameter 4-7
parameter summary 4-8
UNIT parametor 4-7
VERIFYparameter 4-7
alternatetrack assignmgnt program
ALT statement 4-7
conditional assignment 4-9
examples 4-10
messages 4-11
OCL considerations 4-10
unconditionalassignment 4-9

lndex

X-1

alternatetrack rebuildprogram
examples 4-15
OCL considerations 4-l s
R E B U I L Ds t a t e m e n t 4 - 1 2
substitutedata 4-14
alternatetracks
d e f i n i t i o no f 3 - 1 1
file processingconsiderations 3_l 1
location 3-11
appendixA A-1
appendixB B-1
appendixC C-1
area cooes
main data 3-14, 4-6, 4-219
s i m u l a t i o n 1 - i 4 , 1 - 2 1, 4 - 6
ASCII parameter,FILEstatement l_S1
assigna class numberto a program
considerations
and
restrictions 4-196.3
control statement 4-170
parameterdescription 4_194
parametersummary 4_174.2
ASSIGN parameter(SALT) 4-7
ASSIGN statement 1-14
considerationsand restrictions 1_22
contents 1-21
example 1-21
format 1-21
function 1-21
ocl
1-9
parameters 1-14
F1 1 _ 2 1
F2 1-21
R1 1-21
R2 1-21
placement 1-21
assigningsimulationareas 3-7
assigning 5444 unit codes 3-7
assrgnmentof alternatetracxs
alternatetrack assignment
program 4-7,4-9
disk initialization
program 4-104
asstgnmentof simulationareas 3_7
asteriskparameter(use in LOAD OCL
statement) 1-75
automaticfile allocation 2-13, 2-23
automattc messagerestart 2_7O
availablesimulationareas B-7

backupfunction 4-79
basic assembler 2-22
batch processing 2-56
BLKL parameter,FILEstatement l_49
braces C-1,4-5
brackets C-1,4-5

x-2

BSCA statement 1-9
contents 1-23
format 1-23
function 1-23
parameters 'l -14
parameters,line 1-23
placement 1-23
spoolingconsiderations 1-23
build a direct file 4-27
buildinga new index 4-3b

calculatingfile size
converttngcylinder/trackto track
number B-7
converttngtrack number of cvlinder
track B-8
main data area B-7
number of tracks
In a sequentialfile B-7
in an indexedfile B-7
of disk track index B-7
CALL statement
contents 1-24
example 1-24
format 'l-24
function 1-24
parameters 1-14
procedurename 1-14
switch characters 1-14
unit 1-14
placement 1-24
spoolingconsideration 1-24
CALL statement,OCL 1-9
C A N C E Lc o m m a n d C - 2
C A N C E LO C Cc o m m a n d C - 2
capitalletters,numbers,and soecial
characters 1-5. 4-5
capitalizedwords and letters 1-S,4-s
catalogingto an active library 2-39
CCP assignmentset 4-204
cEND 4-129
chain cleaningprogram 4-108
chain-imagearea
changing 4-108
enteringfrom
sourcelibrary 1-67
system Input device 1-67
C H A N G Ec o m m a n d C - 2 . 1
C H A N G EO C Cc o m m a n d C - 2 . 1
changethe support for catalogingto a
program pack 4-117
c h a n g i n ga p a r t i t i o n 1 - 7 2 . 1
changinga temporaryfile to a scratch
file 1-34
changingprocedureparameters 2-33
changingpunch device (see pUNCH statement)
changingsimulationarea cooe
assignments 3-9

Pageof GC21-5'162-1
lssued28 September
1979
ByTNL: GN21-5674
changingthe configurationrecord 4-17
changingthe contentsof the chain-image
area 1-66
changingthe log device 1-79
changingthe name of a libraryentry 4-153
changingthe number of linesthe printer
will print per page 1-85
changingthe size of the object
library 4-127
changingthe size of the source
library 4-124
changingthe system input device 1-91
changing5444 unit code assignments 3-9
CHAR format parameterfor the IMAGE
statement 1-67
charactersfrom the source library on
disk 1-67
charactersfrom the system input
device 1-67
charactersfrom the system input device,
example 1-68
charactersto use when naming library
entries 4-135
checkpoint/restart 2-68
choosingthe designationof a libraryentry
oermanent 4-136
temporary 4-136
classify batch programs (see assign a c/ass
number to a programl
cleaningthe print chain 4-108
clear initialization 4-100
C L O S Ep a r a m e t e r 1 - 1 9
coBoL 2-21
codes for main data areas 3-14, 4-6
codes for simulationareas 3-14, 4-6
coding rules
/. 1-5
1-5
l&
* 1-7
blanks 1-5
braces 1-5
brackets 1-5
capitalizedwords 1-5
commas 1-5
continuation 1-6
control statements 4-4
hyphen 1-4
keyword parameters 1-4
numbers 1-5

ocL
comment 1-7
continuation 1-6
statementsbeginningwith / / 1-5
statementsbeginningwith other than
1-5
//
positionalparameters 1-5
soecialcharacters 1-5
underscore 1-5
combinations of seven track
specifications 1-54

comments 1-7
coding rules 1-7
comment statement 1-99
lobname 1-7
stepname 1-7
compatibledisk accessmethods 2-18.2
compilationdate 4-'134
COMPILEstatement 1-25
contents 1-25
example 1-26
format 1-25
function 1-25
1-9
ocl
parameters 1-14
ATTR 1-26
LINKADD 1-25
OBJECT 1-25

souRcE 1-25
uNlT 1-25
placement 1-25
spoolingconsiderations 1-26
compilinga source program
storing it in obiect library 2-3O
storing it in object librarysamPle
statement 2-31
compressfiles high 4-78
comoressfiles low 4-78
compress in place 4-'127
compressingfiles 4-78, 4-19
conditionalassignmentof alternatetracks
examole 4-10
incorrect data 4-9
surfaceanalysis 4-9
configurationrecord program 4-17
CONSOLEoarameter
LOG statement 1-81
READERstatement 1-91
continuation(OCL) 1-o
continuation,example 1-6
control statementsummary(systemservice
programs)
ACCESSstatement($COPY) 4-30
ALLOCATEstatement($MAINT) 4-118
ALT statement ($ALT) 4-7
ALTA statement($RSALT) 4-212
A S N P s t a t e m e n (t S C N F I G ) 4 - 1 8
AUTHORIZEstatement($OCOPY) 4-17O
AUTST statement($CNFIG) 4-18
AUTWT statement($CNFIG) 4-18
BLANK statement($CNFIG)4-18
CATLGstatement($CNFIG) 4-18
CEND statement($MAINT) 4-129
CLASSIFYstatement($OCOPY) 4-170
CLEARstatement($SCOPY) 4-217
COMPRESSstatement($WVTOC) 4-241
C O N S O Ls t a t e m e n (t $ C N F I G ) 4 - 1 8
COPY statement($MAINT) 4-129
COPYAREAstatement($SCOPY) 4-217
COPYCTRLstatement($OCOPY) 4-169
COPYFILEstatement($COPY) 4-29

lndex

X-3

control statement summary (system
serviceprograms)(continued)
COPYFILESstatement($FCOMp) 4_80
COPYIPLstatement ($SCOpy) 4-217
COPYPACKstatement ($COpy) 4_29
COPYPACKsrarement($DCOpy) 4_62
COPYPCHOstatemenr($OCOpy) 4_168
COPYPRTOstatement($OCOpy) 4_168
COPYQ statement ($OCOpy) 4-17O
COPYRDROstatement($OCOpy) 4_169
COPYSPstatemenr($OCOpy) 4-168
DEFCNstarement($CNFlc) 4-18
DEFFNstatemenr(gCNFtG) 4-18
DELETEstatement($MAtNT) 4_146
DISPLAYstatement($LABEL) 4_110
DISPLAYstatement($OCOpy) 4_169
FORMATstarement($CNFlc) 4-18
FORMATstatemenr($DELET) 4-72
FSHAREstatement($CNFtG) 4_18
HLTP statement($CNFtG) 4-tB
I N S E R Ts t a t e m e n (t $ M A I N T ) 4 _ t S O
ITYPEstatement($CNFIG) 4_18
L O G Ps t a t e m e n (t $ C N F t G ) 4 - 1 8 . 1
M E S S A Gs t a r e m e n (r $ C N F t c ) 4 - 1 8 . 1
M O D I F Ys t a t e m e n (r $ M A I N T ) 4 - 1 5 0
MOVE statement (gSCOpy) 4-217
NAMES statement($SCOpy) 4_21j
NEND statement($MA|NT) 4-1r2g
NEWNAME statemenr($SCOpy) 4_217
OUTDM statement($COpy) 4-30
OUTPUTstatement($HtST) 4-94
PRINTstatement($CNFtG) 4-18.1
PRINTstarement(gHlST) 4-94
P R I O R I T Ys t a t e m e n (t $ C N F t c ) 4 _ 1 8 . , |
OCOPYstatemenr($CNFtG) 4-19..l
R E A D Ys t a t e m e n (t $ C N F t c ) 4 - 1 8 . 1
R E B U I L Ds t a t e m e n (t $ B U I L D ) 4 _ 1 2
REMOVEstatement($DELET) 4_72
REMOVEstatemenr($MAtNT) 4-1SO
R E N A M Es t a t e m e n (t $ M A t N T ) 4 _ 1 5 3
REPLACEstatemenr($MAINT) 4_150
RESTOREstatement($OCOpy) 4_169
SELECTstarement ($COpy) 4-29
S H A s t a t e m e n (r $ C N F t G ) 4 - 1 8 . 1
S I Z Es t a t e m e n (r $ C N F t G )4 - 1 8 . 1
SPCYLstatement($CNFtG) 4-18.1
S P D S Ks t a t e m e n (r $ C N F t G )4 - 1 S . 1
SPEXTstatement($CNFtc) 4-18.2
SPOPTstatement($CNFtc) 4_18.1
SYIN statement($CNFIG) 4-18.2
SYPC statemenr($CNFtc) 4-19.2
SYPR statement($CNFtc) 4-18.2
TAPEFILESsratement($FCOMp) 4_BO
TSTAMP srarement($CNFtc) 4-18.2
U lN statement($lNtT) 4-101
VOL statement($tNlT) 4-101
VOL statement($TtNtT) 4-234
controlling$TRLOG E-2

x-4

converston
convsrt seven track tape l-S1
cylinder-tracks B-8
records-tracks B-7
track number-cylindernumber B-7
copy a display of the status of the soool
queues
considerationsand restrictions 4-194
controt statement 4-169
parameterdescription 4-181
parametersummary 4-174
copy an index 4-35
copy/dump program
card input considerations 4-40
card output considerations 4-41
COPYFILEsratement(see COpyFtLE
statement)
copyangmultivolumefiles (seecopying
multivolumefiles)
COPYPACKstatemenr(see COpypACK
statement)
diskette(3741)file consideration 4-39
examples 4-42
OCL considerations 4-41
SELECTstatement(see SELECTstatement)
tape file considerations 4-39
use of 2-15
copy jobs to or from the reader queue
considerationsand restrictions 4-.|92
control statement 4-169
parameter description 4-178
parametersummary 4-173
copy selectedjob steps from one spool file
to another 4-195
considerationsand
restrictions 4-195
controlstatement 4-17O
parameterdescription 4-183
parametersummary 4-174.'l
copy selectedjobsteps from the print queue
considerationsand restrictions 4-184
control statement 4-'l 68
parameterdescription 4-j76
parametersummary 4-'|71
copy selectedjobsteps from the punch queue
considerationsand restrictions 4-190
control statement 4-168
parameterdescription 4-177
parametersummary 4-'172
COPYstatement($MAtNT)
control statement summary 4-129
file-to-library 4-129
FROM parameter 4-132
function 4-128
LIBRARYparameter 4-132
library-to-card 4-131
library-to-library 4-130
library-to-printer/ card
consideration 4-139
NAME parameter 4-132

P a g eo f G C 2 1 - 5 1 6 2 - 1
lssued28 September
1979
ByTNL: cN21-5674
NEWNAME parameter 4-134
PACKINparameter 4-134
PACKOparameter 4-134
Darameters 4-132
reader-to-library 4-129
RETAINoarameter 4-133
TO parameter 4-133
uses 4-128
copy the entire spool file
considerationsand restrictions 4-184
control statement 4-168
parameterdescription 4-176
parametersummary 4-171
COPYFILEstatement($COPY)
control statement summarv 4-28
DELETEparameter 4-36
LENGTHparameter 4-36
OMIT parameter 4-36
OUTPTXparameter 4-34
OUTPUTparameter 4-34
parametersummary 4-31
REORGparameter 4-36
COPYIN 4-27, 4-33
copying an entire area 4-34
examole 4-43
copying an index 4-35
copying files ($COPY)
example 4-42
disk to tape 4-45
tape to disk 4-46
copying minimum system from one disk to
another 4-130
example 4-158
copying multivolumefiles
copying multivolumeindexedfiles 4-38
direct file attributes 4-38
maintainingcorrect relativerecord
numbers 4-38
maintainingpropervolume sequence
numbers 4-38
copying obiect programto F1,
example 4-159
COPYO 4-27
COPYPACKconsiderations 4-34
COPYPACKstaremenr($COPY)
control statementsummary 4-29
FROM parameter 4-31
PACKIN parameter 4-34
PACKOoarameter 4-34
parametersummary 4-31
TO parameter 4-31
COPYPACKstatement($DCOPY)
EACKUPoarameter 4-64
control statementsummary 4-62
FROM parameter 4-63
PACK oarameter 4-64
parametersummary 4-63
SYSTEMparameter 4-64
TO oarameter 4-63
core index 8-6
COREoarameterfor JOB statement 1-72

correctingcharacterson an alternate
track 4-12
correctingcharacterson an alternate
track, example 4-15
correctingindex problems 4-35
createa new index 4-35
creatinga source library 4-124
creating an obiect library 4-126
creatingdisk files 2-12
cyltnderassignment 3-6
cvlinder0 format 3-12

data area track requirements B-1
DATA parameterfor the REMOVEstatement
($DELET) 4-72
DATE command C-z.'l
DATE OCC command C-2.1
date of compilation 4-134
DATE parameter
FILEstatement(OCL)
disk 1-35
tape 1-49
REMOVEstatement($DELET) 4-72
DATE parameterfor the DATE statement
(OCL) 1-27
DATE statement
contents 1-27
'l-28
example
format 1-27
function 1-27
OCL 1-9
parameters 1-14
placement 1-27
spoolingconsiderations 1-28
date support
job date 2-63
iobstep date 2-63
partition date 2-63
system date 2-63
default simulationarea assignments 3-9
DEFERparameter,FILEstatement 1-46
definition
external buffers 2-9
main data area 3-10
object module 2-4
simulationareas 3-6
source programs 2-4
volume 3-3
DELETEparameterfor the COPYFILEstatement
($COPY) 4-36
DELETEstatement($MAINT)
control statementsummary 4-'146
FROM parameter 4-148
function 4-146
LIBRARYparameter 4-148
NAME parameter 4-148

lndex

X-5

deletesratement($MAINT) (continued)
PACKINparameter 4_149
parameters 4_149
restrictions 4-147
RETAINparameter 4_148
uses 4-146
deletinga procedureparameter 2_33
deletinga source library 4_125
deletingan object library 4-127
deletinglibraryentries($MAINT)
entries of one type 4-146
entriesof one type, example 4_163
entrieswith names beginningwith certain
characters 4-'l46
example 4-162
entry from a library 4_j46
entry from a library,example 4_162
libraryentries 4-146
temporaryor permanententries 4_146
certain type 4-146
contaancharacters 4_146
same name 4_146
deletingone of severalfiles havingthe
same name ($DELET) 4_75
DENSITYparameter
FILEstatement 1-50
VOL sratement 4-235
direct access storage 3-3
direct file attributes 4-39
direct file tracks B-7
DIRSIZEparamererfor ALLOCATEstatement
($MAINT) 4-120,4-121
disk capacity 3-s
disk data management 2-g
disk FILEstaremenr 1-29
disk initializationprogram
clear initialization 4-.lOO
CYL0 initialization 4-1O,1
exampte 4-106
force initialization 4-101
messages 4-107
OCL considerations 4-106
primary initializarion 4_101
renameinitialization 4_101
UIN statement(see UIN statement)
VOL statement(see VOL statement)
disk requirementsfor data records B_2
disk sort 2-22
disk space allocation
scratchfiles 3-.|0
temporaryor permanentfiles 3_10
disk storage 3-1
disk storageconfigurations 3-3
diskette(3741)file considerations 4_39
D I S P p a r a m e t efro r t h e R E B U I L D
statement 4-14
D I S P L A Yc o m m a n d C - 2 . 2
D I S P L A YO C C c o m m a n d C - 2 . 2

x-6

DISPLAYstatement($LABEL)
control statementsummary 4_1l0
LABELparameter 4-11O
parameterdescriptions 4_,111
parametersummary 4_11,1
SORT-NAMEparameter 4-111
UNIT parameter 4-110
displayingthe spool queues
considerationsand restrictions 4_194
control statement 4-169
parameterdescription 4_1gl
parametersummary 4_,1j4
doubly-definedfiles 2-18
DTF (definethe fite) 2-17
DUMP command C-2.2
D U M P O C Cc o m m a n d C - 2 . 2
dump/restoreprogram ($DCOpy)
COPYPACKstarement 4-63
FROM parameter 4-63
OCLconsiderations 4-65
TO parameter 4-63
dumping disk to tape 4-62

END control statement 4-b
end-of-data (see /* statement)
end-of-data pointer 4-2OB
end-of-index pointer 4-2OB
END parameter,FILEstatement l-SO
END statement 4-b
enteringOCC commands C-1
entraeswith the same name 4-135
ERASEparameterfor the UtN
statement 4-104
extended restart 2-7O
external buffer support
basic assembler 2-10
coBol
2-9
disk sort 2-10
FORTRAN 2-9
RPG il 2-9
external buffers 2-9
definitionof 2-g
use of 2-9
externaf indicators 1-94, 2-48

file and volume label disprayprogram
($LABEL)
OISPLAYstatement 4-1,1O
examples 4-1 16
meaningof VTOC information 4-l 13
OCL considerations 4-'111
VTOC printout 4-1 16

Page
of GC2t-5162_1
lssued28 September
1979
By TNL: GN21-5674
file compress program ($FCOMP) 4-78
considerationsand restrictions 4-83
control statement summary 4-80
examples 4-84
move and copy function
copy function 4-78
move function 4-78
OCLconsiderations 4-84
parametersummary 4-80
programdescription 4-78
file delete program
examples 4-75
OCLconsiderations 4-75
REMOVEstatement 4-72
file facilities 2-11
file index tracks B-5
file locationon main data area 3-10
file names 1-30, 1-46
file names used in the FILE
statement 1-30, 1-46
file recovery
control statement 4-30
main data area 4-30
simulationarea 4-30
fife share area 2-'18
fife sharing 2-16, 2-57
FILEstatement(disk)
parameters
contents 1-29
DATE 1-29
examoles I -36
file names 1-30
file processingconsiderations 1-39
format 1-29
function 1-29
HIKEY 1-43
LABEL 1-29
LOCATTON 1-29
NAME 1-29
PACK 1-29
placement 1-29
programs requiring specific file
names 1-30
RECORDS 1-29
RETAIN 1-29
'I-29
SHARE
specificfile names 1-30
spoolingconsiderations 1-39
TRACKS 1-29
uNtT 1-29
VERIFY 1-29
FILEstatement(disk),programsand file
names 1-30
FILEstatement(multifiletape volumes)
contents 1-57
prepositiontapes 1-58
REELoarameter 1-62
restrictionson use 1-58
SEONUM parameter 1-57
spooling considerations 1-62
standardlabeledfiles 1-59
unlabeledvolumes 1-61

FILEstatement(multivolumedisk files)
contents 1-40
parameters
HIKEY 1-43
LOCATTON 1-43
PACK ',t-41
RECORDS 1-42
RETAIN 1-43
TRACKS 1.42
uNtT 1-41
FILEstatement(multivolumetape files)
contents 1-55
examoles 1-56
parameters
REEL 1-55
uNtT 1-55
spoolingconsiderations 1-56
FILEstatement(OCL)
example 1-36
file processingconsiderations 1-39
FILEstatementconsiderations(backupand
restore) 4-83
FILEstatementconsiderationsfor
multivolumefiles 1-55
format
disk 1-29
tape 1-45
f unction
disk 1-29
tape 1-45
parameter
ASCil 1-51
BLKL 1-49
CONVERT 1-51
DATE, disk 1-35
DATE.tape 1-49
DEFER 1-51
DENSITY 1-50
END 1-50
HIKEY 1-43
HIKEY(packed) 1-44
LABEL,disk 1-32
LABEL,tape 1-48
LOCATTON 1-33
NAME, disk 1-29
N A M E ,t a p e 1 - 4 6
PACK 1-31
PARITY 1-51
RECFM 1-50
RECL 1-50
REEL 1.48
RETAIN,disk 1-34
RETAIN,tape 1-49
SEONUM 1-52
SHARE 1.36
TRACKSor RECORDS 1-32
TRANSLATE 1_51
U N I T ,d i s k 1 - 3 1
UNIT, tape 1-47
VERIFY 1.36

lndex

X-7

filo starement (OCL) (continuedl
plac€mont
disk 1-29
tape 1-45
FILE statement (single volume tape files)
contents 1-45
formar 1-4S
function l -4S
parameter
ASCil 1_45
BLKL 1.45
CONVERT 1-46
DATE 1-45
DEFER 1-46
DENSITY 1-45
END 1-45
I.ABEL 1-45
NAME 1-45
PARtry 1_46
RECFM 1-45
RECL 1_45
REEL 1-45
RETAIN 1-45
SEONUM 1-46
TRANSLATE 1-46
uNlT 1-47
placement l-4S
FILE statement (tape)
combinations of seven track
specifications l -54
files names l-46
parameterapplicabilityfor nine
track 1-53
parametorapplicabilityfor ssven
track 1-53
programs and file names 1_46
programs requiring specific file
names 1-46
seven track considerations l_S2
specific file names t-46
tape file statem€nt summary l_S3
FILE statement parameters
deviceindependent 1-17
d i s k 1 - 15
tape 1-16
file-to-librarycopy function of library
maintenanceprogram 4-,llg
files
automatic allocation 2-13
creation 2-12
dofinition 2-11
disk files 2-12
farge indexed files 2-23
location 2-13
multifile tape volumes Z-25
multivolume disk files 2-24
multivolume tape files 2-25
organization
direct 2-11
indexed 2-11
s€quential 2-11

x-8

files {continued}
processtng
consecutive 2-11
random 2-11
soquential 2-1'l
programming considerations 2_26
SDTF (share define the file) 2-17
services 2-15
sharingfiles
compatible access methods 2_1j
compatible disk access
mothods 2-18.2
considsrationsand
restrictions 2-'18.1
doubly-defined files 2-19
DTF (define the fite) 2-17
file share area 2-1A
FSQE(file share queue element) 2-19
work files 2-20
files and subrourines(OCOpy) 4-lg5
format of cylinder0
3-12
format of data module 3-3
format of OCL statement
/. statement 1-96
/ & statement 1-gs
/r statement 1-lOO
r statement 1-99
ASSIGN starement 1-21
BSCA statement 1-23
CALL statemont 1-24
COMPILEstatemenr i-25
OATE statement 1-27
FILEstatement
device independentfiles 1-63
multifiletape volumes 1-57
multivolumedisk files 1-40
multivolumetape files l-Ss
single volume disk files 1-29
singlevolume tape files 1-4S
HALT statement 1-65
IMAGE statement 1-66
JOB statement 1-71
LOAD and LOAD* statement ,l-75
LOG statement 1-80
NOHALT sratement 1-82
PAUSEstatement 1-84
PRINTERsratemenr l-85
PUNCH statement 1-88
READERstatemenr l-9.l
RUN statement 1-92
SWITCH stat€ment 1-93
format of volume 3-3
FORMAT parameterfor the IMAGE statement
GHAR 1-66
HEX 1-66
MEM 1-66
FORMAT stat€ment for the file delete
program
example 4-77
purpose 4-72
FORTRAN 2-21
free up allocatsd, but unused space 4-71

P a g eo f G C 2 1 - 5 1 6 2 - l
lssued28 September
1g79
ByTNL: GN21-5674
free up allocated,but unusedspace,
example 4-77
FROM paramerer
ACCESSstatement($COPYI 4-33
CLEARstatement($SCOPY) 4-222
COPYstatement($MAINT) 4-132
COPYAREAstatement($SCOPY) 4-219
COPYFILESstatement($FCOMP) 4-80
COPYIPLstarement(gsCOPY) 4-223
COPYPACKstatement($COPY) 4-31
COPYPACKstatement($DCOPY) 4-63
COPYSPstatement($OCOPY) 4-176
DELETEstatement($MAINT) 4-'148
MODIFY statement($MAINT) 4-151
MOVE statement($SCOPY) 4-224
RENAMEstatement($MAINT) 4-153
SELECTKEY statement($COPY) 4-36
SELECTRECORDstatement($COPY) 4-37
TAPEFILESstatement($FCOMP) 4-81
FSOE(file share queue element) 2-18
function of OCL statements(see desired
statementtype)
function of system service programs 4-3

gaps in the object library 4-127
generalcoding rules 1-4
generalcoding rules (see coding rules)
generalinformation,model 15D xi
greaterthan 48K programs 2-9

HALT command C-3
HALT OCC command C-3
HALT statement 1-17. 1-65
HALT statement(OCL) 1-10
halt 90 1-84
halt 91 1-84
HEX format oarameterfor the IMAGE
statement 1-66
HIKEY parameterfor the FILE
statement 1-43
HIKEY parameterfor the FILEstatement.
packed 1-44
HISTORYparameter,ALLOCATEstatement
($MAINT) 4j122
HOLD command C-3
how to change the configuration
record 4-17
how to request $OCOPY from a
terminal 4-205
how to use this manual ix
how to write control statements 4-4

IBM System/3 standardcharacterset A-1
lD parameter,VOL statement
($TtNlT) 4-235
IDELETEcommand C-3
IMAGE statement 1-i7
IMAGE statement(OCL) 1-10
IMAGE statement(OCL),spooling
considerationsfor 1-68
IMAGE sratementoarameters 1-17
INCLUDEstatement 1-17
example 1-7O
function 1-69
OCL 1-10
'l-17
table of parameters
includingcomments in OCL statement 1-7
includingsystem programsin a
library 4-'12'l
incorrectdata 4-12, 4-16
INCR parameterof MODIFY statement 4-151
index area track requirements B-4
index problems 4-35
indexedfile tracks B-5
|NDEX4O 2-24, 4-2Og
rNDEX4S 2-24, 4-209
indicatethe number of lines per page the
orinterwill orint 1-85
parameterfor the SWITCH
indicator-settings
statement 1-93
initial program load (lPL) 2-4?, 3-13
initializingdisks 4-100
initializingtapes 4-233
input device,changing(see READER
statement)
input file name 4-27
inquiry program 2-69
I NSERTstatement($MAINT)
control statementsummary 4-150
functions 4-149
parameters 4-152
inserting source library statements 4-'149
interchangingdata modules 3-6
intervaltimer 2-63
introduction xi
introductionto OCL statements 1-3
introduction-whatis OCL 1-3
IPL (initialprogram load) 2-42, 3-13

lob and job step classification
with nested procedures 2-47
wrthout procedures 2-46
job and lobstep processing 2'44
job mode 2-45
job processing example 2-46
'l-71
JOB statement
JOB statement(OCL) 1-10
JOB statementoarameters 1-18
job stream 2-48
job stream,delimiters 1-96

lndex

X-9

job stream,relationshipto OCL
1-3
job stream,sample l-3
jobname in JOB OCL staremenr
1-l1
jobstep mode 2-44

KEEPcommand OC-4
KEEPOCC command OC-4
Keysortworkspace 2_24
keyword 1-4
keyword parameter l -3

LABELparameter
DISPLAYstatement 4-110
FILEstatement
disk 1-32
tape 1-45
REMOVEstatement 4-72
labeledtapes 2-26
length of namesgiven to librarv
entries 4-135
LENGTHparameter
COPYFILEsratemenr 4_36
REBUILDstatemenr 4-14
libraries
catalogingto activeprogrampacks 2_3g
all programpacks 2_39
CCP program packs 2-39
no program packs 2_39
userconsiderations 2_41
definition 2-26.1
location 2-29
objecr 2-27
procedures 2-32
nested 2-35
source 2-26.1
library directory printouts 4-141
object library 4-142
sourcelibrary 4-141
system directory 4-145
libraryentries,removing
temporary 4-l 19, 4-,|36
libraryentry retrievalsubroutine D_1
libraryfacilities 2-26.1
librarymaintenance
allocateconsiderationsand
restrictions 4-1 19
copy considerationsand
restrictions 4-13 l
deleteconsiderationsano
restrictions 4-147
modify considerationsand
restrictions 4-149
renameconsrderations
and
restrictions 4-.|53

x-l0

librarymaintenanceprogram
ALLOCATEstatement (see ALLOCATE
statement)
COPY statement (see COpy statement)
DELETEsratement(see DELETEstatement)
examples 4-1b6
librarydescription,use of disk
space 4-117
MODIFY statement 4-1SO
multiprogrammingconsiderationsand
restrictions 4-1 19
OCL considerations 4-155
RENAMEstatement(see RENAMEstatement)
LIBRARYparameter
COPY statement 4-129
DELETEstatement 4-146
MODIFY starement 4-1SO
RENAMEstatement 4-l 53
library-to-cardconsideratons
($MATNT) 4-139
library-to-libraryconsiderations
($MArNr) 4-138
library-to-printerconsiderations
($MATNT) 4-139
library, object (see object library)
library, source (see source library)
l i n k i n gS U B R 1 5w i t h a s s e m b l e r D _ s
l i n k i n gS U B R 1 5w i t h R p G I
D-2
LIST parameterof MODIFy statement 4_151
fisting source library statements 4-149
LOAD + programs 2-44
LOAD r statement 1-75
LOAD + staremenr(OCL) l-1 1
load modules 2-s
LOAD statemenr 1-75
LOAD statement(OCL)
t parameter 1-75
examole 1-77
format 1-75
function 1-75
placement 1-75
program-name1parameter 1-76
program,name2parameter 1_76
stepnameentry 1_75
switch characters 1-76
unitl parameter 1-76
unit2 parameter 1-77
LOAD statementparameters 1-19
loadingand running programs 2-43
loadingprogramsfrom a file 1-75
loadingprogramsfrom disk
DATE statement 'l-27
HALT statement 1-65
IMAGE statemenr 1-66
JOB statement 1-71
LOAD statement 1-75
NOHALT statement 1-92
sample job streams 2-48
loadingTRLOG E-1
locationof files on main data area 3_10
location of object library Z-29
locationof scratchfiles 3-10

Pageof GC21-5162-1
tssued28 September
1979
ByTNL: cN2t-5674
locationof sourcelibrary 2-27
locationof system pack 3-14
LOCATIONparameterfor the FILE
statement 1-43
log device 1-79
LOG statement(OCL) 1-10
LOG statementparameters 1-18

magnetictape (seetape, magnetic)
main data area
capacity 3-5
codes 3-14, 4-6, 4-218
definitionof 3-10
use of 3-10
main storageusage 2-71
maintainthe AUTHORIZfile
authorizationchange records 4-196
authorizationfield
position 1 4-196.1
position 2 4-196.1
positions3 and 4 4-196.2
authorizationfile 4-196
changeauthorizationrecord 4-196.3
considerationsand
restrictions 4-196
control statement 4-170
createauthorizationrecord 4-196.3
deleteauthorizationrecord 4-196.3
parameterdescription 4-183
parametersummary 4-174.2
maintainthe authorizefile
(AUTHORTZE4
) -196
maintainingcorrect record number
(multivolumefile) 4-38
maintainingvolume sequencenumbers
(multivolumefile) 4-38
maximumnumberof assignedsimulation
areas 3-9
maximumnumberof control statementsin a
procedure 2-32
maximumnumberof files in SWA 2-15
maximumnumber of levelsthat can be nested
together 2-37
maximum numberof volumes 2-24
maximumprogramsize 2-8
meaningof VTOC information 4-112
MEM, format parameterfor the IMAGE
statement 1-17
messageoptions 2-19
messages
alternatetrack assignment program 4-11
disk initializationprogram 4-107
dump/restore 4-66,4-77
tape initialization 4-236
MFCM1 parameter
PUNCH statement 1-88
READERstatement 1-91
MFCM2 oarameter
P U N C Hs t a t e m e n t 1 - 8 8
R E A D E Rs t a t e m e n t 1 - 9 1

MFCU1 parameter
PUNCH statement 1-gg
READERstatement 1-91
MFCU2 parameter
PUNCH statement 1-gg
READERstatemenr 1-91
minimum number of assignedsimulation
areas 3-9
Model 15D generalinformation xi
Model 15D introduction xi
MODIFY statement($MAINT)
control statementsummary 4-150
functions 4-149
parameters 4-151
restrictions 4-'l4g
movrngobject library 4-119
multifiletape volumes 2-25
null files on taDe 2-Zs
labeled tapes 2-26
unlabeledtaoes 2-25
multifilevolumes,tapes 1-57
multiprogramming
considerationsand restrictions 2-57
examples 2-60
operation 2-52
operatorcontrol commands 2-54
sharingfiles 2-57
multivolumefiles
copying 4-39
disk 1-40
raoe l-55
multivolumetaoe files 2-2s

name of entry to be deleted 4-148
name of entry to be renamed '+-154
NAME parameter
COPYstatement 4-132
DELETEstarement 4-149
FILEstatement
deviceindeoendent 1-63
disk 1-30
tape 1-46
IMAGE statement 1-67
RENAMEstatement 4-154
NAME360 parameter,VOL state,ment 4-105
naming libraryentries
cnaractersto use 4-135
length 4-135
restrictions 4-135
NEND 4-129
nested procedure restart 2-38
nestedprocedures
advantages 2-43
examples 2-35
maximum number of levelsthat can be
nested 2-37
rules 2-37

lndex

X-11

new names to be given to an entry,
rules 4-135
NEWNAME parameter
COPY statement 4-194
RENAMEstatement 4-154
NOHALT command C-3
NOHALT statement

ocL 1-11
OCL, severity codes for l-93
parameters 1-19
NOIDELETEcommand C-4
normal procedurecall 2-32
null files on tape 2-25
number of alternatetracks on a disk 3_1,|
number of availablesimulationareas 3_7
number of files in SWA 2-,ls
number of tracks in a direct file B_7
numberof tracks in a sequentialfile B_7
numberof tracks in an indexedfile B_7
N U M B E Rp a r a m e t efro r t h e I M A G E
statem€nt 1-67

object library
changingsize 4-127
creating 4-126
deleting 4-127
gaps 2-29,4-127
location 2-29
maintaining 2-29
organization 2-29
physical characteristics
directory 2-27
size 2-27
reorganizing 4-127
object modules 2-4
OBJECTparameter
ALLOCATEstaremenr 4-126
COMPILE
sratement,l-25
OCC commands C-1

ocL
code parameter 1-4
coding rules (see coding rules)
oata parameter 1-4
input job stream l-3
introduction 1-3
job stream 1-3
length 1-6
meansof supplying l-3
parameters 1-4
special characters(see coding rules)
s p o o l i n gc o n s i d e r a t i o n s , l - 7
statement
examole 1-4
identifiers 1-4
OCL considerations
for spoolingand
multiprogramming 1-7

x-12

OCL considerationsfor system service
programs
alt track assignmentprogram 4_10
alt track rebuildprogram 4-1S
chain cleaningprogram 4-109
configuration record program 4-24.2
copy/dump program 4-41
disk initializationprogram 4-101
dump/restore program 4-65
file and volume label display
program 4-1 16
file compress program 4-84
file delete program 4-75
librarymaintenanceprogram 4-155
recover index program 4-210
simulationarea program 4-Z2S
spool file copy program 4-.|96.6
system history area display program 4_94
tape error summary program 4-240
tape initializationprogram 4-236
VTOC service program 4-242
OCL parameterstable 'l-14
OCL statement, coding notes l-g
OCL statements
/ . 1-13
1-12
/ &
* 1-13
ASSIGN 1-9
BSCA 1-9
CALL 1-9
C O D EM E A N I N G 1 - 1 4
COMPILE 1-9
DATE 1-9
FILE 1-9
HALT 1-10
IMAGE 1-10
INCLUDE 1-10
JOB 1-10
LOAD 1-10
L O A D l 1 - 11
LOG 1-11
NOHALT 1-11
PAUSE 1-11
P R I N T E R 1 _ 11
PUNCH 1-'12
READER 1-12
RUN 1-12
swtTcH
1-12
OMIT parameterfor rhe COpyFILE
statement 4-36
operator control commands C-l
operator control commands (OCC)for
multiprogramm
ing
cancel 2-54
change 2-54
display 2-54
dump 2-54
halt 2-54
nohalt 2-55
pty 2-55

pageof GC21_5162-1
tssued2g September1g7g
By TNL: cN2t_5674
operator control commands (OCC)for
multiprogramming(continued)
reader 2-55
ser 2-55
start 2-56
stop 2-56
operator control commands {see OCC)
options to messag€s Z-19
organizationof the object library 2_29
organizationof the source library 2_27
OUTDM statement 4-30
OUTPTX parameterfor the COpyFILE
statement 4-34
output file name 4-27
OUTPUT parameterfor the COpyFILE
statement 4-34
OUTPUT statement {$H|ST) 4-94
overlay linkage editor 2-5, 2-23
overlays
areas 2-7
memory resident 2-7
segments 2-7

PACK parameter
ALT statement 4-8
ALTA statement 4-213
CATLG statement 4-22.2
FILEstatement 1-31
REBUILDstatem€nr 4-14
REMOVEsratement 4-74
VOL statement 4-10S
parameter
keyword 14
table of parameters 1-14
parametersummary, systom service progrSms
ACCESSstatemenr ($COpy) 4-33
ALLOCATEstatement ($MAtNT) 4-1ZO
ALT statement ($ALT) 4-8
ALTA statement ($RSALT) 4-213
ASNP stat€ment($CNFIG) 4-tg
AUTHORIZEstatement {$OCOpy} 4-174.2
CLASSIFYstatement ($OCOpyl 4-174.2
CLEAR statemenr (gSCOpy) 4-219
COMPRESSsratement ($WVTOC) +241
COPY statement ($MAINT) 4-192
COPYAREAsratement ($SCOpy) 4-177
COPYCTRLstatement ($OCOpy) 4-174
COPYFILEstatemenr ($COpy) 4-29
COPYFILESstarem€nt ($FCOMp) 4_gO
COPYIPLstatemenr ($SCOpy) 4-221
COPYPACKstatemenr ($COpy) 4-Zg
COPYPACKstatement ($DCOpy) 4-63
COPYPCHOstaremont ($OCOpy) 4-172
COPYPRTOstatement ($OCOP$ 4-171
COPYO statement ($OCOpy) 4-174.1
COPYRDROstat€ment ($OCOpy) 4-173
COPYSPstatement ($OCOpy) 4-171
DELETEstat€ment ($MA|NT) 4-146

param€ter summary, system service programs
(continued)
DISPIAY statement($LABEL) 4-1tO
DISPLAY statement ($OCOpy) 4-174
INSERTstatement($MAINT) 4-152
KEY sratemenr ($COpy) 4-ZB
MODIFY stat€menr($MAtNT) 4-tSl
MOVE statement (gSCOpy) 4-220
NAMES statement ($SCOpy) 4-220
NEWNAME stat€ment ($SCOpy) 4-220
OUTDM stat€ment ($COpy) 4-30
OUTPUT statement ($HtST) 4-94
PRINT statement (gHtST) 4-94
REBUILDstat€menr($BUtLD) 4-13
REMOVEstar€ment($DELETE) 4-72
RENAMEsratemenr($MAINT) 4-154
REPLACEstatement ($MA|NT) 4-1Sz
RESTOREstatoment ($OCOpy) 4-174
SELECTstatement ($COpn 4-28
UIN statement($lNtT) 4-t01
VOL statement,($tNtT) 4-102
VOL starement, ($TtNtT) 4-235
PARIry s€ven track tape l-51
partitionchanging 1-72.1
PARTITIONparamet€r for JOB
statement 1-72.1
partition(s)
multiprogramming 2-57
size 2-B
PAUSE stat€mont
function l-84
parameters 1-19
PAUSEstatementOCL 1-11
pormanentfile, deleting 1-34
placom€nt of OCL statements (see the
desired statement type)
positionaloperands C-l
primaryinitialization 4-100
primaryinitialization,
example 4-106
print compilation date 4-194
print configuration record 4-18.1
PRINT parameterfor device independentfile
statement 1-64
PRINT statement ($HtST) 4-94
printer chain image (see IMAGE statement)
printer forms (see PRINTERstatement)
PRINTEROCL statement
ALIGN parameter l -19
CLOSEparameter 1-19
COPIESparameter 1-19
D E F E Rp a r a m e t e r 1 - 1 9
DEVICEparameter l-19
F O R M S N Op a r a m e t € r l - 1 9
LINES parameter l-19
OCOPYparameter l-19
P R I N T E Rs t a t e m e n r 1 - 11 , 1 - 8 S
PRINTERstatem€ntparametors 1-19
printing compilation dato 4-134
printing file information from the
woc
4-109
printing files 4-27
printing files, example 4-44

Index

X-l3

prantinglibrarydirectories 4-139
printinglibrarydirectories,
example 4-158
pnntrngrecordsusing record keys 4_36
printing records using relative record
numbers 4-37
printangthe entirecontentsof the
vToc 4-110
priorityparameter 1-18
priorityparameter,JOB statement 1_j2
procedure-name
parameterfor the CALL
statement 1-14, 1_24
procedureoverride statement 2_33
procedures
adding a missingparameter 2_33
adding a statement 2-33
changingprocedureparameters 2_33
deletinga procedureparameter 2_33
example 2-34
insertingstatements 2-33
listing 4-'149
modifying 2-33
nested 2-35
normal procedurecall 2-32
procedureoverride statement 2_33
removing statements 4-149
replacingstatements 4-149
processinglarge indexed files 2-23
processingmultivolumefiles 2-24
programfunction 4-3
programload switch 3-14
programname 4-3
program-nameparameterfor the LOAD
statement 1-18,1-76
program pack definirion 2-39
program pack protection 2-3g
programreferenceinformation F-1
program(s)
concepts 2-4
execution 2-42
size 2-8
storing 2-30
programmingconsiderations E-2
programsand file names 1-30, 1-46
programsrequiringspecificfile
n a m e s 1 - 3 0 ,1 - 4 6
protect program packs 2-39
PTY command C-4
P U N C Hs t a t e m e n t 1 - 8 9
PUNCH statemenr(OCL) 1-12
PUNCHstatementparameters 1-lg

OCOPYparameter 1-19
queues
print 2-67
punch 2-67
reader 2-67

x-14

read $OCOPY control statements from a file
considerationsand restrictions 4-194
control statement 4-169
parameterdescription 4-1Bl
parametersummary 4-174
READERcommand C-4
R E A D E RO C C c o m m a n d C - 4
READERstatement 1-91
READERstatement,(OCL) 1-'12
READERstatement, parameters 1-2O
reader-to-librarycopy f unction,
$MAtNT 4-137
reassrgna 5444 unit code and change
catalog support 4-25
reassign all 5444 unit codes for three
partitions 4-25
reasstgnalternatetrack program 4_212
reassignone 5444 unit code in a
partition 4-25
reassigningsimulationareas 1-21, 3-g
R E B U I L Ds t a t e m e n (t $ B U t L D )
control statementsummary 4-12
DISP parameter 4-14
LENGTHparameter 4-14
PACK parameter 4-'13
parametersummary 4-13
TRACK parameter 4-14
UNIT parameter 4-13
RECFMparameter,FILE statement
(tape) 1-50
RECLparameter,FILEstaremenr
(tape) 1-50
RECORDSparameterfor the FILEstatement
(disk) 't-32
records-tracksconversion B-7
recover files ($COPY) 2-15, 4-41
recover index program 2-15, 4-2OB
REELparameter
FILEstatement 1-48
VOL statemenr 4-235
relatedpublications ii
relationshipof OCL to the job stream 1-3
relativelocationof each 3344
volume 3-10
RELEASEcommand C-4
RELEASEOCC command C-4
REMOVEstatement($DELET)
controtstatementsummary 4-72
DATA parameter 4-74
DATE parameter 4-74
LABEL paramerer 4-74
PACK parameter 4-74
parametersummary 4-73
UNIT parameter 4-74
REMOVEstatement($MAtNT)
controtstatementsummary 4-1S0
functions 4-149
parameters 4-152
removingfiles from a disk 4-71
removing gaps from between files 4-78
removrng source library statements 4-149
removing temporary library entries 4-146

p a g eo f G C 2 t _ 5 1 6 2 - 1
tssued2g September
1979
ByTNL: cN2t_5674
RENAMEstatement($MAINT)
controt statementsummary 4-153
FROM parameter 4-154
function 4-153
LIBRARYparameter 4-154
NAME parameter 4-154
NEWNAME parameter 4-154
PACKINoarameter 4-154
parametersummary 4-154
renaminga set of sourcestatementsin a
source library 4-153, 4-165
REORGparameterfor the COPYFILE
statement 4-36
reorganizinga sourcelibrary 4-126
reorganizingan object library 4,127
reorganizingthe system pack 4-166
REPLACEstatement($MAINT)
control statementsummary 4-150
functions 4-149
parameters 4-152
replacingexistinglibraryentries 4-138
repfacingincorrectdata 4-12
repfacingsource librarystatements 4-149
repfacingstatements in a procedure 4-149
replacingthe printerchain 1-66
requesting$OCOPY from a terminal 4-205
required tracks for a file index B-4, B-7
requiredtracks for indexedfiles B-5, B-7
R E S E Rp a r a m e t eor f M O D I F Ys t a t e m e n t 4 - 1 5 j
reserializinga source library entry 4-149
responding to error messages

(socoPY) 4-203

RESTARTcommand C-4
RESTARTOCC command C-4
restarting checkpointed programs 2-68
restore function 4-79
restore print or punch queue records
considerationsand restrictions 4-195
control statement 4-169
parameterdescription 4-182
parametersummary 4-174
restoreprint or punch queue recordsfrom a
file 4-195
restrictednames 4-135
restrictions
librarymaintenance
allocate 4-119
copy 4-135
delete 4-146
modify 4-149
rename 4-153
restrictionsconcerningassignmentof
simulationareas 3-g
restrictionsconcerning assignment of 5444
unit codes 3-9
restrictionson naming library
entries 4-135

RETAINparameter
COPYstatement 4-133
DELETEstatement 4-148
FILEstatement
disk 1-34
tape 1-49
retrievinglibraryentries D-1
REUSEcommand C-4
R E U S EO C Cc o m m a n d C - 4
RPG lt 2-21
rules for coding control statements 4-5
rufes for nested procedures 2-37
RUN statement 1-20, 1-92
RUN statement(OCLI 1-12

samplejob stream 1-3
samplestatementsfor compilingand storing
source programs 2-31
scheduler 2-3
schedulerwork area 2-15
scratchfile
changinga temporaryfile to a scratch
f ile 1-34
location 3- 10
scratchinga file 1-34
SDTF (sharedefine the file) 2-17
SELECTKEY for the SELECTstatement 4-36
SELECTPKY for the SELECTstatement 4-36
S E L E C TR E C O R Df o r t h e S E L E C T
statement 4-37
SELECTstatement($COPY)
control statement summary 4-29
FROM parameter 4-36
parametersummary 4-32
SELECTKEY 4-36
SELECTPKY 4-36
SELECTRECORD 4-37
TO oarameter 4-36
sefectingthe 2 option for a message 2-19
selectingthe 3 or D option for a
message 2-'19
SEOFLDparameterof MODIFY
statement 4-151
s e o u e n c en u m b e r si n M O D I F Y
functions 4-149
seouentialfile tracks B-7
SET command C-5
SET OCC command C-5
setting externalindicators 1-93
seven-tracktape considerations 1-52
severitv codes 2-48
severitvcodes for NOHALT OCL
statement 1-83
SHA printout 4-95
sharingaccessto added records 2-59

Index

X - 15

simulationarea codes
$scoPY
4-218
device codes 4-6
simulationarea program 4_216
CLEARparameters
AREA 4-222
CLRNAME 4-181
FROM 4_222
tD 4_222
PACK 4_222
TYPE 4-223
controt statement 4_217
COPYAREAparamerers
AREA 4-222
FROM 4_222
PACK 4_222
SYSTEM 4-222
TO 4_222
TONAME 4-222
COPYIPLparameters
FROM 4-223
PACK 4_223
TO 4-223
MOVE parameters
AREA 4.224
CLRNAME 4-223
FROM 4_224
PACK 4-224
TO 4_224
TONAME 4-224
NAMES parameter
PRINT 4.224
NEWNAME parameters
AREA 4-223
tD 4_223
newname 4-223
PACK 4_223
TO 4_223
TONAME 4-222
parameterdescriptions 4_222
parametersummary
CLEAR 4-219
COPYAREA 4-2'19
coPYtPL 4_221
MOVE 4_220
NAMES 4.220
NEWNAME 4.220
simulationareas
accessing 3-6
assignmentduring system generation 3-9
default assignment 3-9
definition of 3-6
m a x i m u mn u m b e r 3 _ 7 ,3 _ 1 O
m i n i m u mn u m b e r 3 - 7 , 3 _ 1 0
reassignment 1-2,1
. 3-g
restrictions 3-9
use of 3-6
source library
adding entries 4-137
changingsize 4-118, 4-124
creating 4-1'18,4-124
deleting 4-118,4-125

x-l 6

source library(continueor
Insenlngstatements 4_149
listingentries 4-149
location 4-124
organization 2-27
physicalcharacteristics
directory 2-27
locarion 2-27
organizationof entries 2_27
size 2-27
removtngstatements 4_149
reorganizing 4-118, 4-,118
replacingstatements 4-149
reserializing
entries 4-149
SOURCEparameter
ALLOCATEstatement 4-.121
C O M P I L Es t a t e m e n t 1 - 1 4 . 1 - 2 5
source programs Z-4
specialcharacters 1-S, 4-s
specificfile names (disk) 1-30
specificfile names (tape) 1-46
spool 2-42,2-67
spool file copy program
controt statementsummary 4_16g
examples 4-196.6
files and subroutines 4-1gs
functions 4-168
O C L c o n s i d e r a t i o n s4 - 1 9 6 . 6
parameterdescriDtions
AUTHORIZE 4.183
CLASSIFY 4_184
coPYCTRL 4_181
coPYPCHO 4_177
coPYPRTO 4_176
coPYo 4_183
coPYRDRO 4_178
coPYSP 4_176
DISPLAY 4-181
RESTORE 4-182
parametersummary 4_171
programdescription 4-167
spool file considerationsand
restrictions
assignclass numbersto
programs 4-196.3
copy a display of the status of the
spool queues 4-194
copy .jobsto or from the reader
queue 4-192
copy selectedjob steps from one spool
file to another 4-195
copy selectedjobsteps from the print
queue 4-184.1
copy selectedjobsteps from the punch
queue 4-190
copy the entire spool file 4_1'94.1
file requirements 4-184
partitionsize requirements 4_194
read control statements from a
file 4-194
restoreprint or punch queue records
from a file 4-195

P a So
ef G C 2 1 - S 1 6 2 - l
tssued28 September,|979
ByTNL: GN21_5674
spool file copy program (continued)
using the spool file copy program under

ccP

CCP assignmontset 4-204
constderation{;
for terminatinS$OCOpy
under CCP 4-206
displayingthe spool queues 4-203
examples 4-206
how to reque!;t$QCOpy from a
terminal 4-2O5
placingjobs cn the readerqueue from a
terminal 4-2O3
programrequest 4-202.2
respondingto error messages 4-203
user authorization 4-202.3
using $OCOP'/from a terminal 4-202.3
SPOOLparameterin JOB statement 1-72
spooling
controlling 2-42
devices used with 2-67
generalinformatir>n 2-67
tPL 2-42
performancewitl- 2-67
processingwith 2-43
StandardCharacteriiet A-1
START command (l-5
START OCC command C-5
statement
beginningwith /,/ 1-6
beginningwith olher than I I 1-l
description,generalinformation 1-8
descriptions(OCL) 1-9
examples(OCL) 1-4
identifier 1-4
length 1-6
STOP command C-5
STOP OCC command C-b
storagemedium (disk)
capacity 3-5, 3-6
cylinderdesignation 3-6
format 3-7. 3-B
storing and compilingsourceprogramsin
the object library 2-31
stonng programsinto libraries 2-30
s u b r o u t i n e1 5 ( S U B R lS )
error identification D-6
linkingwith assembler D-5
l i n k i n gw i t h R P Gl l D - 2
substitutedata 4-13
s u m m a r yo f O C C c o m m a n d s C - 1
summaryof OCL parameters 'l-14
supervisor 2-3
support for catalogingto a program
oack 2-39
surfaceanalysis 4-104
SWA-maximumnumber of files z-ls
switch characters
CALL statement 1-24
I N C L U D Es t a t e m e n t 1 - 6 9
LOAD statement 'l-76

SWITCH statement
ocl
1-12
parameter 1-2O,1-93
system control programming(SCp)
date 2-63
history area 2-66
input device 2-64
integrity
data file security 2-69
volume security 2-70
log device 2-65
print device 2-66
punch device 2-66
service programs 2-3
system date 1-27,2-63
system directory 4-135, 4-145
system history area 2-66
system history area display program($HIST)
control statement summary 4-94
examples 4-97
function 4-93
OCL considerations 4-94
parameterdescriptions 4-94
system input device
changing 1-91
considerations 1-91
system integrity
data file security 2-69
volume recognitionfacility 2-7O
volume securitv 2-7O
system fog device 'l-79,2-65
SYSTEMparameterfor the ALLOCATE
statement 4-121
system print device 1-85, 2-66
system punch device 1-88, 2-66
system service programs 2-3, 4-1
System/360-system/370packs 4-212

table of OCL statements 1-9
table of parameters 1-14, 1-14
tape error summary program 4-239
tape file statementsummary 1-53
tape initializationprogram 4-233
tape, magnetic
copying using copy/dump program 4-39
error logging 4-239
FILEstatement 1-45
FILEstatementsummary 1-53
initialization 4-233
multifilevolumes 1-57
multivolumefiles 1-55
telfingthe system not to halt 1-82
telling the system to halt 1-65
temporaryfile 1-34
temporaryfile, changinga temporaryfile
to a scratchfile 1-34
temporarylibraryentries 4-1 19
TIME command C-6

lndex

X-11

T I M E O C Cc o m m a n d C - s
tlme stamp messages 4-18.2
TLOG command C-6
TLOG OCC command C-6
TO parameter
ALLOCATEstatement($MAINT) 4_121
C O P Ys t a t e m e n (t $ M A t N T ) 4 - 1 3 3
COPYAREAstarement ($SCOpy) 4-222
COPYFILESstatement($FCOMp) 4_80
COPYIPLstatement($SCOpy) 4_223
COPYPACKstatemenr($COpy) 4-31
COPYPACKstatement($DCOpy) 4_65
COPYOstatement($OCOpy) 4-183
COPYSPstatement($OCOpy) 4-176
MODIFY function ($MAtNT) 4-152
MOVE statement(gSCOpy) 4-224
NEWNAME statement($SCOpy) 4_223
SELECTstatement($COpy) 4-36
TAPEFILESsratemenr($FCOMp) 4_g1
TRACEcommand C-5
T R A C Kp a r a m e t efro r t h e R E B U I L D
statement 4-16
track requirements,data area B-1
track requirements,index area B-4
track usagefor indexedfiles B-5
TRACKSparameterfor the FILE
s t a t e m e n t 1 - 1 5 .1 - 4 6
t r a n s a c t i o n l o g g i n gE - l
transactionlogging (operating
considerations) E-2
transactionlogging under COBOLand
FORTRAN E-1
transactionlogging under RpG ll E-1
TRANSLATEseven-tracktaoe 1-b1
type of informatroncontainedin cvlinder
0 3-12
TYPE parameter
UIN statemenr 4-1Oz
VOL statement 4-235
types of directoryentries 4-135, 4-135
types of libraryentries 2-26.1

U I N s t a t e m e n (r $ l N l T )
control statementsummary 4-,|01
ERASEparamerer 4-104
parametersummary 4-102
T Y P Ep a r a m e t e r 4 - 1 0 2
UNIT parameter 4-jO4
V E R I F Yp a r a m e t e r 4 - 1 0 4
u n i t c o d e ,m e a n i n g 4 - 1 8
UNIT oarameter
ALT sratement ($ALT) 4-B
ALTA statement($RSALT) 4-213
CALL statement(OCL) 1-24
COMPILEstatemenr(OCL) 1-25
COMPRESSstatement($WVTOC) 4-241
COPYPCHOstatement($OCOpy) 4-177
COPYPRTOsratement($OCOpy) 4-176

x-l 8

unrt parameter(continued)
COPYRDROstatement($OCOpy) 4-178
DISPLAYstatemenr($LABEL) 4-111
DISPLAYstatemenr($OCOpy) 4-181
FILEstatement(OCL)
device independent 1-64
disk 1-31
tape 1-45
I M A G E s t a t e m e n (t O C L ) 1 - 6 9
LOAD statement(OCL) 1-76
unitl parameter 1-76
unit2 parameter 1-77
R E B U I L Ds r a t e m e n (t $ B U t L D ) 4 - 1 3
REMOVEstatement($DELETE) 4-74
U I N s t a t e m e n (t $ t N t T l 4 - 1 0 4
VOL statemenr($TtNlT) 4-193
unit record restart 2-7O
unlabeledtapes 2-25
use of external buffers 2-9
useof maindataarea 3-10
use of simulationareas 3-6
use of SYSTEM-YESparameter 3-13
u s i n gO C L 1 - 3
using the spool file copy program under
ccP 4-202.1

VERIFYoarameter
ALT statement 4-8
t a b l eo f p a r a m e t e r s 1 - , | 5
UIN statemenr 4-104
VOL statement{$lNtT)
control statementsummary 4-101
lD parameter 4-105
NAME360 4-105
O L D P A C Kp a r a m e t e r 4 - 1 0 5
PACK parameter 4-105
parametersummary 4-102
VOL statement($TlNlT)
control statement summary 4-234
parameterssummary 4-235
volume format 3-3
volume recognitionfacility 2-70
volume,definitionof 3-3. 3-4
volumes,maximum number of 2-24
VTOC (volumetable of contents)
LABELparameter 4-'111
m e a n i n go f i n f o r m a t i o n 4 - 1 , | 3
printout examples 4-1'12
VTOC service program
control statementsummary 4-241
examples 4-242
function 4-241
OCL considerations 4-242
parameterdescriptions 4-241
PACK parameter 4-241
UNIT parameter 4-24'l
parameter summary 4-241

P a g eo f G C 2 1 - 5 1 6 2 - 1
l s s u e d2 8 S e p t e m b e r1 9 7 9
By TNL: GN21-5674

work area, library maintenance
program 4-122
work files 2-2O
work parameter 4-122
writing control statements 4-4
system service programs
coding rules 4-5
END statement 4-5

1403 parameter,LOG statement 1-18, 1 - 8 1
1442 parameter
PUNCH statememt 1-88
P U N C Hs t a t e m e n t 1 - 1 9
READERstatement 1-20. 1-91
2501 parameter,READER
statement 1-20, 1-91
3340 direct access storage 3-3
3344 direct access storage 3-4
3741 file considerations 4-39

Index

X-19

x-20

TechnicalNewsletter

This NewsletterNo.
Date
BasePublicationNo.
File No.

GN21-5674
28 September1979
GC21_5162-1
53-36

PreviousNewsletters None

IBM System/3Model15
SystemControl Programming
Conceptsand ReferenceManual
O IBMCorp.1976,1977,1g7g
This technicalnewsletterappliesto version04, modification00 of the IBM System/3Model15 System
Control Program(ProgramNumber5704-SC2)and providesreplacement
pagesforthe subjectpublication.
Thesereplacement
pagesremainin effectfor subsequent
versionsand modificationsunlessspecifically
altered. Pages
to be insertedand/orremovedare:
iii throughx
1-9.1-10
1-21, 1-22
1-29,1-30
1-55 through 1-58
1-71.1-72
1 - 7 2 . 1, 1 - 7 2 . 2 ( a d d e d t o
new and moved text)
1-83. 1-84
2-9,2-10
2-17.2-18
2 - 1 8 . 1, 2 - 1 8 . 2 ( a d d e dt o
new and moved text)
2-25,2-26
2 - 2 6 . ' 1, 2 - 2 6 . 2 ( a d d e d t o
new and moved text)
2-31 through 2-34
2-37.2-38
2-57,2-58
2-54.1 ,2-58.2 (added to
new and moved text)
2-67.2-68
2-6AJ, 2-68,2 (added to
new and moved text)
4-17,4-18
4 - 1 8 . 1, 4 - 1 8 . 2 ( a d d e d t o
new and moved text)
4-19,4-20
4 - 2 O . 1, 4 - 2 O . 2 ( a d d e d t o
new and moved text)
4 - 2 1, 4 - 2 2
4 - 2 2 . 1, 4 - 2 2 . 2 ( a d d e d t o
new and moved text)
4-23,4-24
4-24.1 , 4-24 .2 (added to
new and moved text)
4-25,4-26

accommodate

4 - 2 6 . 1, 4 - 2 6 . 2 ( a d d e d t o a c c o m m o d a t e
new and moved textl
4-37 through 4-42
4-65.4-66
4 - 7 7, 4 - 7 8
4-43,4-44
4-93,4-94
4-131,4-132
4-141 through 4-144
4-167through4-174
4 - 1 7 4 . 1, 4 - 1 7 4 . 2 ( a d d e d t o a c c o m m o d a t e
new and moved text)
4-175throush 4-184
4 - 1 8 4 . 1, 4 - 1 8 4 . 2 ( a d d e d t o a c c o m m o d a t e
new and moved text)
4-185.4-186
4 - 1 8 6 . 1 , 4 - 1 a 6 . 2 ( a d d e dt o a c c o m m o d a t e
new and moved text)
4-187 throush 4-194
4 - 1 9 4 . 1, 4 - 1 9 4 . 2 ( a d d e d t o a c c o m m o d a t e
new and moved text)
4-195.4-196
4 - 1 9 6 . 1 t h r o u g h 4 - 1 9 6 . 6 ( a d d e dt o a c c o m m o d a t e
new and moved text)
4-201 .4-202
4 - 2 0 2 . 1 t h r o u g h 4 - 2 0 2 . 4 ( a d d e dt o a c c o m m o d a t e
new and moved text)
4-203 through 4-206
4-239,4-240

accommodate

C - 2 . 1, C - 2 . 2 ( a d d e d t o a c c o m m o d a t e
new and moved text)

accommodate

accommooate

accommooate

accommodate

accommooare

accommodate

c-1, c-2

accommodate

c-3. c-4
D-5,D-6
E-1. E-2
F-1, F-2 (addedto accommodate
new and movedtextl
X-1 throughX-20

Changes
to text and illustrationsare indicatedby a verticalline at the left of the change.
Summaryof Amendments
o
o
o
.

Enhancements
to Spool File Copy program($OCOpy)
E n h a n c e m e nttos C o n f i g u r a t i oR
n e c o r dp r o g r a m( $ C N F I G )
A d d i t i o n a il n f o r m a t i o na b o u tf i l e s h a r i n g
Miscellaneous
technicalcorrections

y'y'ofe.'
Please
file this coverletterat the backof the manualto providea recordof changes.
IBM corporation, Publications,Department245, Rochester,Minnesota55901
O I B MC o r p . 1 9 7 9

P r i n t e di n U . S . A .



Source Exif Data:
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.4
Linearized                      : No
Page Count                      : 528
Producer                        : iText 2.0.3 (by lowagie.com)
Modify Date                     : 2010:06:29 22:19:52+02:00
Create Date                     : 2010:06:29 22:19:52+02:00
EXIF Metadata provided by EXIF.tools

Navigation menu