JCL Reference Manual - Atossupport.bull.com/ols/product/system/gcos7/gcos7... · DPS7000/XTA NOVASCALE 7000 JCL Reference Manual Job Control and IOF December 1997 BULL CEDOC 357 AVENUE

JCL

Reference Manual

DPS

7000/XTA

NO

VASC

ALE

7000

Job Control and IOF

REFERENCE47 A2 11UJ 04

DPS7000/XTANOVASCALE 7000

JCLReference Manual

Job Control and IOF

December 1997

BULL CEDOC

357 AVENUE PATTON

B.P.20845

49008 ANGERS CEDEX 01

FRANCE

REFERENCE47 A2 11UJ 04

The following copyright notice protects this book under Copyright laws which prohibit such actions as, but notlimited to, copying, distributing, modifying, and making derivative works.

Copyright Bull SAS 1991, 1997

Printed in France

Suggestions and criticisms concerning the form, content, and presentation of thisbook are invited. A form is provided at the end of this book for this purpose.

To order additional copies of this book or other Bull Technical Publications, youare invited to use the Ordering Form also provided at the end of this book.

Trademarks and Acknowledgements

We acknowledge the right of proprietors of trademarks mentioned in this book.

Intel® and Itanium® are registered trademarks of Intel Corporation.

Windows® and Microsoft® software are registered trademarks of Microsoft Corporation.

UNIX® is a registered trademark in the United States of America and other countries licensed exclusively throughthe Open Group.

Linux® is a registered trademark of Linus Torvalds.

The information in this document is subject to change without notice. Bull will not be liable for errors containedherein, or for incidental or consequential damages in connection with the use of this material.

47 A2 11UJ Rev04 iii

Preface

Objectives

This manual describes the Job Control Language (JCL) for the GCOS 7 (GeneralComprehensive Operating System) operating system.

Intended Readers

You should have an elementary overall knowledge of GCOS, and be familiar with theprinciples of job management. The information given in this manual is intended for allusers of DPS 7000 systems with the GCOS 7 operating system (Release V8).

Structure of This Manual

Section 1 contains a general description of the management of jobsand of the role of the JCL within GCOS. The distinction ismade between the fundamental JCL statements of theoperating system (Basic JCL Statements) and thosestatements used in conjunction with various system utilities(Extended JCL Statements).

Section 2 describes the rules for writing JCL statements.

Section 3 describes how to name files, volumes and devices within JCLstatements.

Section 4 contains detailed descriptions of all the Basic JCLStatements. It is organized in alphabetical order of statementname, for easy reference.

Section 5 lists the extended JCL statements and tells you where to findmore information about them.

Appendix A lists the names of JCL statements that have abbreviations.

Appendix B gives ASCII - EBCDIC character conversion information.

JCL Reference Manual

iv 47 A2 11UJ Rev04

Format of JCL Statements

The format model for each statement is written in a typeface different from the body of thetext and adheres to the following notation conventions:

Syntax appears in the following font: ASSIGN internal-file-name

UPPER CASE indicates a keyword item to be entered exactly as shown.

[item] An item within square brackets is optional.

{item1} A column of items within braces means that one value must{item2} be selected if the associated parameter is specified. If the{item3} parameter is not specified, the underlined item is taken as the

default value.

( ) Parentheses must be coded if they enclose more than onepositional item.

... An ellipsis indicates that the preceding item may be repeatedone or more times.

Associated Documents

You are advised to refer to Error Messages and Return Codes Guide 47 A2 10UJ inconjunction with this manual. The JCL User's Guide 47 A2 12UJ is recommended as abasis for using the GCOS Job Control Language.

The following manuals (mentioned throughout this manual), where appropriate, will be ofparticular interest to those readers who require more information about the GCOS 7operating system:

Communications

GCOS 7 MCS User's Guide............................................................................ 47 A2 32UCRemote Facilities DPS6 to DPS7.................................................................... 47 A2 11UCUFT User's Guide ........................................................................................... 47 A2 13UCDJP User's Guide............................................................................................ 47 A2 14UC

File Management and Utilities

UFAS-EXTENDED User's Guide .....................................................................47 A2 04UFData Management Utilities User's Guide ........................................................47 A2 26UFGAC-EXTENDED User's Guide.......................................................................47 A2 11UFCatalog Management Manual ..........................................................................47 A2 35UFCartridge Tape Library Unix Server User's Guide........................................... 47 A2 63UU

Preface

47 A2 11UJ Rev04 v

Interactive Facilities

Forms User Guide............................................................................................47 A2 15USIOF Terminal User's Manual (V7) Part 1 Introduction to IOF............................................................................... 47 A2 38UJ Part 2 GCL Commands ................................................................................. 47 A2 39UJ Part 3 Processor Commands......................................................................... 47 A2 40UJGCL Programmer's Manual.............................................................................. 47 A2 36UJ

Languages

COBOL 85 User's Guide..................................................................................47 A2 06ULFORTRAN 77 User's Guide .............................................................................47 A2 16ULGPL User's Guide ............................................................................................47 A2 36ULPASCAL User's Guide .....................................................................................47 A2 52UL

Program Preparation

Library Maintenance Reference Manual ..........................................................47 A2 01UPLibrary Maintenance User's Guide...................................................................47 A2 02UPFull Screen Editor User's Guide.......................................................................47 A2 06UPProgram Checkout Facility User's Guide .........................................................47 A2 15UP

System Administration

GCOS 7 System Administrator's Manual .........................................................47 A2 54USGCOS 7-V8 System Operator's Guide.............................................................47 A2 53US

Transaction Driven Subsystem (TDS)

TDS Administrator's Manual.............................................................................47 A5 22UTTDS Programmer's Manual..............................................................................47 A5 23UT


vi 47 A2 11UJ Rev04

47 A2 11UJ Rev04 vii

Table of Contents

1. Introduction ........................................................................................................... 1-1

1.1 JOB DESCRIPTION ................................................................................................... 1-1

1.1.1 General Terminology ................................................................................................ 1-11.1.2 Job Enclosure ............................................................................................................ 1-11.1.3 Step Enclosure .......................................................................................................... 1-21.1.4 Input Enclosure ......................................................................................................... 1-21.1.5 Data Enclosure .......................................................................................................... 1-21.1.6 Sample Input Stream ................................................................................................ 1-3

1.2 TYPES OF JCL STATEMENTS ................................................................................. 1-4

1.3 SUBMITTING JOBS ................................................................................................... 1-5

1.4 JOB RUN AND JOB STATES .................................................................................... 1-5

1.5 INPUT READER ......................................................................................................... 1-8

1.5.1 Stream Reader ........................................................................................................... 1-81.5.2 Input Stream .............................................................................................................. 1-91.5.3 JCL Translator ........................................................................................................... 1-10

1.6 JOB SCHEDULING .................................................................................................... 1-11

1.6.1 Job Scheduler ............................................................................................................ 1-111.6.2 Control of Jobs .......................................................................................................... 1-111.6.3 Job Class and Class Attributes ............................................................................... 1-121.6.3.1 Job Classes................................................................................................................. 1-121.6.3.2 Class Attributes ........................................................................................................... 1-13


viii 47 A2 11UJ Rev04

1.7 JOB EXECUTION ....................................................................................................... 1-16

1.7.1 Job Selection ............................................................................................................. 1-161.7.2 Command Interpreter ................................................................................................ 1-161.7.3 Step Execution .......................................................................................................... 1-161.7.4 Step Termination ....................................................................................................... 1-171.7.5 Job Termination ........................................................................................................ 1-17

1.8 SERVICE JOBS .......................................................................................................... 1-19

1.9 FACILITIES AVAILABLE THROUGH JCL ................................................................ 1-20

1.9.1 Spooling of a Unit Record Device ........................................................................... 1-20

1.10 HANDLING INPUT ...................................................................................................... 1-21

1.10.1 The SYSIN Mechanism ............................................................................................. 1-211.10.2 Use of SYSIN .............................................................................................................. 1-21

1.11 HANDLING OUTPUT ................................................................................................. 1-22

1.11.1 Output Writer ............................................................................................................. 1-221.11.2 Standard SYSOUT ..................................................................................................... 1-221.11.3 Permanent SYSOUT Files ......................................................................................... 1-221.11.4 The SYSOUT Mechanism and SYSOUT Format ..................................................... 1-23

1.12 STORED JCL ............................................................................................................. 1-24

1.12.1 Mini-Editor ................................................................................................................. 1-241.12.2 JCL Parameter Substitution ..................................................................................... 1-24

1.13 FILE SHARING AND PASSING ................................................................................. 1-25

1.14 USE OF OPERATOR COMMANDS ........................................................................... 1-25

1.15 CHECKPOINT/RESTART MECHANISM ................................................................... 1-25

1.16 JOURNALIZATION ..................................................................................................... 1-26

Table of Contents

47 A2 11UJ Rev04 ix

2. Rules for Writing JCL Statements ............................................................... 2-1

2.1 GENERAL RULES ...................................................................................................... 2-1

2.2 COMPONENTS OF JCL STATEMENTS ................................................................... 2-3

2.2.1 Label ........................................................................................................................... 2-32.2.2 Statement Name ........................................................................................................ 2-32.2.3 Parameters ................................................................................................................. 2-42.2.3.1 Parameter Types......................................................................................................... 2-42.2.3.2 Default Values ............................................................................................................. 2-72.2.3.3 Protected Strings......................................................................................................... 2-8

3. File Identification and Standard Parameter Groups ............................ 3-1

3.1 FILE IDENTIFICATION ............................................................................................... 3-1

3.1.1 Types of Files ............................................................................................................ 3-13.1.1.1 Cataloged, Uncataloged and Temporary Files............................................................ 3-23.1.1.2 Library Files................................................................................................................. 3-23.1.1.3 SYSIN Files ................................................................................................................. 3-2

3.1.2 File Names ................................................................................................................. 3-33.1.2.1 Permanent File Names ............................................................................................... 3-33.1.2.2 Temporary File Names................................................................................................ 3-73.1.2.3 Library File Names and Member Names .................................................................... 3-73.1.2.4 Input Enclosure Names............................................................................................... 3-73.1.2.5 Non-standard File Names ........................................................................................... 3-83.1.2.6 Summary of Limits for Name Lengths......................................................................... 3-8

3.1.3 File Status .................................................................................................................. 3-93.1.4 Volume Identification ................................................................................................ 3-93.1.4.1 Resident Volume......................................................................................................... 3-93.1.4.2 Non-resident Volume .................................................................................................. 3-103.1.4.3 Non-standard Volume Names..................................................................................... 3-10

3.1.5 Device Identification ................................................................................................. 3-113.1.5.1 Device Class and Attributes ........................................................................................ 3-113.1.5.2 Valid Device Classes................................................................................................... 3-133.1.5.3 Device Name............................................................................................................... 3-16

3.2 STANDARD PARAMETER GROUPS ........................................................................ 3-17

3.2.1 Sequential-input-file-description ............................................................................. 3-193.2.2 Input-file-description ................................................................................................ 3-203.2.3 Sequential-output-file-description .......................................................................... 3-203.2.4 Output-file-description ............................................................................................. 3-213.2.5 Print-file-description ................................................................................................. 3-213.2.6 Work-file-description ................................................................................................ 3-21


x 47 A2 11UJ Rev04

3.2.7 Input-library-description ........................................................................................... 3-223.2.8 Output-library-description ........................................................................................ 3-233.2.9 Print-library-description ........................................................................................... 3-233.2.10 Define-parameters ..................................................................................................... 3-243.2.11 Sysout-parameters .................................................................................................... 3-243.2.12 Size-parameters ......................................................................................................... 3-243.2.13 Step-parameters ........................................................................................................ 3-24

4. Basic JCL Statements ....................................................................................... 4-1

4.1 HOW STATEMENTS ARE PRESENTED .................................................................. 4-1

4.1.1 Function ..................................................................................................................... 4-14.1.2 Enclosure ................................................................................................................... 4-14.1.3 Format ........................................................................................................................ 4-24.1.4 Description of Statement .......................................................................................... 4-24.1.5 Parameters ................................................................................................................. 4-24.1.6 Examples .................................................................................................................... 4-2

4.2 ALLOCATE ................................................................................................................. 4-3

4.2.1 Function ..................................................................................................................... 4-34.2.2 Enclosure ................................................................................................................... 4-34.2.3 Format ........................................................................................................................ 4-34.2.4 Description of Statement .......................................................................................... 4-44.2.5 Parameters ................................................................................................................. 4-54.2.5.1 Mandatory Parameter.................................................................................................. 4-54.2.5.2 Optional Parameters ................................................................................................... 4-5

4.3 ASSIGN ....................................................................................................................... 4-7

4.3.1 Function ..................................................................................................................... 4-74.3.2 Enclosure ................................................................................................................... 4-74.3.3 Format ........................................................................................................................ 4-74.3.4 Description of Statement .......................................................................................... 4-94.3.5 Parameters ................................................................................................................. 4-144.3.5.1 Mandatory Parameters................................................................................................ 4-144.3.5.2 Optional Parameters ................................................................................................... 4-15

4.4 COMMENT.................................................................................................................. 4-30

4.4.1 Function ..................................................................................................................... 4-304.4.2 Enclosure ................................................................................................................... 4-304.4.3 Format ........................................................................................................................ 4-304.4.4 Description of Statement .......................................................................................... 4-304.4.5 Parameters ................................................................................................................. 4-30

Table of Contents

47 A2 11UJ Rev04 xi

4.5 CONSOLE................................................................................................................... 4-31

4.5.1 Function ..................................................................................................................... 4-314.5.2 Enclosure ................................................................................................................... 4-314.5.3 Format ........................................................................................................................ 4-314.5.4 Description of Statement .......................................................................................... 4-314.5.5 Optional Parameter ................................................................................................... 4-31

4.6 $DATA ......................................................................................................................... 4-32


4.7 DEFINE ....................................................................................................................... 4-38


4.8 $ENDDATA ................................................................................................................. 4-53

4.8.1 Function ..................................................................................................................... 4-534.8.2 Enclosure ................................................................................................................... 4-534.8.3 Format ........................................................................................................................ 4-534.8.4 Description of Statement .......................................................................................... 4-53

4.9 $ENDINPUT ................................................................................................................ 4-54


4.10 $ENDJOB ................................................................................................................... 4-55



xii 47 A2 11UJ Rev04

4.11 ENDSTEP ................................................................................................................... 4-56


4.12 EXDIR ......................................................................................................................... 4-57


4.13 EXECUTE ................................................................................................................... 4-58


4.14 $INPUT........................................................................................................................ 4-62


4.15 INVOKE....................................................................................................................... 4-73


4.16 $JOB ........................................................................................................................... 4-77


Table of Contents

47 A2 11UJ Rev04 xiii

4.16.5 Parameters ................................................................................................................. 4-784.16.5.1 Mandatory Parameters................................................................................................ 4-784.16.5.2 Optional Parameters ................................................................................................... 4-79

4.17 JUMP .......................................................................................................................... 4-83


4.18 LET.............................................................................................................................. 4-90

4.18.1 Function ..................................................................................................................... 4-904.18.2 Enclosure ................................................................................................................... 4-904.18.3 Format ........................................................................................................................ 4-904.18.4 Description of Statement .......................................................................................... 4-904.18.5 Mandatory Parameters ............................................................................................. 4-91

4.19 LIB ............................................................................................................................... 4-92


4.20 MESSAGE .................................................................................................................. 4-96


4.21 MODVL ....................................................................................................................... 4-97

4.21.1 Function ..................................................................................................................... 4-974.21.2 Enclosure ................................................................................................................... 4-974.21.3 Format ........................................................................................................................ 4-974.21.4 Description of Statement .......................................................................................... 4-974.21.5 Optional Parameters ................................................................................................. 4-98


xiv 47 A2 11UJ Rev04

4.22 OUTVAL ...................................................................................................................... 4-100

4.22.1 Function ..................................................................................................................... 4-1004.22.2 Enclosure ................................................................................................................... 4-1004.22.3 Format ........................................................................................................................ 4-1004.22.4 Description of Statement .......................................................................................... 4-1014.22.5 Parameters ................................................................................................................. 4-101

4.23 POOL .......................................................................................................................... 4-102


4.24 PREFIX ....................................................................................................................... 4-105


4.25 QASSIGN .................................................................................................................... 4-107


4.26 RELEASE .................................................................................................................... 4-110


Table of Contents

47 A2 11UJ Rev04 xv

4.27 REPORT ..................................................................................................................... 4-112


4.28 RUN............................................................................................................................. 4-113


4.29 SEND .......................................................................................................................... 4-119


4.30 SIZE ............................................................................................................................ 4-121


4.31 STEP ........................................................................................................................... 4-123

4.31.1 Function ..................................................................................................................... 4-1234.31.2 Enclosure ................................................................................................................... 4-1234.31.3 Format ........................................................................................................................ 4-1234.31.4 Description of Statement .......................................................................................... 4-1244.31.5 Parameters ................................................................................................................. 4-1244.31.5.1 Mandatory Parameters................................................................................................ 4-1244.31.5.2 Optional Parameter ..................................................................................................... 4-124


xvi 47 A2 11UJ Rev04

4.32 $SWINPUT.................................................................................................................. 4-127

4.32.1 Function ..................................................................................................................... 4-1274.32.2 Enclosure ................................................................................................................... 4-1274.32.3 Format ........................................................................................................................ 4-1274.32.4 Description of Statement .......................................................................................... 4-1274.32.5 Mandatory Parameters ............................................................................................. 4-128

4.33 SYSOUT ..................................................................................................................... 4-130


4.34 VALUES ...................................................................................................................... 4-138


4.35 WRITER ...................................................................................................................... 4-140


5. Extended JCL Statements ............................................................................... 5-1

Table of Contents

47 A2 11UJ Rev04 xvii

Appendices

A. JCL Statement Names and Abbreviations ............................................... A-1

B. Character Conversion ....................................................................................... B-1

B.1 ASCII ........................................................................................................................... B-2

B.2 EBCDIC ....................................................................................................................... B-4

Glossary ................................................................................................................................... g-1

Index ................................................................................................................................... i-1


xviii 47 A2 11UJ Rev04

Table of Contents

47 A2 11UJ Rev04 xix

Illustrations

Figures

1-1 Job Enclosure.............................................................................................................. 1-21-2 Sample Input Stream .................................................................................................. 1-31-3 Relationship between the Stages and States of a Job Run ........................................ 1-71-4 Input Reader and Associated Files ............................................................................. 1-91-5 Step Execution for a Single-Step Job.......................................................................... 1-183-1 Part of a Catalog Tree Structure ................................................................................. 3-43-2 Valid and Invalid Construction of tree.......................................................................... 3-5

Tables

1-1 Job Class Attributes and Default Values (1/2) ............................................................ 1-143-1 File Naming - Maximum Lengths ................................................................................ 3-83-2 Parameter Value Notation Parameter ......................................................................... 3-173-3 Naming Conventions for JCL Names.......................................................................... 3-185-1 Extended JCL Statements (1/3) .................................................................................. 5-25-2 Explanation of Document Codes used in Table above ............................................... 5-5A-1 JCL Statement Names and Abbreviations (1/2).......................................................... A-2


xx 47 A2 11UJ Rev04

47 A2 11UJ Rev04 1-1

1. Introduction

This section describes, in general terms, the structure of a user's job under GCOS 7, andtraces its progress through the system. The following paragraphs give only a briefexplanation of how to handle jobs. The JCL User's Guide contains a detailed and moreillustrative description.

1.1 JOB DESCRIPTION

1.1.1 General Terminology

Work is normally submitted to the operating system as an input stream , which consistsof one or more job descriptions . Each job description defines a unit of work, known as ajob , that a user of the computer system wishes to run. Job descriptions are composed ofJob Control Language, JCL statements , which supply information about the jobs anddirect how they are run. The task of loading input data into a library may be done by adata enclosure , which does not constitute a job, but is at the same level as a job. Thesyntax of JCL statements is described in Section 2.

1.1.2 Job Enclosure

A job enclosure is the complete set of JCL statements that make up a job description ,starting with a $JOB statement and finishing with a $ENDJOB statement. A typical jobenclosure is made up of one or more step enclosures and possibly one or more inputenclosures (Figure 1-1).


1-2 47 A2 11UJ Rev04

S tepE nc losure

InputE nc losure

JobE nc losure

$JO B--S TE P--E N D S TE P

$IN P U T--$E N D IN P U T----$E N D JO B

Figure 1-1. Job Enclosure

1.1.3 Step Enclosure

A job step specifies the loading and execution of a program, known at execution time asa load module . The set of JCL statements that specifies the characteristics andrequirements of a job step is known as a step enclosure , and several of theseenclosures may appear in the description of a job. As shown in Figure 1-1, each stepenclosure starts with a STEP statement and finishes with an ENDSTEP statement.

1.1.4 Input Enclosure

An input enclosure , beginning with a $INPUT statement and ending (normally) with a$ENDINPUT statement, contains data records to be associated with one or more steps inthe job. These records may be, for example, data for a user load module or a sourceprogram to be read by a compiler.

1.1.5 Data Enclosure

A data enclosure , beginning with a $DATA statement and ending (normally) with a$ENDDATA statement, contains data to be loaded into a specified library. It is at the samelevel as a job enclosure.

Introduction

47 A2 11UJ Rev04 1-3

1.1.6 Sample Input Stream

Each user job in an input stream is delimited by JCL $JOB ....... $ENDJOB statements.The system resource requirements are defined by JCL statements and enclosed by STEP...... ENDSTEP statements. Data in the input stream is delimited by $INPUT ......$ENDINPUT statements. The structure of an input stream therefore consists of threelevels of enclosure (see Figure 1-2). Their functions are to:

• Make the job known to the system: JOB enclosure.

• Describe the handling of each step to the operating system: STEP enclosure.

• Define data input in a job stream: INPUT enclosure.

Job A

Job B

S tepE nc losure

InputE nc losure

S tepE nc losure

InputE nc losure

$JO B JO B A--S TE PA S S IG NA LLO C A TEE N D S TE P

$IN P U T--$E N D IN P U T--$E N D JO B

$JO B JO B B--S TE P-E N D S TE P

$IN P U T--$E N D IN P U T--$E N D JO B

Figure 1-2. Sample Input Stream


1-4 47 A2 11UJ Rev04

1.2 TYPES OF JCL STATEMENTS

Most of the statements of a job description are related to a step description; that is, theyname the load module to be executed, and define the conditions and resources requiredfor the step.

However, if a step involves the execution of a system program, for example a compiler orutility program, then you are not required to include all the JCL statements that define thestep. Instead, only one statement is necessary (for example: COBOL, LIBMAINT), withthe appropriate parameter information that is associated with the statement. The specifiedstatement is equivalent to a set of basic statements that fully define the requirements ofthe step. When the job description is translated to an internal form, the single statementoriginally written by the programmer is expanded into this set of statements. Therefore,the Job Control Language consists of two types of statements:

• Basic JCL Statements , each of which requests a specific system operation; examplesare STEP, ASSIGN.

• Extended JCL Statements , each of which expands into a set of Basic JCL Statementsand is equivalent in itself to a complete step description; examples are COBOL, SORT,PREALLOC.

Section 4 of this manual contains detailed descriptions of the Basic JCL statements.Although Extended JCL Statements are fully documented in other publications, Section 5contains a brief definition of each extended JCL statement with a reference to the manualthat contains the full statement description.

NOTE: Despite their differences in application, both types of JCL statements are writtenusing identical syntax rules (as described in Section 2).

Note the following important points with respect to the documentation and handling of thetwo types of JCL statement:

• Although each of the statements, RUN and EXECUTE, expands into a step, neither is autility statement (that is, both are considered to be part of the basic operating system).Consequently, they are treated as Basic JCL Statements and are described in thismanual.

• All Extended JCL Statements, except SORTWORK and GSORTWRK, must appearoutside step enclosures.

Introduction

47 A2 11UJ Rev04 1-5

1.3 SUBMITTING JOBS

You can submit jobs to the operating system in the following ways:

• locally at your site, from magnetic files (on disks, tapes, cartridges, ...);

• from a remote station, under RBF (Remote Batch Facility) and/or DJP (Distributed JobProcessing);

NOTE: A user of IOF (Interactive Operation Facility) can enter certain JCL statementsdirectly to the system (that is, outside a job enclosure). Full details are given inthe Interactive Operation Facility Manual. In particular, an IOF user terminal mayissue a RUN statement to submit a stored job stream to the system.

1.4 JOB RUN AND JOB STATES

Job Run

The whole life cycle of a job, in contrast to the period of this cycle during which the job isactually being executed, is called the job run.

During its run, a job is uniquely identified by a Run Occurrence Number (). The RON issimply a number of up to four digits that is always preceded by the letter X. For example,X12, X27, X118 are possible RONs.

Steps of a job are referenced by their physical order in the job description; that is, the StepNumber.

Job States

A job run can be thought of as occurring in stages. Each stage of the job run is associatedwith a job state. These states are:

INTRODUCED, IN SCHEDULING, HOLD, EXECUTING, SUSPENDED, OUTPUT

Job states are outlined in Figure 1-3. First, the job is introduced to GCOS: That is, arequest to execute this job is sent to GCOS with the job description; thus the job is"known" to the system. It is at this time that a RON is assigned to the job run. The jobdescription is then translated to an internal format more suitable for execution. In thisprocess all JCL syntax errors are detected.

From the time a job is introduced until the end of JCL translation, the job is in anINTRODUCED state. The Input Reader is used to introduce and translate jobdescriptions. Once translated, the job goes to the IN SCHEDULING state. The JobScheduler, following various rules, chooses from all jobs IN SCHEDULING, the next jobthat will be executed. This job then enters the EXECUTING state.


1-6 47 A2 11UJ Rev04

Eventually the job executes and it goes to the OUTPUT state and stays there until all itsoutput has been printed by the Output Writer, after which the job is no longer known toGCOS.

Two other job states exist, the HOLD state and the SUSPENDED state. These states areused less frequently. Jobs in the HOLD state, although at the same stage as jobs INSCHEDULING, are removed from the scheduler queue and ignored by the Job Scheduler.A job can be put in the HOLD state by a specific parameter (HOLD) in the $JOBstatement or by an operator command, HOLD_JOB (HJ).

A job in the HOLD state can be put IN SCHEDULING by an operator command,RELEASE_JOB (RJ), or a RELEASE statement in a job other than the job that is in theHOLD state. The HOLD state can be used when a job that is introduced should not beexecuted before a certain event has occurred.

You can use the HOLD_JOB (HJ) () operator command to change the order in which jobsare scheduled.

EXECUTING jobs can be suspended by the HJ command.

They are then in the SUSPENDED state. This can prove useful to handle recurrentresource conflicts between two jobs.

You can reactivate a suspended job by means of the RELEASE_JOB command (RJ). Inthis case, the job's execution priority (see below) determines when the job is startedagain.

Introduction

47 A2 11UJ Rev04 1-7

Introduction

I N T R O D U C E D

IN SCHEDULING

E X E C U T I N G

H O L D

S U S P E N D E D

O U T P U T

Translation

Scheduling

TerminationO peratorC om m ands

O peratorC om m andsor R E LE A S E s tatem ent

Figure 1-3. Relationship between the Stages and States of a Job Run


1-8 47 A2 11UJ Rev04

1.5 INPUT READER

The Input Reader is activated by an operator command, or by loading a specific diskette.The Input Reader is in charge of reading a stream of job descriptions, analyzing each joband translating the JCL to a format recognizable by GCOS, and storing the correspondingdata and JCL statements separately for scheduling and executing the job later.

The Input Reader has two successive load modules: the Stream Reader and the JCLTranslator. The Stream Reader and the JCL Translator are separate load modules in aspecific job (see "Service Jobs" below).

1.5.1 Stream Reader

When the Stream Reader is requested to read an input (see Figure 1-4), it assigns theinput device and awaits the first record. For each job, the JCL statements in the inputstream are stored (in "source" form) as a file in the backing store. Each input enclosure isstored separately in a system file known as SYS.IN. In this way, the Stream Readerseparates input enclosures from the job description, giving one stored JCL file and "n"SYSIN sub-files for "n" input enclosures.

If the Stream Reader encounters a $SWINPUT statement, it switches reading from thecurrent stream to the file indicated by $SWINPUT. When the $ENDJOB statement isencountered, an entry is made in a queue that is accessible by the Translator. TheStream Reader then repeats its activity for the next job, until the end of the input stream isreached. At this point, an end of input notification is sent to the Translator and translationis requested.

NOTE: Once the Stream Reader has separated and stored the JCL file, the $JOB and$ENDJOB statements are no longer part of the job and are not passed to theJCL Translator. After the "n" input enclosures have been stored, none of the$INPUT and $ENDINPUT statements exist in the job description. Similarly, afterthe Stream Reader has finished switching, the $SWINPUT statements no longerexist in the job description.

Introduction

47 A2 11UJ Rev04 1-9

1.5.2 Input Stream

Figure 1-4 illustrates the input stream.

$ S W I N P U T

T R A N S L A T O R

INPUT READER

SYSIN Source JCL Translated JCL

E J R C O M M A N D

TA P E /C A R TR ID G E

R B F /D JP

STREAMR EAD ER

B ack ingS tore

(R eport)

B ack ingstore

B ack ingstore

'n 'Inpu tenclosure

Figure 1-4. Input Reader and Associated Files


1-10 47 A2 11UJ Rev04

1.5.3 JCL Translator

When the JCL Translator is notified by the Stream Reader that the end of an input streamhas been reached, it starts to translate the JCL statements stored in the backing storefiles, into a format that is executable by the Command Interpreter (described below). Foreach JCL file produced by the Stream Reader's activity, the translator opens a file in thebacking store, to which the "translated" JCL statements of a job description are written. Inaddition, a listing of the JCL and Translator error messages is sent to the (JobOccurrence Report).

Although the jobs are introduced into the system (by the Input Reader) in the order inwhich they appeared in the job stream, the jobs in the input stream are selected fortranslation according to their scheduling priority (as specified in the $JOB statement).

Introduction

47 A2 11UJ Rev04 1-11

1.6 JOB SCHEDULING

When the translation of a job description is complete, if the Input Reader has found noerrors, the Job Scheduler determines when the job can be started.

1.6.1 Job Scheduler

The Job Scheduler controls the system load at the job level, and allows you to organizeand plan the workload to optimize the throughput of the system. In addition, it providesyou with a series of commands (both JCL statements and OPERATOR commands) tocontrol the job flow.

The Scheduler Queue

There is a scheduling priority associated with each job, indicating its priority of schedulingrelative to other jobs. Scheduling priorities range from 0 (the highest) to 7 (the lowest).Jobs IN SCHEDULING are stored in one queue (the Scheduler Queue), which they enterat the end of the JCL translation and leave when they start to execute.

Scheduling priority can optionally be specified for a job (PRIORITY parameter in $JOBstatement). If it is not, a default value that is associated with the job class is used.

NOTE: You can modify the scheduling and execution priorities of a job as well as itsstate.

1.6.2 Control of Jobs

There are practical reasons for restricting the number of jobs that are executingsimultaneously. For example, if three tape drives are available, it is useless to try toexecute two jobs simultaneously if each requires three tape drives. For such reasonsGCOS provides a set of functions to control the number and type of jobs executingconcurrently as well as the order in which they are executed.

The number of jobs that are in the EXECUTING and SUSPENDED states at a given timeis known as the System Load. There is an overall limit, known as the SystemMultiprogramming Limit (or maximum system load) that controls the number of such jobs.

At any time, the jobs that make up the System Load are divided among one or several jobclasses.


1-12 47 A2 11UJ Rev04

1.6.3 Job Class and Class Attributes

1.6.3.1 Job Classes

Job classes are a means of organizing your workload, to optimize the throughput of jobsin a multiprogramming environment. For example:

• Some jobs need to be executed serially (one after another) because of the installationdependencies or constraints.

• Some jobs must be executed at given periods of time (night shifts, etc.).

• To take the best advantage of multiprogramming, some job mixes (runningsimultaneously) are more favorable than others. For example, central processor boundand I/O bound jobs are grouped together, instead of groups of all central processorbound jobs.

• If several jobs use the same resources (for example tape units or other peripherals)they should not be scheduled simultaneously: this will minimize the amount of timespent waiting for a resource to become available.

Each user job entering the system belongs to a certain class. You can associate a seriesof attributes with each class and thus control the job mixes and workload planning. Theclass or classes under which a project can run a job are stored in the description of theproject in the Site Catalog. The job classes are assigned to a project by the SystemAdministrator using the MAINTAIN_CATALOG commands CRP and MDP.

A job class is identified by one or two letters:

A...Z, AA...AZ, BA...BZ,...,ZA...ZZ

This provides a theoretical limit of 702 different job classes, however, a maximum of 256can actually be supported by the job scheduler.

The one-character classes, A to Z, are initialized at configuration time. Their defaultattributes are summarized in Table 1-1. Under certain conditions these attributes can bemodified, but the class cannot be deleted.

The two-character classes must be created and then initialized using the START_LOADcommand. The two_character classes can also be created at CONFIG time. They can bedeleted using the TERMINATE_LOAD command. Refer to the System Operator's Guidefor details.

• Classes A to Q and AA to QZ are for user jobs.

• Classes R to Z and RA to ZZ are reserved for service jobs. They are not available touser jobs.

• Classes A to P and AA to PZ are for batch jobs, with class P as the default.

• Classes A to Q and AA to QZ are for IOF jobs, with class Q as the default.

Introduction

47 A2 11UJ Rev04 1-13

A class multiprogramming limit (or maximum class load) controls the number of jobs thatcan execute simultaneously in a given class (the actual number at any time is called theclass load).

Default job scheduling and step execution priorities, and default multiprogramming limitsare associated with each job class.

In addition, you can suspend or reactivate a job class. This provides further capabilities toselect job processing and manage the serial execution of jobs.

1.6.3.2 Class Attributes

A job is scheduled and then executed according to rules imposed by the job class towhich the job is assigned. These rules are called job class attributes. Three attributes areattached to each class and used to optimize your work load as long as the job itself exists.These attributes are never erased by a system shutdown or system crash, and areunaltered unless the permanent backing store is destroyed. You can modify them with theMODIFY_LOAD (MDLD) command, if necessary.

The attributes are:

Scheduling Priority

The scheduling priority; (PRIORITY) determines where in the queue and for how long thejob waits to run. The scheduling priority of a job may be restricted for this project by theauthorized classes in the site catalog. The project default priority is used for jobs whosepriority violates this restriction or that have no priority specified in the $JOB or RUNstatements. If there is no default value based on project, then the default priority is basedon job class. You can also override it with the MODIFY_JOB (MDJ) command.

Execution Priority

The execution priority (XPRTY) determines the job's competitiveness for memory andCPU resources. The default value is allocated to all steps of all jobs in a class for whichthe execution (or dispatching) priority (XPRTY) is not specified in the STEP statement.Again, you can override it with the MDJ command.


1-14 47 A2 11UJ Rev04

Multiprogramming Limit

The multiprogramming limit (MAXLOAD) determines the maximum number of jobs inexecution or suspended within a given class.

The default values for these attributes are defined for job classes A to Z when the systemis configured. The system is delivered with the preset Job Classes, Scheduling Prioritiesand Execution Priorities shown in Table 1-1. For the two-character job classes, the defaultvalues are set when the class is created.

Table 1-1. Job Class Attributes and Default Values (1/2)

JobClass

DefaultScheduling

Priority(PRIORITY)

DefaultExecution

Priority(XPRTY)

DefaultMultiprog.

Limit(MAXLOAD)

RecommendedUsage

Comment

USER JOBSA 7 9 1 batch jobsB 7 9 1 batch jobsC 7 9 1 batch jobsD 1 5 1 batch jobsE 2 4 1 batch jobsF 3 7 1 batch jobsG 4 9 1 batch jobsH 6 0 1 communicationI 7 9 4 batch jobsJ 6 0 1 TDSK 7 9 1 batch jobsL 7 9 1 batch jobsM 7 9 1 batch jobsN 7 9 1 batch jobsO 7 9 1 batch jobsP 7 9 40 batch (default)

Introduction

47 A2 11UJ Rev04 1-15

Table 1-1. Job Class Attributes and Default Values (2/2)

JobClass

DefaultScheduling

Priority(PRIORITY)

DefaultExecution

Priority(XPRTY)

DefaultMultiprog.

Limit(MAXLOAD)

RecommendedUsage

Comment

SERVICE JOBSQ 0 1 100 IOF jobsR 0 1 6 Readers (1)RA OLTD (Job TD-MVH) defined by

OLTDRB Mirror (Job REFFIL) defined by

mirrorS 0 0 12 Telecom (QMON, FECM,

FEPS, TNS, RAEH, ,OCS)IOSERARS

(1)

T 7 2 6 Telecom Services(Job SERVER2)

U 0 1 6 RBFV 7 9 1 System Trace

(Job TRCCL)W 0 1 8 Output Writer

(Job WRITER)(1), (2)

X 0 2 4 JCL Translator(Job JTRA)Tds-HA Services(Jobs CMSR, RECOV,JRU)

(1), (2)

Y 7 2 6 Telecom (Jobs VCAM,GTP)Segment Server for TDS(Job JPPC)

(1), (2)

Z 0 0 4 Main Operator (Job IOF)Local Message Handler(Job LAEH)

(1)

(1) Class always started

(2) Use IDLE state


1-16 47 A2 11UJ Rev04

1.7 JOB EXECUTION

1.7.1 Job Selection

Whenever the system load is less than the system multiprogramming limit and thescheduler queue contains at least one job whose class load is less than themultiprogramming limit of its class, a job will be selected for execution from the schedulerqueue. The selection is based on the job classes of those jobs already executing, with thejob classes of the members of the queue.

1.7.2 Command Interpreter

When the Scheduler selects a job from the queue, it notifies the Command Interpreter,which then accesses the job's translated JCL from the backing store. For each JCLstatement, the function of the Command Interpreter initiates the appropriate operatingsystem action that is requested by that statement.

Before a step can execute, its requests in the JCL for resources (user buffer space, files,volumes, devices) must be analyzed and fulfilled, or the step must queue for resources.

1.7.3 Step Execution

Each time a STEP statement is encountered, the Command Interpreter calls the"Initiation" routine. The step initiation routine reads all of the statements of the stepenclosure and allocates system resources to the step.

If the resource cannot be allocated, the step must wait until the resource is available.When all necessary resources have been allocated to the step, the appropriate loadmodule is loaded from the load module library and step execution begins when ENDSTEPis encountered.

Introduction

47 A2 11UJ Rev04 1-17

1.7.4 Step Termination

At step termination, allocated resources are released and the Command Interpreterresumes control. If the job contains another step, the cycle of resource allocation, stepexecution and resource release is repeated. When the end of the translated JCL isreached, job execution is terminated.

Figure 1-5 illustrates the processing of a one-step job. Certain errors or abnormalconditions during step initiation or execution may cause the step to be aborted. The JUMPstatement can be used to anticipate the error situation at the termination of a step andprevent the abnormal termination of an entire job. The LET statement (SEV parameter)can set status values to simulate a normal or abnormal step termination.

1.7.5 Job Termination

When the Command Interpreter encounters the end of the job, certain job terminationprocedures are started, to delete temporary files and SYSIN subfiles, to produce finalaccounting information, and to inform the operator. At this point, the output for the job isavailable to be handled by the Output Writer.


1-18 47 A2 11UJ Rev04

JO BO U TP U T

$JOB

$ E N D J O B

JO BIN IT IA T IO N

R E S O U R C EA LLO C A TIO N

P R O G R A MLO A D IN G

S T E PE X E C U T IO N

R E S O U R C ER E LE A S E

S T E PA S S IG NA LLO C A TE

S tepIn itiationE N D S T E P Load

M oduleLibrary

S YS INInput

(E nc losures)

S YS O U T(Job O utput)

JO BO ccurence

R eport

S tepTerm ination

JO BT erm ination

O utputW riter

Figure 1-5. Step Execution for a Single-Step Job

Introduction

47 A2 11UJ Rev04 1-19

1.8 SERVICE JOBS

A service job is a job that the system runs in order to execute certain system functions.

Service jobs are not always running, because they provide temporary functions orbecause they need to be active for only certain types of work.

The following are service jobs:

• Interactive Operation facility (IOF)• Input Stream Reader (Reader)• Disk Move Head T & D (TD_MVH)• Automatic refilling of mirrored disks (REFILL)• Queue Monitor (QMON)• Front End Processing Support (FEPS)• Front End Control and Management System (FECM)• Transport and Network Subsystem (TNS)• Networking - Remote Administrative Exchange Handler (RAEH)• Automatic Restore and Save (ARS)• Open Communication Subsystem (OCS)• Input/Output Server for either Large Memory Cache or Mirror Disks or both (IOSER)• DJP File Transfer Server (SERVER2)• Remote Batch Facility (RBF)• System Trace (TRCCL)• Output Writer (WRITER)• JCL Translator (JTRA)• HA Complex Management Server (CMSR)• HA Takeover File Recovery (RECOV)• HA Journal Recovery Utility (JRU)• Virtual Communications Access Method (VCAM)• Generalized Transfer Processor (GTP)• TDS Segment Management (JPPC)• Local Administrative Exchange Handler (LAEH)

NOTES: 1. Service jobs are distinct from those components of the systemknown as system processors (for example, compilers, datamanagement and library utilities) in the sense that systemprocessors are called from within user jobs (by Extended JCLstatements). Exceptions to this are the RUN and EXECUTEstatements, which can call service jobs from within user jobs.

2. All service jobs are assigned a ron (run ocurrence number) whenintroduced to the system. The job class is exclusive to thatparticular service job (See Table 1-1, earlier in this chapter).

3. There can be only one JTRA job executing at any one time.

4. There is one READER job for each device on which Input Readerhas been started.

5. Service jobs do not display log messages concerning run states,except for error messages.


1-20 47 A2 11UJ Rev04

6. Service jobs pass through the same states as user jobs, but withcertain differences.

Some service jobs use a specific state called IDLE. They enter theIDLE state when they run out of work. However, as soon as work isavailable (for example, transfers to be made, jobs to be translated,or output to be printed), they automatically enter the INSCHEDULING state. The IDLE state economizes the use ofsystem resources and removes the need for operator intervention.

1.9 FACILITIES AVAILABLE THROUGH JCL

The following paragraphs outline the features of the operating system that you can accesswith Basic JCL Statements. For more information on a feature, refer to the specifiedstatement or to the appropriate user's manual.

1.9.1 Spooling of a Unit Record Device

Spooling is a system feature that makes it appear to the user that a program is using aunit record device directly while in fact it is using intermediate storage on system disk filesto eliminate user device assignment problems. In a general sense the device is equivalentto a sequential disk file with certain processing restrictions (for example, a printer cannotbe "read"). Full details of the use of unit record devices are given in the Unit RecordDevices User's Guide.

Introduction

47 A2 11UJ Rev04 1-21

1.10 HANDLING INPUT

1.10.1 The SYSIN Mechanism

The SYSIN mechanism allows programs that read data from a unit record input device toexecute concurrently without having to deal with device assignment problems. The SYSINmechanism provides buffering of input files on mass storage devices, thereby speedingup job execution time. While some jobs are executing, input for another job can be readconcurrently.

1.10.2 Use of SYSIN

The SYSIN mechanism uses the SYSIN system file (SYS.IN) that is created at systemgeneration and is stored on a resident disk device. For each input enclosure, one subfileis assigned. The Stream Reader removes each input enclosure from the job descriptionand stores it in the assigned subfile. The format given to the input data is determined bythe TYPE parameter specified in the $INPUT statement.

The data is transferred to a subfile of the SYSIN file. To access the SYSIN subfile, yourequest the SYSIN mechanism and the assignment of the subfile with the followingASSIGN statement:

ASSIGN internal-file-name, *input-enclosure-name;

Each member of the SYSIN file is a temporary subfile. When the job terminates, thesystem deletes all the SYSIN subfiles assigned to the job.


1-22 47 A2 11UJ Rev04

1.11 HANDLING OUTPUT

1.11.1 Output Writer

The Output Writer mechanism allows programs that send data to a unit record outputdevice (printer or cassette) to execute concurrently without being concerned with deviceassignment problems. The Output Writer mechanism provides buffering of printer andoutput files on secondary storage devices, thereby speeding up the execution of the job.While some jobs are executing, the output from jobs that have finished executing can beprinted concurrently. A file to be printed by the Output Writer is known as a SYSOUT file.There are two types of SYSOUT file: standard SYSOUT and permanent SYSOUT.

1.11.2 Standard SYSOUT

The standard SYSOUT file (named SYS.OUT) is a system file that is set up during systemgeneration and is stored on the resident disk device. In a given step, the system assigns asubfile of the standard SYSOUT file for each output file produced in the program that isdestined for standard SYSOUT. Standard SYSOUT subfiles are automatically printed bythe system (by default after the end of the job). When the processing of output is finished,the subfiles are deleted.

A standard SYSOUT subfile is created when the following two conditions apply:

• You have activated the SYSOUT mechanism (see below) in the program or in the JCL.

• There is no assignment (ASSIGN) in the JCL for the given file. The Job OccurrenceReport (JOR) is stored in the backing store and retrieved by the Output Writer as if itwere a SYSOUT subfile.

1.11.3 Permanent SYSOUT Files

A permanent SYSOUT file is used when you require a SYSOUT file that is not to bedeleted after Output Writer activity, or whose contents will not be output until after thecurrent step, or that requires a SYSOUT file on magnetic tape (useful for large volumes ofoutput). If you wish to print a permanent SYSOUT file after the step associated with thefile's creation, a WRITER statement must appear in the appropriate job description.

Introduction

47 A2 11UJ Rev04 1-23

1.11.4 The SYSOUT Mechanism and SYSOUT Format

The SYSOUT mechanism is a method of writing data to a SYSOUT file. You can activatethe SYSOUT mechanism by declaring -SYSOUT in the SELECT .... ASSIGN clause of aCOBOL program (INPUT-OUTPUT SECTION) or by using the JCL statement SYSOUT.The resulting SYSOUT file is said to be in SYSOUT format. This format incorporates intothe file all the output editing functions (for example, margin setting, print densityspecification, form length) that apply by default (specified at system generation time) orthat you have specified (for example, in the DEFINE statement). This format leads to theconcept of an "edited" file. The use of the SYSOUT mechanism to produce editedSYSOUT files at job execution time results in a saving of Output Writer activity later whenthe file is sent to the output device.

If no file assignment appears for a file that is to be written in SYSOUT format, the systemautomatically assigns a standard SYSOUT subfile. To create a permanent SYSOUT file,you must assign the file (ASSIGN statement) for the step in which the file is written.

The SYSOUT mechanism is always used for writing to the standard SYSOUT file.Whether or not the SYSOUT mechanism is used to create a permanent SYSOUT filedepends on the declared record size and record format of the file (see the SYSOUTstatement description in Section 3, and the JCL User's Guide for more details).


1-24 47 A2 11UJ Rev04

1.12 STORED JCL

One or more job descriptions can be stored as a job stream in a source library. The storedjob stream can be maintained in the same way as any source library member, using theLIBMAINT SL facilities (see the Library Maintenance Manual). A stored job stream can beintroduced to the system by means of the RUN statement or the operator command, EJR.With the $SWINPUT statement, you can introduce stored JCL and/or data records into ajob description. This takes place at Stream Reader time.

With the INVOKE statement, you can introduce a stored sequence of step enclosuresand/or Extended JCL statements into a job description at JCL translation time. The storedsequence of statements, known as an invoked sequence, replaces the INVOKEstatement in the job description.

The EXECUTE statement allows you, during job execution, to translate and then executea stored sequence of step enclosures and/or Extended JCL statements.

For further details, refer to the JCL User's Guide.

1.12.1 Mini-Editor

The Mini-Editor is an updating facility that allows you to modify a sequence of stored JCLstatements, or a sequence of JCL statements in an input enclosure, at JCL translationtime. A set of special editing commands is provided. The commands required for aparticular update must be stored in an input enclosure. The UPDATE parameter of theINVOKE statement gives the name of the input enclosure containing the editingcommands, and activates the Mini-Editor to update the contents of the invoked sequence.Refer to the JCL User's Guide for more information about using the Mini-Editor.

1.12.2 JCL Parameter Substitution

The same job description (or stored sequence of JCL statements) may have to be usedseveral times with the modification of a few parameters, such as file names or volumenames. One way of doing this is to modify every statement in which the parameters to bechanged appear. However in large jobs this would require the modification of manystatements. To simplify matters, GCOS provides JCL parameter substitution.

The principle of JCL parameter substitution allows you to substitute a value reference thatappears in a JCL statement at translation time by a value that you specified elsewhere inthe current job. The statements that can supply such values are VALUES, MODVL, RUN,INVOKE and EXECUTE (and the EJR operator command).

Introduction

47 A2 11UJ Rev04 1-25

1.13 FILE SHARING AND PASSING

In some cases it is useful to access the same physical file (identified by external-file-name) concurrently in one step by means of several logical files (identified by internal-file-name). The same situation can occur when several jobs are running simultaneously.Unless a control of file sharing exists to ensure file security, this situation could result in afile modification that is incompatible with the requirements of another job. The ASSIGNstatement allows the SHARE and ACCESS parameters to control the sharing of files.

The concept of file sharing is explained further in the JCL User's Guide.

The contents of a temporary file can be preserved from one step to another by means ofthe END=PASS parameter (or, when a step terminates abnormally, the ABEND=PASSparameter) of the ASSIGN statement. This means that more than one step within a jobcan access the same temporary file. The mechanism is known as file passing.

For a permanent file, file passing means that access to the file can be reserved from onestep to another. While a file is being passed, no other job can assign it.

The concept of file passing is illustrated in the JCL User's Guide.

1.14 USE OF OPERATOR COMMANDS

You can include operator commands in a job description, subject to any restrictionsimposed on your project. The special JCL statement EXDIR is used for this purpose.

1.15 CHECKPOINT/RESTART MECHANISM

For various reasons, such as a system crash, power failure, device fault or program abortdue to an operator error or an I/O error, the processing of a user program may abnormallyterminate. The checkpoint and restart mechanisms provide a means of recovery from anabnormal program termination. The checkpoint mechanism is activated by the REPEATparameter of the STEP statement, or of the $JOB statement, with calls to the checkpointmechanism from your program. For further details, refer to the JCL User's Guide, theSystem Administrator's Manual, and the GAC-Extended User's Guide.


1-26 47 A2 11UJ Rev04

1.16 JOURNALIZATION

The checkpoint/restart mechanisms are complemented by journal files.

The BEFORE journal is used in the restart process to return (that is, to roll back) files thatwere being updated before the abnormal termination to their exact contents at the timethe checkpoint process was executed. The journal is required when the repositioning ofthe file is not sufficient to return the file to the state before abnormal termination.

The AFTER journal is used to return (that is, to roll forward) files that were being updatedat the abnormal termination to their state at the time the incident occurred.

You can use the BEFORE, AFTER, BOTH or NONE parameters to specify which journalsare to be recorded. The information on the type of journal to be used with a file can bestored in the catalog. Alternatively, you can supply this information via the DEFINEstatement.

The DEFINE statement is associated with the relevant file by means of the internal-file-name. The corresponding step may or may not use the checkpoint/restart mechanisms.

47 A2 11UJ Rev04 2-1

2. Rules for Writing JCL Statements

A JCL statement can consist of the following elements:

• a label;

• a statement name;

• one or more parameters.

Each statement has the following format:

[label:] ... [$]statement-name [positional-parameter]

[positional-parameter] ... [keyword-parameter] ...

[self-identifying-parameter] ...;

2.1 GENERAL RULES

1. The dollar sign ($) is mandatory only for the statements that are handled by theStream Reader (i.e., $JOB, $ENDJOB, $INPUT, $ENDINPUT, $SWINPUT, $DATAand $ENDDATA), and for any JCL statement that indicates the end of an inputenclosure for which END=DOLLAR has been specified (see $INPUT).

NOTES: 1. The dollar sign can be omitted from the first $JOB statement thatappears in a stored job stream (handled by the RUN statement orthe EJR operator command). However, the recommended practiceis never to omit the dollar sign from $JOB.

2. Throughout this manual, and in GCOS 7 documentation in general,the $ is normally omitted wherever a JCL statement name (exceptfor $JOB, $ENDJOB, $INPUT,$ENDINPUT, $SWINPUT, $DATAand $ENDDATA) appears.

2. If a $ is specified, the statement name must immediately follow it.

3. The semicolon (;) is a mandatory terminator for all JCL statements.


2-2 47 A2 11UJ Rev04

4. Most statements contain parameters between the statement name and theterminator. There must be at least one space between the statement name and thefirst parameter. Each parameter must be separated from the following parameter, ifany, either by a comma or by one or more blanks. If a comma is used as aseparator, one or more blanks may appear on either side of the comma.

NOTE: In this manual, blanks are used as separators in statement formats. However, inexamples where two or more parameters appear on the same line, commasmay be used as separators to improve legibility.

5. Except for the Stream Reader statements $JOB, $ENDJOB, $INPUT, $ENDINPUT,$SWINPUT, $DATA and $ENDDATA, any two or more JCL statements can share arecord. A Stream Reader statement may be spanned over more than one record;however, it may not share a record with another Stream Reader statement, a JCLstatement or an input enclosure record.

6. The statements for which the dollar sign is mandatory must not be labelled (although$ENDJOB can have a label on the previous record).

7. When the dollar sign is mandatory, it must appear as the first character of a record.

8. A statement for which the dollar sign is not mandatory (even if the dollar appears)may start anywhere in a record and may end anywhere in the same or subsequentrecord.

NOTE: It is often useful to indent certain JCL statements in order to improve thelegibility of a job description.

9. Any parameter, keyword or value in a JCL statement may start on a new record. Thesystem recognizes the end of a statement by the semicolon; an end-of-record in ajob description is not considered as a separator.

10. Where a statement is continued from one record to the next one, a keyword name ora parameter value can be split across the record boundary. However, in this case:

- the last character of the first part of the name or value must appear in the lastcharacter position of the record;

NOTE: If the parameter value is a protected string, it can also be split by means of ahyphen character (see the paragraph entitled "Protected Strings" below);

- the first character of the second part of the name or value must appear in thefirst position of the next record.

11. Parameter substitution is not allowed on the statements for which the dollar sign ismandatory (i.e., $JOB, $ENDJOB, $INPUT, $ENDINPUT, $SWINPUT, $DATA and$ENDDATA).

Rules for Writing JCL Statements

47 A2 11UJ Rev04 2-3

2.2 COMPONENTS OF JCL STATEMENTS

The components of a JCL statement are:

• the label

• the statement name

• parameters

These components are described below.

2.2.1 Label

Any statement, except $JOB, $ENDJOB, $INPUT, $ENDINPUT, $SWINPUT, $DATA and$ENDDATA, can have one or more labels. Each label can contain up to eightalphanumeric (A-Z, 0-9), hyphen, and underscore characters, and must be followed by acolon (:). The colon can optionally be preceded or followed by one or more blanks.

NOTE: The label CONTINUE, is reserved for special use only as permitted by the rulesstated in the description of JUMP (see Section 4). An $ENDJOB statement canhave a label, but this label must appear in the preceding record. For example:

FINISH:$ENDJOB;

is valid, but

FINISH: $ENDJOB;

is not valid.

2.2.2 Statement Name

The statement name identifies the action the system takes. A dollar sign is only necessaryin the circumstances described in General Rule 1 above.

You must give the statement name exactly as it appears in the format for the statement(see Section 4). At least one blank character must follow the statement name, exceptwhere no parameters are given and ";" immediately follows the statement name. Whenthe dollar sign is mandatory, it must be in the first position of the record that contains thestatement name. Examples of statement names are:

$JOB identifies a job;STEP names a load module (for step execution);ASSIGN assigns a file to a step.


2-4 47 A2 11UJ Rev04

2.2.3 Parameters

Parameters control how the system interprets a particular command. Some statements,such as ENDSTEP, have no parameters. This is an exception rather than the rule.

2.2.3.1 Parameter Types

There are three types of parameter:

• positional parameters;

• keyword parameters;

• self-identifying parameters.

Positional parameters, where used, must be the first parameters that follow the blank(s)after the statement name.

If a comma is used as a separator between two parameters, one or more blanks canfollow and/or precede the comma separator. Certain statements can contain a group ofparameters enclosed in parentheses, in place of a single parameter. Within a group,parameters must be separated by commas or blanks and positional parameters must bethe first parameters that follow the opening parenthesis.

Positional Parameters

The JCL Translator recognizes a positional parameter by its position in the statement.Positional parameters appear immediately after the blank(s) that follow the statementname (or after the opening parenthesis of a parameter group). For example, the followingstatement has two parameters:

ASSIGN INFILE, PAYROLL.MAST;

The first value, INFILE, is an internal-file-name, and the second value, PAYROLL.MAST,is an external-file-name. Both these values are positional parameters in the ASSIGNstatement, and each must always be specified in the position shown, since that is how theJCL Translator recognizes it.

If a positional parameter value is omitted from a statement or parameter group, twocommas must separate the previous parameter from the next parameter (one comma ifthe first positional parameter of a statement or group is omitted). Alternatively, if blanksare used as separators, a "#" symbol may be used to signify the missing parameter. Forexample, in the statement:

VALUES , P2,, P4;

is equivalent to:

VALUES # P2 # P4;


47 A2 11UJ Rev04 2-5

In the above examples, P2 is the value of the second positional parameter and P4 is thevalue of the fourth positional parameter; the first and third parameters are missing.

In the statement:

VALUES P2 , P4;

is equivalent to:

VALUES P2 P4;

In the above example, P2 is the value of the first positional parameter and P4 is the valueof the second one.

If all positional parameters that follow a particular positional parameter are omitted, thecorresponding commas or # signs can also be omitted. For example, the statement:

VALUES P1,P2,,P4,,,,;

or

VALUES P1 P2 # P4 # #;

can be written:

VALUES P1, P2,,P4;

or

VALUES P1 P2 # P4;

A positional parameter can be a single parameter value (e.g., external-file-name), aprotected string (see below) or a parameter group.

If only the first positional parameter in a parameter group is required, the parentheses canbe omitted provided that this positional parameter is not also a parameter group. Forexample, the statement:

INVOKE BJC, (BIG.YIN);

can be written:

INVOKE BJC, BIG.YIN;

The keyword and self-identifying parameters (described below) must always appear afterpositional parameters, if they are specified.


2-6 47 A2 11UJ Rev04

Keyword Parameters

A keyword parameter is recognized by its name. Consequently, the position of keywordparameters with respect to other parameters in a statement is unimportant (provided theyalways follow positional parameters); keyword parameters may appear in any order that isconvenient.

A keyword parameter always takes one of the following forms:

• keyword-name = value,

• keyword-name = 'protected-string',

• keyword-name = (parameter-group),

The keyword must appear exactly as given in the appropriate statement format (seeSection 4).

One or more blanks can precede or follow the equal sign (). As with positionalparameters, a keyword parameter value may be a single parameter value, a protectedstring or a parameter group. Where only the first positional parameter of a group isrequired, the parentheses can be omitted provided that this positional parameter is notalso a parameter group.

Examples:

ASSIGN MFIL1, PAYROLL.MAST, DEVCLASS = MS/M500, MEDIA = VOLA1;$INPUT MYFILE, TYPE = COBOL, END = ENDINPUT;

In the above statements, the following are positional parameter values:

MFIL1, PAYROLL.MAST, MYFILE

The keyword parameter names are:

DEVCLASS, MEDIA, TYPE, END

The keyword parameter values are:

MS/M500, VOLA1, COBOL, ENDINPUT

Self-Identifying Parameters

A self-identifying parameter is recognized by its name. Its position in a statement isunimportant as long as positional parameters, if any, appear first. Unlike a keywordparameter, a self-identifying parameter has no associated value. The name itself indicatesto the system the required action. Each self-identifying parameter must be specifiedexactly as shown in the corresponding statement format in Section 4.


47 A2 11UJ Rev04 2-7

Example:

$JOB JB2A, USER = XACC, HOLD;

In the statement above, JB2A is a positional parameter value, USER is a keywordparameter whose value is XACC, and HOLD is a self-identifying parameter.

NOTE: In general, the system does not recognize a self-identifying parameter as such,if it appears in place of a positional parameter. Instead, its name is taken as thevalue of the positional parameter. However, you can avoid this confusingsituation, either by placing a keyword parameter before the first self-identifyingparameter, or by entering as many commas or # signs as there are missingpositional parameters.

For example, the following statements are not equivalent:

ASSIGN IFN1, TEMPRY, RESIDENT;

ASSIGN IFN1, RESIDENT, TEMPRY;

Neither are the following two statements equivalent:

ASSIGN FIL1, DEFER, DEVCLASS = MT/T9, MEDIA = VOLA;

ASSIGN , FIL1, DEFER, DEVCLASS = MT/T9, MEDIA = VOLA;

Note that the above statement could be written:

ASSIGN # FIL1, DEFER, DEVCLASS = MT/T9, MEDIA = VOLA;

2.2.3.2 Default Values

In most cases it is possible to omit one or more parameters from a given JCL statement.Most positional parameters are mandatory, whereas a keyword or self-identifyingparameter can often be omitted. Where appropriate, the system automatically assigns adefault value for each missing parameter. For example, in the $INPUT statement, thekeyword parameters TYPE and END have the default values DATA and ENDINPUTrespectively. Therefore, the following two statements are equivalent:

$INPUT MYFILE;

$INPUT MYFILE, TYPE = DATA, END = ENDINPUT;


2-8 47 A2 11UJ Rev04

2.2.3.3 Protected Strings

A protected string is a string of characters enclosed in single quotes.

The contents of the string are "protected" in the sense that they are not analyzed by theStream Reader nor by the JCL Translator. Therefore a protected string may contain anycharacter, including the blank character, of the current character set. The quotes are notconsidered to be part of the protected string.

Examples:

'A+B'

'A B'

'SMITH;'

If a single quote is required within a protected string, it must appear twice in succession.

Example:

The string

ABC'123+;

must be specified as:

'ABC''123+;'

A protected string can be split across record boundaries (if, for example, it is too long to fiton the current record). The split can occur anywhere within a record (that is, notnecessarily at the last character position), but the last character of the first part of thestring must be followed by a single hyphen (-), and the remainder of the record after thehyphen must consist entirely of blank characters. The first character of the second part ofthe string must start in the first character position of the subsequent record.

Example:

REPORT 'THIS IS AN-EXAMPLE OF A LONG PROTECTED STRING';

47 A2 11UJ Rev04 3-1

3. File Identification andStandard Parameter Groups

This section is divided into two parts. The first part, File Identification, discusses the rulesfor naming files and, where appropriate, the volumes and devices on which files arestored. The rules apply to all files specified in JCL statements, but particular reference ismade here to the Basic JCL Statement ASSIGN. ASSIGN associates the name of a file ina program with the name that the system uses to refer to the file. The second part,Standard Parameter Groups, gives the formats for parameter groups that occur in severalextended JCL statements.

3.1 FILE IDENTIFICATION

To uniquely identify a particular file, the system must have the following information:

• the file name;

• the file status;

• the volume name;

• the device identification.

3.1.1 Types of Files

The system supports both permanent and temporary user files. It also supports libraryfiles, which may be temporary or permanent, and SYSIN files.

The amount of information that you need to specify, so that the system can find aparticular file, depends on whether the file is temporary or permanent, and if permanent,whether it is cataloged or uncataloged.


3-2 47 A2 11UJ Rev04

3.1.1.1 Cataloged, Uncataloged and Temporary Files

Temporary files and uncataloged permanent files are uniquely identified by a combinationof the file name, file status, volume identification and device identification. If any one ofthese components is different from an otherwise identical file identification, then the twofiles are considered to be different. Therefore, to correctly identify a file, you must specifyall the information to the system.

Examples:

ASSIGN MYFILE, PAYFILE.TRANS, DEVCLASS=MS/M500, MEDIA=B069;ASSIGN MYFILE, PAYFILE.TRANS, DEVCLASS=MS/M500, MEDIA=B068;ASSIGN MYFILE, PAYFILE.TRANS, DEVCLASS=MS/M350, MEDIA=B069;

The above statements all refer to different files, because one part of the file identificationis different in each case.

However, for cataloged files (which are always permanent), the volume name and deviceidentification (known as "residency parameters") are permanently stored in a special fileknown as a CATALOG. Therefore, you only need to specify the name of a cataloged file.

The CATALOG also gives the user of a file more control over the means of accessing andupdating the file contents. Refer to the Catalog Management Manual for a detaileddescription of catalogs and their use.

When the file is to be allocated as a temporary or cataloged file, the volset syntax may beused instead of supplying the volume name and the device identification. (See Chapter 3of the JCL User Guide for more information.) However, the volset syntax can also be usedfor a temporary input file.

3.1.1.2 Library Files

A library is a file that has several members, also known as subfiles. Each member isidentified by its member name. Libraries can be permanent (cataloged or uncataloged) ortemporary.

3.1.1.3 SYSIN Files

The system uses a file called SYS.IN for the temporary storage of the input enclosures ofuser jobs. Each input enclosure, stored as a temporary "subfile" of SYS.IN, is identified byan input-enclosure-name.

File Identification and Standard Parameter Groups

47 A2 11UJ Rev04 3-3

3.1.2 File Names

A file name as discussed in this section is the name by which a file is known to the system(that is, as recorded in file labels). It is known as the "external-file-name".

NOTE: Within a COBOL program, the SELECT . . . ASSIGN clause defines the"internal-file-name". This name, a maximum of eight characters in length, isassociated with the external-file-name by means of the ASSIGN statement andis described under ASSIGN.

The rules for naming the following types of file are discussed below:

• Permanent files;

• Temporary files;

• Library files;

• Subfile (member)s;

• Input enclosures;

• Non-standard files.

3.1.2.1 Permanent File Names

The following paragraphs apply in particular to cataloged files, although an uncatalogedfile also can be named according to the following rules.

The Catalog Management Manual gives a more detailed description of the rules fornaming cataloged files.

General Rules

A permanent-file-name is a combination of component names and separators. Apermanent-file-name for a cataloged file must have the following structure:

compound-name.simple-name

where compound-name has the form:

master-directory-name [.directory-name] . . .


3-4 47 A2 11UJ Rev04

GCOS will accept at most 16 alphanumeric, hyphen and underscore characters for acomponent name (where a component name may be a simple-name, directory-name ormaster-directory-name). For compatibility with other DPS and Series 60 systems, acomponent name should have at the most 12 characters, and the underscore charactershould not be used.

The maximum total length of a permanent-file-name is 33 characters, including allseparator characters (period) (). If a file has a generation number, which has a maximumlength of 11 characters, the effective maximum length is 44 characters.

The name of a file indicates a hierarchy of directories and files. The master directory is atthe top of the hierarchy, which is organized in a tree structure. Each entry at each level ofthe tree below the master directory is either a directory or a file. Each level of a particularbranch of the tree is identified by successive component names in the file name.

For example, if a payroll master file is being processed for the transactions of Section 1 ofDepartment 61 in Plant A, its permanent-file-name could bePLANTA.DEPT61.SECT1.PAYMAST and the tree structure could be of the form shown inFigure 3-1. Here PAYMAST is the simple-name for the lowest entry (that is, the file itself),and SECT1, DEPT61 and PLANTA indicate higher levels of identification of the file.

PLANTA

P A Y M A S T P A Y M A S T

DEPT62 DEPT63DEPT61

SECT1 SECT2 SECT3

SALES

Figure 3-1. Part of a Catalog Tree Structure


47 A2 11UJ Rev04 3-5

A component name must be unique within the immediately higher level component namethat points to it. Therefore, two identical names at the same level below a particularcomponent name are not acceptable. However, if the two identical names were below twodifferent component names or at different levels, the names would be accepted. Anexample of these rules is given in Figure 3-2.

A

C

C

I

TH IS IS ILLE G A L(tw o identica l nam esim m ediately be low adirec tory-nam e or a m aster-direc tory-nam e)

TH IS IS A C C E P T A B LE(tw o identica l nam es a tdiffe rent leve ls )

TH IS IS A C C E P T A B LE(tw o identica l nam esim m ediately be low diffe rentdirec tory-nam es)

B

C D

A

B E

C D E

B

A X

B B

Figure 3-2. Valid and Invalid Construction of tree


3-6 47 A2 11UJ Rev04

The DPS 7000 compatible rules for naming a cataloged permanent file are summarizedbelow:

• The maximum number of characters for a component name is 12.

• A component name must start with a letter (A-Z) and the remaining characters can beany of the following: alphabetic (A-Z), numeric (0-9), hyphen (-).

• The period character (.) is used as a separator between the component names of apermanent file name.

• The maximum number of characters allowed for a permanent file name is 33 (includingperiods), plus 11 for the generation number (if present).

Tape Files

The maximum length of the name for a permanent ANSI tape file is 17 characters (plus11 characters for the generation number if the file is cataloged and has a generationnumber). The other rules for permanent-file-names apply as described above.

Automatic Prefixing

Generally, the master-directory-name is the project-name specified by the users of a filefor jobs that access the file. By means of a mechanism called automatic prefixing, you canomit the project identification from an external-file-name of a cataloged file in JCLstatements. The system automatically adds the project name for the current job (or thename specified in a previous PREFIX statement) to the beginning of all external-file-names that start with a period character.

For example, if a job runs under the project name AREA3, the ASSIGN statement

ASSIGN INFILE, .INTL.STOCK;

assigns the cataloged file AREA3.INTL.STOCK to internal-file-name INFILE.

Note that a combination of several component names may be defined as a prefix bymeans of the PREFIX statement.

Notes on Uncataloged File Names

An uncataloged file exists independently of any catalog or hierarchical structure; it has aunique identification in terms of its name and its residency (volume name and deviceidentification). Therefore it is not important if the name of an uncataloged file does notreflect the tree structure described above for cataloged files. However, it is oftenconvenient to name an uncataloged file as if it were part of a hierarchical structure,because, for example, it may be incorporated into the site catalog or a user catalog later.


47 A2 11UJ Rev04 3-7

Examples:

XTRAFILE1A

MY.FILE

HQ.ARCH.MY-FILE

Note that the second and third names above are also legal cataloged file names.

Uncataloged files cannot have generation numbers. This means that the length of anuncataloged file name can be up to 44 characters (alphabetic, numeric, hyphen, periodcharacters). However, the recommended practice is to use a maximum of 33 characters,corresponding to the maximum length of a cataloged file name without a generationnumber.

Multifile Tapes

A standard tape volume that contains more than one file is a multifile tape. The FSNparameter of the ASSIGN statement can be used to give the rank (or relative position) ofthe file on the tape volume (for example, FSN=3, for the 3rd. file). A multifile tape volumecannot contain a cataloged file. Consequently, a cataloged tape file must reside on amono-file tape volume. Non-standard multifile tapes are supported with LABEL=NONEand only in INPUT with LABEL=NSTD.

3.1.2.2 Temporary File Names

A temporary file is one that exists for the duration of a step or, at most, a job. At step(or job) termination, the file is automatically deleted by the system.

NOTE: The name of a temporary file must follow the rules of a simple-name(16 characters maximum), except that the maximum file name length of atemporary ANSI tape file is 9 characters.

3.1.2.3 Library File Names and Member Names

The naming rules for library files are identical with those for non-library files, as describedabove.

The name of a member can contain up to 31 characters (A-Z, 0-9, the underscore andhyphen) and must start with a letter or a digit.

3.1.2.4 Input Enclosure Names

The maximum length of an input-enclosure-name is 16 characters. The name must startwith a letter or a digit, and can contain letters, digits, hyphen and underscore characters.


3-8 47 A2 11UJ Rev04

3.1.2.5 Non-standard File Names

File names that do not conform to the above DPS7000 rules are considered as non-standard. Non-standard file names must be enclosed in single quotes (') (for example,'A+B').

3.1.2.6 Summary of Limits for Name Lengths

Table 3-1 contains a list of various types of file names (and file name components) withthe respective maximum permissible lengths, in terms of characters; the recommendedmaximum length for each name, for reasons of compatibility, is also given. Note that themaximum length for permanent-file-names includes all period separators.

Table 3-1. File Naming - Maximum Lengths

Category Maximum LengthRecommended

Maximum Length

permanent-file-name(cataloged file)

33 (+11 for generationnumber)

33 (+11 for genererationnumber)

simple-name 16 12

permanent-file-name(uncataloged file) 44 33

temporary-file-name 16 16

permanent-file-name(ANSI tape file)



temporary-file-name(ANSI tape file) 9 9

member-name(library subfile) 31 31

input-enclosure-name 16 16


47 A2 11UJ Rev04 3-9

3.1.3 File Status

The file status is the term that describes whether a file is cataloged, uncataloged ortemporary; you can indicate the file status in the ASSIGN statement as follows:

FILESTAT=CAT for a cataloged file

FILESTAT=UNCAT for an uncataloged file

FILESTAT=TEMPRY for a temporary file

In general, the FILESTAT keyword parameter need not be specified in ASSIGN, since:

• FILESTAT=UNCAT applies by default if residency parameters (DEVCLASS (orDVIDLIST) and MEDIA, or RESIDENT) are specified;

• FILESTAT=CAT applies by default if residency parameters do not appear in theASSIGN statement, and an entry for the file exists in an attached catalog;

• the self-identifying parameter TEMPRY can always appear in place of the keywordparameter FILESTAT=TEMPRY in ASSIGN.

However, to avoid ambiguity for a file that has been passed from a previous step (sinceresidency parameters are not required here even for an uncataloged or temporary file), itis recommended that the file status should appear in the ASSIGN statement for a filepassed from a previous step.

3.1.4 Volume Identification

The following paragraphs apply to uncataloged permanent files and to temporary files.Volume identification is not used on JCL statements for cataloged files except in certainsituations involving catalog management (see the Catalog Management Manual).

A distinction is made between a volume that is permanently on-line to the system(resident) and one that is loaded on a device only when it is needed (non-resident).

3.1.4.1 Resident Volume

A resident volume is always a disk, and is identified by the RESIDENT parameter. Nodevice identification is necessary.

Examples:

ASSIGN PAY, PAY.MASTER, RESIDENT;

The uncataloged permanent file PAY.MASTER resides on a resident disk volume. Notethat FILESTAT=UNCAT applies by default where RESIDENT appears.


3-10 47 A2 11UJ Rev04

3.1.4.2 Non-resident Volume

For a non-resident disk volume, cartridge volume or a tape volume, the volume name(which is recorded in the volume label) must be specified using the MEDIA parameter.

Example:

MEDIA=B016

The volume name can contain alphanumeric, hyphen and underscore characters and hasa maximum of six characters. Note that the keyword WORK may be specified to indicatethat work tapes or cartridges are to be used.

Example:

MEDIA=WORK

Work tapes or cartridges are prepared using the VOLPREP or TAPEPREP utility (seeSection 5).

In certain cases, the identification of a volume may include the LABEL parameter toidentify the type of volume label. It can be written, for example, as follows:

LABEL=NATIVE

for a volume with standard GCOS 7 label organization (default value).

LABEL=NONE

for a non-labelled volume.

(See ASSIGN for other values for LABEL.)

Note that the MEDIA and LABEL parameters may only be specified with a deviceidentification parameter (DEVCLASS or DVIDLIST, described below).

The LABEL parameter of the ASSIGN statement is further described in Section 4.

3.1.4.3 Non-standard Volume Names

Volume names that do not conform to the DPS 7000 rules above are considered non-standard. Non-standard volume names must be protected, that is, enclosed in singlequotes ('); (for example, 'A+B').

Non-standard volume names containing non-printing characters (for example, binaryzeros) cannot be referenced. To use such a device, you must assign it with:

MEDIA=*,DVIDLIST=(device_name)

For example, to mount a tape with a non-standard name on drive MT02, the followingstatement is used:

ASSIGN MYIFN, * , MEDIA=*, DVIDLIST=(MT02);

For further details of the ASSIGN parameters, refer to Section 4.


47 A2 11UJ Rev04 3-11

3.1.5 Device Identification

The following paragraphs apply to uncataloged permanent files and to temporary files.Device identification is not used in JCL statements for cataloged files except in certainsituations involving catalog management (see the Catalog Management Manual).

A device is identified by one of the following:

• Device class and attributes (DEVCLASS parameter);

• Device name (DVIDLIST) parameter.

3.1.5.1 Device Class and Attributes

A device class designates a device, such as a disk drive or tape or cartridge drive. It maybe qualified by device attributes that further specify a particular type of device within aclass, or request some specific technical option or setup.

The general form for coding the device class and its attributes is:

XX[/ attribute] . . .

where XX are two alphabetic characters that identify the type of device, as follows:

CT cartridge tape device

MS disk device (mass storage)

MT magnetic tape device

PR printer

TN terminal

When XX is used alone, it refers to any device within that class, despite its attributes.


3-12 47 A2 11UJ Rev04

WARNING

The device class MS must be specified with its correspondingattributes. Otherwise, the system will abnormally terminate the step.

For other cases, additional attributes can be omitted if there is noambiguity, and if no specific characteristics are requested.

Note the following for cartridge devices:

For 8mm cartridges - M6 can be omitted if all cartridge devices use8mm cartridges.

For half-inch cartridges - For a device that does not belong to a library,M5 or 36T can be omitted if all cartridge devices use half-inchcartridges, with the dame recording format (18- or 36-track), and ifthere is no library.

For a device that belongs to a library, M5 or 36T can be omitted if alldevices that belong to the library use the same recording format (18-or 36-track).

Nevertheless, it is recommended to use the full device class, as thiswill help to avoid the necessity of modifying jobs or catalogs if newdevices are introduced on the site, or if the job is launched on anothersite.

A list of the valid device classes is given in Paragraph 3.1.5.2.

Examples:

ASSIGN INF3, PAYDATA, TEMPRY, DEVCLASS=MS/D500, MEDIA=1234;

The internal file INF3 is associated with the temporary file PAYDATA, which is stored on a500MB disk volume with volume-name 1234.

ASSIGN INC, MY.TAC, DEVCLASS=MT/T9/D1600, MEDIA=BO16;

This requests file assignment for an uncataloged file MY.TAC stored on a 9-track,1600 b.p.i. tape volume, with volume-name BO16. FILESTAT=UNCAT applies by defaultwhere DEVCLASS and MEDIA appear.


47 A2 11UJ Rev04 3-13

3.1.5.2 Valid Device Classes

Cartridge Tape Devices (not belonging to a cartridge library)

Note that no attributes distinguish a device with a sequential cartridge loader.

For 8mm cartridges:

CT [/M6] [/{S35|S75}]

where:

S35 specifies a recording density of 35 Mb/sq. inchS75 specifies a recording density of 75 Mb/sq. inch.

For half-inch cartridges:

CT [/{M5|36T}] [/C]

where:

M5 specifies that the device uses the 18-track recording format(only standard length tapes are supported). Note that the useof a 36-track formatted cartridge on such a device mustspecify M5. The only possible use is volume preparation of astandard length tape (which always becomes a 18-trackformatted cartridge).

36T specifies that the device uses the 36-track recording format.No attributes distinguish standard length tapes from E-tapes(both are supported). Note that the use of a 18-trackformatted cartridge on such a device must specify 36T.Possible users are reading, volume preparation (the cartridgealways becomes a 36-track formatted cartridge) or completerewriting (always with the 36-track recording format).

C specifies compaction. Note that:

- all devices that use the 36-track recording format havecompaction capability.

- to read a cartridge written in compaction mode, C mustbe specified (except when on the site, all devices of thespecified type support compaction).

- to write on a cartridge in compacted mode, C must bespecified.

- to read a cartridge written in non-compacted mode, Ccan be specified or not (if C is specified, the operation isperformed on a device with the compaction capability; ifC is not specified, the device may or may not have thecompaction capability).

- to write on a cartridge in non-compacted mode, C mustbe omitted (but the operation can be performed on adevice with the compaction capability).


3-14 47 A2 11UJ Rev04

Examples:

CT Cartridge Tape

CT/M6 8mm Cartridge Tape

CT/M6/S35 8mm Cartridge Tape with 35 Mb/sq. inch recording density

CT/M5 Half-inch Cartridge Tape (device using 18-track recordingformat).

CT/36T/C Half-inch Cartridge Tape (device using 36-track recordingformat), with compaction.

Cartridge Library (half-inch cartridges only)

CT/LIB [/ {M5 | 36T}] [/C]

where:

M5, 36T, and C have the same meaning as for half-inch cartridges not belonging to acartridge library.

Examples:

CT/LIB Cartridge Tape belonging to a library

CT/LIB/C Cartridge Tape belonging to a library, with compaction.

CT/LIB/M5/C Cartridge Tape belonging to a library (device using 18-trackrecording format), with compaction.

CT/LIB/36T Cartridge Tape belonging to a library (device using 36-trackrecording format).

Mass Storage Devices

MS/{FSA|B10|D500}

Examples:

MS/FSA Fixed Sector Architecture disk drive.

MS/B10 1 Gigabyte disk drive.

MS/D500 500MB disk drive.


47 A2 11UJ Rev04 3-15

Magnetic Tape Devices

MT[/T9] [/Dnnnn] [/S]

T9 indicates the number of tracks (9).

Dnnnn specifies the density (D1600 or D6250).

S specifies that the tape is to be processed in "streaming"mode. Streaming leads to faster processing if the treatment isperformed without stopping the tape. It is a processing mode,not a characteristic of the tape volume concerned. S ismeaningful only if the concerned command is FILREST,FILSAVE, VOLREST or VOLSAVE. In all other cases,start/stop mode is used.

Examples:

MT/T9 9-track unspecified density Magnetic Tape.

MT/D1600 9-track, 1600 bpi Magnetic Tape.

MT/T9/D6250 9-track, 6250 bpi Magnetic Tape.

MT/T9/D6250/S 9-track, 6250 bpi Magnetic Tape in streaming mode.

MT/S 9-track unspecified density Magnetic Tape in streamingmode.

Printers

PR [/speed] [/Hnnn] [/model]

speed speed attribute (FI, A or SI). See note 2 below.

Hnnn Printer device supporting at least "nnn" print positions (forexample, PR/H125 requests a printer with 132, or 136, or 160hammers, but not one with 120 hammers).

model Printer model (PR54, PR90).

Examples

PR - any printer.

PR/H123 - a printer with at least 123 hammers.


3-16 47 A2 11UJ Rev04

NOTES: 1. If the Hnnn attribute is missing, any available printer is requested(conforming to any other attributes specified - see below);

2. A speed attribute can be specified: SI indicates the slowest printeravailable with the specified hammer requirement, if any; FIindicates the fastest printer available with the specified hammerrequirements, if any; A specifies any speed.

3. A particular device type can be specified (for example, PR54).

Terminals

TN (used in ::TN for file terminal)

3.1.5.3 Device Name

The device-name is the name of one device. Device names are assigned to devices atsystem generation. The general form of a device-name is:

XXYY

where XX is the device type (MT, MS, etc.), and YY is a two-character (alphanumeric)identifier

Device-names must not be specified for resident volumes or mirror disks. Also, no devicereconfiguration is possible if a device-name has been specified.

Example:

CT01

NOTE: The device-name parameter is used to request a particular device. If that deviceis in use by another job (that is, not currently available) the request for thedevice is enqueued until the device becomes available. The use of theDEVCLASS parameter (described above) is therefore recommended asstandard practice.


47 A2 11UJ Rev04 3-17

3.2 STANDARD PARAMETER GROUPS

Certain groups of parameters occur in several extended JCL statements.

Rather than repeat them in each statement format, they are listed in full in this section andgiven a standard parameter group name. This name is used in each subsequentreference to the group both in statement formats and in the text. Other manuals thatdiscuss JCL statements also use these names to refer to the parameter group. Thenotation defined in Table 3-2 is used to describe the value(s) that individual parametersmay take, and it is used throughout this manual.

Table 3-2. Parameter Value Notation Parameter

Notation Description

alphanum string of alphanumeric characters (A...Z, 0...9, hyphen,underscore) The first character cannot be a hyphen or anunderscore.

alphanumN alphanum of maximum length Nalphanum_N alphanum of length Nbit string of binary digits (0, 1)bitN bit of maximum length Nbit_N bit of length Ndigits string of decimal characters (0...9)digitsN digits of maximum length Ndigits_N digits of length Nhexa string of hexadecimal characters (0...9, A...F)hexaN hexa of maximum length Nhexa_N hexa of length Nidentifier string of alphanum, beginning with a letter (A...Z)identifierN identifier of maximum length Nidentifier_N identifier of length Noctal string of octal characters (0...7)octalN octal of maximum lenght Noctal_N octal of length Nstring string of any charactersstringN string of maximum length Nstring_N string of length N

Using the notation defined in Table 3-2, the syntax of names used in JCL statements issummarized in Table 3-3.


3-18 47 A2 11UJ Rev04

Table 3-3. Naming Conventions for JCL Names

Notation Description

billing-name alphanum12catalog-name simple-name [.simple-name]. CATALOGexternal-file-name qualified-name (length < = 44) protected stringinput-enclosure-name alphanum16internal-file-name alphanum8job-name alphanum8label-name alphanum8load-module-name alphanum31master-directory-name simple-namemember-name alphanum31project-name alphanum12qualified-name simple-name [.simple-name]...simple-name alphanum16star-name alphanum31 where unspecified parts are replaced by the *

character.temporary-file-name simple-nameuser-name alphanum12volume-name alphanum6 (length < = 6) protected string

The standard parameter-group names and their formats are listed in the followingparagraphs.


47 A2 11UJ Rev04 3-19

3.2.1 Sequential-input-file-description

Format

{input-enclosure-name} [{FILESTAT = {CAT }}]{external-file-name } [{ {UNCAT }}]{ * } [{ {TEMPRY }}] [{TEMPRY }]

[{CATALOG = digit 1 }][{RESIDENT }][{DEVCLASS = device-class MEDIA = {WORK }}][{ {* }}][{ {(volume-name [volume-name]...) }}][{VOLSET = {volset-name|DFLT} }]

[SUBFILE = member-name]

[SHARE = {NORMAL }] [ACCESS = {WRITE }][ {ONEWRITE}] [ {SPWRITE }][ {FREE }] [ {READ }][ {MONITOR }] [ {SPREAD }][ {DIR }] [ {RECOVERY}][ ] [ {ALLREAD }]

[FSN = {digits3}][ {ANY }][ {NEXT }]

[NBEFN = {digits3}] [FIRSTVOL = {digits3}][ {ALL }] [ {EOF }]

[LASTVOL = {digits3}] [END = {DEASSIGN}][ {EOF }] [ {PASS }] [ {LEAVE }] [ {UNLOAD }]

[ABEND = {DEASSIGN}][ {PASS }] [MOUNT = digits2][ {LEAVE }][ {UNLOAD }]

[POOL [{FIRST}]] [LABEL = {NATIVE }][ [{NEXT }]] [ {NONE }] [ {NSTD }]

Comments and Restrictions

SYSOUT or DUMMY cannot be external-file-names. The file referenced must be asequential file. If SUBFILE appears, the default for SHARE is DIR. The default value ofACCESS is READ (compare with the ASSIGN statement where the default is WRITE).Otherwise, the parameters and their values are as described under the ASSIGNstatement.

The external-file-name may be TEMP, TEMP1 or TEMP2 but in such a case the SUBFILEparameter must be specified and no other parameter should be given.


3-20 47 A2 11UJ Rev04

3.2.2 Input-file-description

This parameter group is identical with sequential-input-file-description except that the filereferenced is not restricted to being a sequential file.

3.2.3 Sequential-output-file-description

Format

{ } [{FILESTAT = { CAT }}]{external-file-name} [{ {UNCAT }}]{DUMMY } [{ {TEMPRY}}] [{TEMPRY }]

[{CATALOG = digit1 }][{RESIDENT }][{DEVCLASS = device-class MEDIA = {WORK }}][{ {* }}][{ {(volume-name [volume-name]...)}}][{VOLSET = {volset-name | DFLT } }]

[FSN = {digits3}] [ {ANY }][SUBFILE = member-name] [ {NEXT }]

[SHARE = {NORMAL }] [ACCESS = {WRITE }][ {ONEWRITE}] [ {SPWRITE }][ {FREE }} [ {READ }][ {DIR }] [ {SPREAD }][ {MONITOR }] [ {RECOVERY}][ ] [ {ALLREAD }]

[END = {DEASSIGN}] [ABEND ={DEASSIGN }][ {PASS }] [ {PASS }][ {LEAVE }] [ {LEAVE }][ {UNLOAD }] [ {UNLOAD }]

[LABEL = {NATIVE }] [MOUNT = digits2][ {NONE }][ {NSTD }] [FIRSTVOL ={digits3}] [ {EOF }]

[LASTVOL ={digits3}] [ {EOF }]

[ ] [DENSITY ={D1600}][EXPDATE ={ddd }] [ {D6250}][ {yy/ddd }] [ { S35 }][ {yy/mm/dd}] [ { S75 }]

[POOL [{FIRST}]][SIZE = digits3] [ [{NEXT }]] [ ]

[CATNOW] [CATALOG=digit1]


The meaning of each parameter in the group, except SIZE, is given in the ASSIGNstatement. The default value of ACCESS is WRITE. SIZE specifies the number of diskcylinders to be allocated to the file and is permitted for temporary files only.


47 A2 11UJ Rev04 3-21

3.2.4 Output-file-description

This parameter group is identical to sequential-output-file-description except that the filereferenced is not restricted to being a sequential file.

3.2.5 Print-file-description

The parameters in this group are identical to those in sequential-output-file descriptionexcept that SYS.OUT may be used as an external-file-name whereas TEMP, TEMP1 orTEMP2 may not be used.

3.2.6 Work-file-description

Format

[{FILESTAT = {CAT }}] [{ {UNCAT }}]external-file-name [{ {TEMPRY}}] [{TEMPRY }]

[{CATALOG = digit1 }][{RESIDENT }][{DEVCLASS = device-class MEDIA = {WORK }}][{ {(volume-name [volume-name]...)}}][{VOLSET = {volset-name | DFLT} }]

[SHARE = {NORMAL }] [ACCESS = {WRITE }][ {ONEWRITE}] [ {SPWRITE}][ {FREE }] [ {READ }][ {DIR }] [ {SPREAD }][ {MONITOR }] [ {ALLREAD}]

[LABEL = NATIVE] [SIZE = digits3]

[END = {DEASSIGN}] [ABEND = {DEASSIGN }][ {PASS }] [ {PASS }]

[EXPDATE = {ddd }][ {yy/ddd }][ {yy/mm/dd}]


The SIZE parameter can be specified only if the file is temporary and it specifies thenumber of disk cylinders to be allocated to the file.

Otherwise the work file must already have been preallocated (for example, using thePREALLOC utility). The other parameters are described under the ASSIGN statement.


3-22 47 A2 11UJ Rev04

3.2.7 Input-library-description

Format

{ } [{FILESTAT = {CAT }}]{external-file-name} [{ {UNCAT }}]{TEMP } [{ {TEMPRY}}]{TEMP1 } [{ }]{TEMP2 } [{TEMPRY }]

[{CATALOG = digit1 }][{RESIDENT }][{DEVCLASS= device-class MEDIA=(volume-name [volume-name]...)}][{VOLSET = {volset-name | DFLT} }]

[SHARE = {NORMAL }] [ACCESS = {WRITE }][ {ONEWRITE}] [ {SPWRITE}][ {FREE }] [ {READ }][ {DIR }] [ {SPREAD }][ ] [ {ALLREAD}]


[LABEL = NATIVE]


SYSOUT, DUMMY and input enclosures may not be specified. If the external-file-name isTEMP, TEMP1 or TEMP2 then FILESTAT=TEMPRY is forced, and END, ABEND bothdefault to PASS instead of DEASSIGN. The other parameters are as described underASSIGN.


47 A2 11UJ Rev04 3-23

3.2.8 Output-library-description

Format

[{FILESTAT = {CAT }}]{external-file-name} [{ {UNCAT }}]{TEMP } [{ {TEMPRY}}]{TEMP1 } [{ }]{TEMP2 } [{TEMPRY }]

[{CATALOG = digit1 }][{RESIDENT }][{DEVCLASS=device-class MEDIA=(volume-name [volume-name]...)}][{VOLSET = {volset-name | DFLT } }]

[SHARE = {NORMAL }] [ACCESS = {WRITE }][ {ONEWRITE}] [ {SPWRITE }][ {FREE }] [ {READ }][ {DIR }] [ {SPREAD }][ ] [ {RECOVERY}]


[LABEL = NATIVE] [SIZE = digit3]



SYSOUT or DUMMY may not be specified. If the external-file-name is TEMP, TEMP1 orTEMP2 then FILESTAT=TEMPRY is forced, and both END and ABEND default to PASSinstead of DEASSIGN. The default of ACCESS is WRITE. SIZE gives the number of diskcylinders to be allocated, for temporary files only. The other parameters are as describedunder ASSIGN.

3.2.9 Print-library-description

This parameter group is identical with output-library-description. For interactiveprocessing, TEMP TEMP1 and TEMP2 can be specified; if no value is specified, TEMPapplies by default.


3-24 47 A2 11UJ Rev04

3.2.10 Define-parameters

These are the parameters of the basic JCL statement, DEFINE. For the format anddescription, refer to the DEFINE statement.

3.2.11 Sysout-parameters

These are the parameters of the basic JCL statement, SYSOUT. For the format anddescription, refer to the SYSOUT statement.

3.2.12 Size-parameters

These are the parameters of the basic JCL statement, SIZE. For the format anddescription, refer to the SIZE statement.

3.2.13 Step-parameters

These are parameters of the STEP basic JCL statement. For the format and description,refer to the STEP statement. The parameters OPTIONS, DEBUG and DUMP=ALL arenot valid step-parameters.

47 A2 11UJ Rev04 4-1

4. Basic JCL Statements

4.1 HOW STATEMENTS ARE PRESENTED

This chapter describes each of the Job Control Language Statements, in alphabeticalorder. Information about each statement is organized under the following six headings:

1. Function.

2. Enclosure.

3. Format.

4. Description of Statement.

5. Parameters (when they exist).

6. Examples.

4.1.1 Function

Briefly describes what the statement does.

4.1.2 Enclosure

Tells you what enclosure level the statement belongs to. This can be job, step, or input.


4-2 47 A2 11UJ Rev04

4.1.3 Format

Contains the full specification for the basic JCL statement. The format model for eachstatement is written in a typeface different from the body of the text, and the followingnotation conventions are used:

UPPERCASE The keyword item is coded exactly as shown.

lowercase Indicates a value which the user must supply.

[item] An item within square brackets is optional.

{item1}{item2}{item3}

A column of items within braces indicates that one valuemust be selected if the associated parameter is specified.If the parameter is not specified, the underlined item istaken as the default value.

( ) Parentheses must be coded if they enclose more than onepositional item.

... An ellipsis indicates that the preceding item may berepeated one or more times.

4.1.4 Description of Statement

Gives a more detailed description of the statement. It may also include any pertinentcomments and restrictions, which are listed under the sub-heading: Comments andRestrictions.

4.1.5 Parameters

Where parameters exist, there is a description of each one. Mandatory parameters aredescribed first, under the sub-heading: Mandatory Parameters.

Optional parameters follow, under the sub-heading: Optional Parameters.

4.1.6 Examples

Finally, some examples are normally given to illustrate how the statement should bewritten.

Basic JCL Statements

47 A2 11UJ Rev04 4-3

4.2 ALLOCATE

4.2.1 Function

Requests space allocation for a disk or diskette file and/or space extension whenever theexisting space is used up.

4.2.2 Enclosure

Step.

4.2.3 Format

ALLOCATE internal-file-name

{SIZE = digits10 } { } {INCRSIZE = digits5 } { } {SIZE = digits10 INCRSIZE = digits5}

[UNIT = {TRACK }] [ {TRK }] [ {CYLINDER}] [ {CYL }] [ {RECORD }] [ {BLOCK }] [ {100KB }]

[CHECK]

[KEEP] ;


4-4 47 A2 11UJ Rev04


The ALLOCATE statement requests disk space allocation for a temporary or permanentuncataloged file that is assigned to a step. In addition, for UFAS sequential and indexedfiles, and library files, whenever the allocated space becomes exhausted, ALLOCATEmay request file extension. If all the space currently allocated to the file is occupied andmore is required in the current step, the file extension mechanism provides more space.Each ALLOCATE statement must always be associated (by the internal-file-name) with anASSIGN statement in the same step enclosure.

If an ASSIGN statement exists for a temporary file which is to be created, but nocorresponding ALLOCATE statement exists, a default ALLOCATE statement with onecylinder of space is assumed. Where appropriate, a one-cylinder extension space is alsoassumed in this statement.

If several ASSIGN statements in a step refer to the same permanent-file-name, theALLOCATE statement is only valid when associated with the internal-file-name of the firstASSIGN. See the ASSIGN statement for further details of multiple assignments of thesame file in a given step.

An ALLOCATE is necessary when the CATNOW parameter is used in ASSIGN and whenthe cataloged file to be created resides on disk. (Not applicable to tape).

Space allocation becomes effective only when the file named in ALLOCATE (internal-file-name) is opened, and for diskette files only, the file must be opened in output mode. If noattempt is made to open the file during the step execution, no space allocation is made.Attempts to access the file before its effective allocation will result in an abnormal returncode.

Space allocation for permanent files should normally be requested with the PREALLOCutility (see Section 5). In particular, ALLOCATE cannot be used for IDS files. Spaceallocation for permanent library files should normally be requested with the LIBALLOCstatement.

When INCRSIZE is specified, files are dynamically extended, if necessary, during writeoperations (that is, extension is not done at file open time). This parameter does not applyto diskette files.

An attempt to allocate space for a file which already exists will normally produce the returncode ALREADY when the file is opened, and the ALLOCATE will be ignored. However, ifthe CHECK parameter has been specified in the ALLOCATE statement, the step will beaborted.


47 A2 11UJ Rev04 4-5

4.2.5 Parameters

4.2.5.1 Mandatory Parameter

INTERNAL-FILE-NAME

The name of the file for which space is allocated. It matches the file specified in therelated ASSIGN statement.

The name must not exceed eight alphanumeric, hyphen and underscore characters. Itmust start with either a number or a letter.

4.2.5.2 Optional Parameters

SIZE

Specifies the size of the file in terms of the number of units of space allocation (see UNIT,below). Its default value is 0. This parameter must appear if INCRSIZE is not specified.

INCRSIZE

Specifies the number of units of space allocation (see UNIT below) that are added to anoutput file every time automatic space extension is performed on it in the current step. Itmust appear if SIZE is not specified. The default value is 0; that is, there is no automaticextension if INCRSIZE is not specified. This parameter does not apply to diskette files.

UNIT

Specifies the unit of space allocation or extension as either a TRACK, CYLINDER,RECORD, BLOCK, or 100KB. The default unit is a TRACK.

The following abbreviations may also be used:

TRK (for track)CYL (for cylinder)

CHECK

If a file with the same external file name as the one specified in the associated ASSIGNstatement already exists, the use of the CHECK parameter will cause the current step toabort at file open time. If CHECK is not specified in such a case the return codeALREADY is set.


4-6 47 A2 11UJ Rev04

KEEP

If KEEP is specified, the allocation parameters are kept and used again for any file that isassigned using the same internal-file-name.

Examples:

ALLOCATE BAC, SIZE=20, UNIT=CYL;

ALLOCATE FULL, INCRSIZE=2;


47 A2 11UJ Rev04 4-7

4.3 ASSIGN

4.3.1 Function

Makes a file known and accessible to a step and allocates the resources associated withthe file to the step.

4.3.2 Enclosure

Step.

4.3.3 Format

ASSIGN internal-file-name

{external-file-name } {temporary-file-name } {*input-enclosure-name} {DUMMY } {* }

[{FILESTAT = {CAT }}] [{ {UNCAT }}] [{ {TEMPRY}}] [{ }] [{TEMPRY }]

[CATALOG = digit1]

[CATNOW ]


[{VOLWR }][{NVOLWR}]

[OPTIONAL]

[DEFER]

[{RESIDENT }][{device-class-description }][{device-identification-list }][{VOLSET = {volset-name|DFLT}}]

[SUBFILE = member-name]


4-8 47 A2 11UJ Rev04

[SHARE = {NORMAL }][ {ONEWRITE}][ {FREE }][ {MONITOR }][ {DIR }]

[ACCESS = {WRITE }][ {READ }][ {SPWRITE }][ {SPREAD }][ {RECOVERY}][ {ALLREAD }]

[END = {PASS }][ {DEASSIGN}][ {LEAVE }][ {UNLOAD }]

[ABEND = {PASS }][ {DEASSIGN}][ {LEAVE }][ {UNLOAD }]

[ENDVOL = {UNLOAD }][ {REWIND }][ {LEAVE }]

[MOUNT = digits2]

[POOL [{FIRST}]][ [{NEXT }]]

[LABEL = {NATIVE}][ {NONE }][ {NSTD }]

[FIRSTVOL = {digits3}][ {EOF }]

[LASTVOL = {digits3}][ {EOF }]

[FSN = {digits3}][ {ANY }][ {NEXT }]

[NBEFN = {digits3}][ {ALL }]

[DENSITY = {D1600 }][ {D6250 }][ {S35 }][ {S75 }];


47 A2 11UJ Rev04 4-9

Where the device-class-description has the format:

DEVCLASS = device-class

MEDIA = {WORK } {(volume-name [volume-name] ...)} {* }

and the device-identification-list has the format:

DVIDLIST = (device-name [device-name] ... )

MEDIA = {WORK } {(volume-name [volume-name] ... )} {* }


The first function of the ASSIGN statement is to make a file known and accessible to astep. This is done by relating the file's "internal-file-name" (defined in the program) to its"external-file-name", which is the name by which the file is known to the file system.

The second function of this statement is to allocate to the step the resources (device,media) that are associated with the file. Devices may be optionally allocated from a devicepool (see POOL statement).

The file to be assigned may be an input enclosure (SYSIN subfile, deleted at jobtermination) or it may be a permanent file (cataloged or uncataloged) or a temporary file.A cataloged file may only be accessed through the catalog mechanism (see thedescription of the ATTACH statement in the Catalog Management User's Guide). In thiscase, the residency parameters (RESIDENT, DEVCLASS or DVIDLIST, and MEDIA)must not be specified. For an uncataloged or temporary file, you must declare theassociated volume and device by means of the residency parameters.

If the external-file-name begins with the characters SYS. then the assignment is to asystem file; in this case, or if the value of the second positional parameter begins with anasterisk (for an input-enclosure-name) or is DUMMY, residency parameters must notappear. One or more residency parameters (for example RESIDENT, or DEVCLASS andMEDIA) indicate that the file is permanent and uncataloged, unless, in addition, theparameter TEMPRY (or FILESTAT=TEMPRY) appears, in which case the file is taken tobe temporary. The CATALOG parameter indicates a permanent cataloged file.


4-10 47 A2 11UJ Rev04

If the file name does not correspond to a system file, an input-enclosure, nor a dummyfile, and if the residency, FILESTAT, TEMPRY and CATALOG parameters are missingfrom an ASSIGN statement, the following occurs:

• the system first of all assumes that the file is permanent and cataloged, and it appliesthe search rules of the catalog mechanism in the following order:

1. the catalogs which are explicitly attached to the job,2. the site catalog (SITE.CATALOG),3. the system catalog (SYS.CATALOG),4. the catalogs which are registered system-wide as auto-attachable;

• if the search fails, file management then assumes that it is an uncataloged permanentfile that has been passed from a previous step (see the PASS parameter below);

• if there is no passed uncataloged file with the same external-file-name, the file isassumed to be resident and uncataloged.

For identification purposes, the system automatically adds a string of characters (whichcontain the Run Occurrence Number of the current job) to the beginning of eachtemporary-file-name. Although this compound name may appear in the Job OccurrenceReport, you must only use the simple temporary-file-name.

Normally the space for a permanent disk file will already have been preallocated bymeans of the data management utilities (PREALLOC, FILALLOC, LIBALLOC, ...).However, if a new disk file is being created in the current step, an ALLOCATE statementmust be included in the same step enclosure. For a temporary file, the ALLOCATEstatement may be omitted (see the ALLOCATE statement). For a tape file, no spaceallocation request is necessary although PREALLOC is required for the catalog entry of acataloged tape file.

The ASSIGN statement also enables a unit record device to be directly assigned to astep. For example, if a printer is assigned, then printing takes place during step execution,thus, the programmer decides not to use the SYSOUT mechanism (see the SYSOUTstatement). The file system does not allow simultaneous requests for a given volumeusing both the device-name (DVIDLIST) and the device-class (DEVCLASS).

NOTE: The system automatically adds a prefix to the beginning of all external-file-names that begin with a period (see Section 3).

Multiple Assignments of the Same File in a Given Step

Several ASSIGN statements may exist in the same step for a given permanent-file-name,but each with a different internal-file-name. In this case, the external file identification mustbe unique and specify (or accept the default value for): FILESTAT, LABEL, RESIDENT,DEVCLASS and MEDIA.

The POOL, END and ABEND parameters must be identical, if they are specified.

The MOUNT option must not be specified when multiple assignments of the same fileoccur in a given step. All volumes must be mounted.

If SHARE and ACCESS are specified, they must be compatible with the specifications ofthe corresponding ASSIGN statements. So, too, must be the EXPDATE parameter.


47 A2 11UJ Rev04 4-11

When space allocation for the file is required, the associated ALLOCATE statement mustspecify the corresponding internal-file-name of the first ASSIGN statement in the stepdescription. The space allocation becomes effective only when a file is opened using thisinternal-file-name. Finally, a DEFINE statement, if specified, applies only to a specificinternal-file-name and not to the related permanent-file-name.

File Concatenation

Several standard tape, disk, and diskette files may be read in sequence by means of fileconcatenation. The files are treated by the program as if they are one logical sequentialfile. Files may be concatenated by specifying the respective ASSIGN statements in therequired sequence, with the omission of the internal-file-names on all but the first ASSIGNstatement.

Example:

ASSIGN ifn, MY.FILEA, DEVCLASS=MT/T9, MEDIA=A1;

ASSIGN , MY.FILEB, DEVCLASS=MT/T9, MEDIA=A2;

ASSIGN , MY.FILEC, CATALOG=2;

In the above example, the three files are considered as a single sequential file, starting atMY.FILEA and finishing at MY.FILEC (assuming that MY.FILEC is a cataloged tape file).

Restrictions

All the files must be sequential. There may also be restrictions on the difference inattributes (for example, record size, record format) between the files concerned. Theserestrictions are dependent on the programming language (for example, COBOL,FORTRAN) being used.

If a UFAS file with SHARE=MONITOR (specified in the catalog or in the ASSIGNstatement) is included in the concatenation process then either:

ACCESS=SPREAD (ASSIGN statement)orREADLOCK=STAT (DEFINE statement)

must also be specified, in cases where the step is not repeatable.

Uncataloged tape files and diskette files may be concatenated by using the NBEFNparameter. This parameter gives the number of files to be concatenated starting from the"first" file which is specified by its external file name or by FSN. On multi-file tapes thesequence of concatenation is the physical order in which the files are on the volume. Ondiskettes the sequence of concatenation is the order in which the file labels appear in theVolume Table of Contents, VTOC.

If a multi-extent diskette file is included in the concatenation sequence, then the fileprocessed after it will be the one whose label follows the label of the last extent of themulti-extent file. As a diskette file may have only one extent per volume, multi-extentimplies multi-volume as well. Because of the concatenation rule above, files whose labelsappear in VTOCs between the first extent label and the last extent label of a multi-extentdiskette file, will be omitted from the concatenation sequence.


4-12 47 A2 11UJ Rev04

Example 1:

ASSIGN INT1, FILE3, NBEFN=5, FSN=3,........ ;

Concatenates 5 files on a multi-file tape, starting with the 3rd file on the tape.

Example 2:

ASSIGN INT1, FILE1, NBEFN=4,..........;

Concatenates 4 diskette files. The first file has the external file name FILE1. The secondfile is the one whose file label follows that of FILE 1 in the VTOC. If the second file has 3extents then the concatenation proceeds as follows:

D iskette vo lum e 1



FILE1 FILE2 ABC AXY

ACX FILE2 FILE9 RST

FILE2 FILE3 FILE4 FILE5

1 2 3 4 5

extent1

extent2

XYZ

1 2 3 4

1 2 3 4

extent3

After the 3 extents of FILE2 have been processed, FILE3 and FILE4 are thenconcatenated. The files ABC, AXY, ACX, FILE9 and RST are not concatenated.

Notes on Suffixes for Internal-file-names

When a COBOL program accesses certain types of files, as described below, the internal-file-name in the appropriate ASSIGN statement must contain a numbered suffix,consisting of a hyphen and one or two digits. The composite internal-file-name must notexceed the normal maximum length of internal-file-names (eight characters). Refer to theCOBOL User's Guide for more details on the handling of multiple file tapes and multiplelogical unit files.

The rules for ASSIGN are:

1. When a COBOL program accesses a file within a multiple file tape, the internal-file-name in the ASSIGN statement must consist of the COBOL internal-file-namefollowed by a suffix containing the sequence number of the file within the tape.

Examples:

ASSIGN SUBFIL-1, CA.MTAPE, DEVCLASS=MT/T9, MEDIA=V66, FSN=1;ASSIGN SUBFIL-2, CA.MTAPE, DEVCLASS=MT/T9, MEDIA=V66, FSN=2;ASSIGN SUBFIL-6, CA.MTAPE, DEVCLASS=MT/T9, MEDIA=V66, FSN=6;

Note that SUBFIL-14 would not be a valid internal-file-name since it contains more thaneight characters.


47 A2 11UJ Rev04 4-13

2. When a COBOL program accesses a file as a logical unit of a multiple logical unitfile, the internal-file-name in the ASSIGN statement must consist of the COBOLinternal-file-name followed by a suffix containing the sequence number of the logicalunit within the multiple logical unit file.

Example:

ASSIGN MLNFIL-1, MY.FILEA;

ASSIGN MLNFIL-2, MY.FILEB;


If the COBOL program contains a statement to ACCEPT from SYSIN (see the COBOLLanguage Reference Manual), the ASSIGN statement must be specified as follows:

ASSIGN H_RD, *input-enclosure-name;

The sum of the ASSIGN, DEFINE, and ALLOCATE statements witihin a step enclosuremust not exceed 1200. This maximum value includes all multiple assignments andconcatenated files. In an interactive environment, it also includes consigned files. (See theGCL Commands MWINLIB, MWLIB).


4-14 47 A2 11UJ Rev04

4.3.5 Parameters

4.3.5.1 Mandatory Parameters

internal-file-name

The name declared in the source program. It must not exceed eight alphanumeric,hyphen and underscore characters.

This is the first positional parameter of the ASSIGN statement. It may have a null valueonly in the case of file concatenation (see above).

Examples:

INFILE

IFN4

MY-OUT

external-file-name

This positional parameter is the name of a permanent file known to the system. The rulesfor naming files are given in Section 3. This parameter may be omitted if DEVCLASS isthe printer (that is, if a unit record device is assigned directly. For further information, seethe Unit Record Devices User's Guide).

input-enclosure-name

This positional parameter identifies the named input enclosure data to be assigned to thestep. This data is held in a SYSIN file and is deleted at job termination. The name mustnot exceed 16 alphanumeric, hyphen and underscore characters. In the ASSIGNstatement, the input-enclosure-name must always be preceded by the * character; when itis specified, the only other valid parameter is the internal-file-name.

temporary-file-name

This positional parameter identifies a temporary file. The name must not exceed16 alphanumeric and hyphen characters and must start with a letter or a digit. Theparameter TEMPRY or FILESTAT=TEMPRY must always be specified for a temporaryfile. For tape files in ANSI format, the maximum length for a temporary-file-name is ninecharacters.


47 A2 11UJ Rev04 4-15

DUMMY

This positional parameter specifies that no volume supporting the file is required. Alloperations on the file are ignored except read operations which produce an end-of-filecondition. For certain programming languages (for example, COBOL) DUMMY isrestricted to input sequential files; refer to the appropriate User's Guide.

*

This parameter may only be used with non-cataloged tapes and diskettes. It enables a fileto be assigned without reference to its external-file-name.

For tapes, it refers to the file whose rank on the tape is given by the File Serial Number(FSN), or the first file on the tape if FSN has not been specified. For diskettes, it meansthe file whose label appears first in the VTOC.

Restriction

A file specified by EFN=* cannot be passed, and it cannot be repeatable from acheckpoint because this leads to an abort with the return code CONFLICT at restart time.


FILESTAT

FILESTAT can be used as part of the identification of a file (see Section 3). This specifiesthe file status, according to the following values:

CAT Permanent cataloged file. If no residency parameter(RESIDENT, VOLSET, DEVCLASS or DVIDLIST andMEDIA) is specified, then this is the default value forFILESTAT.

UNCAT Permanent uncataloged file. If FILESTAT is omitted ifRESIDENT or DEVCLASS or DVIDLIST is specified, thenFILESTAT=UNCAT applies by default.

TEMPRY Temporary file; in this case, FILESTAT may be omitted (seebelow).

NOTE: Since default values of FILESTAT exist for cataloged and uncataloged files andsince the self-identifying-value TEMPRY can be used for temporary files (seebelow), the FILESTAT parameter can generally be omitted from the ASSIGNstatement. However, FILESTAT must appear in cases where its absencecauses ambiguity; for example, in the case of an ASSIGN statement for a filethat has been passed from a previous step (and therefore does not requireresidency parameters - see PASS below).


4-16 47 A2 11UJ Rev04

TEMPRY

This is equivalent to writing FILESTAT=TEMPRY. One of these two parameter formsmust be specified when assigning a temporary file. If no residency parameter is specified(and the file is not one that was retained from a previous step using the PASS parameter),the file is located on the job submitter's default volset, provided that the volset facility isactive. If it is not, the file is located on the resident volume.

CATALOG

For an existing cataloged file, (i.e. if CATNOW is not specified), this parameter is used toidentify a particular catalog in the current catalog search path, for locating the specifiedfile. (See the description of the ATTACH statement in the Catalog Management User'sGuide.) The value gives the position of the required catalog specification in thecorresponding ATTACH statement. If an entry for the file is not found in the specifiedcatalog, the step is aborted. If the CATALOG parameter is omitted, the catalog searchrules are applied (all the explicitly attached catalogs, then the site catalog, the systemcatalog, and the "auto-attachable" catalogs) until the file entry is found.

When CATNOW is simultaneously specified, CATALOG identifies the catalog where thefile is to be cataloged.

CATNOW

Dynamically creates an entry for the assigned file in a catalog. The catalog may be directlyspecified by the optional parameter CATALOG=digit1. Otherwise, the catalog search rulesare applied to reference the appropriate catalog.

CATNOW must be specified if the file is to be cataloged. The residency parameter mustbe specified. This may be done by the RESIDENT parameter, indicating that the file is ona resident disk, or by a volset identification, or by a device class descriptor. A deviceidentification list is not accepted.

If the CATNOW parameter is used, an ALLOCATE statement must be associated with theASSIGN statement, except for tape files. For further details of this parameter see theCatalog Management User's Guide.

EXPDATE

Specifies the expiration date for a file. For a magnetic tape file, EXPDATE providesprotection against an accidental attempt to overwrite the file name; for a disk file allocated(with ALLOCATE) in the current step, it prevents any accidental overwrite of the file nameand any unintentional deallocation of the file in the future.

NOTES: 1. The date a disk file expires is specified when the space is allocatedusing the PREALLOC utility (see Section 5) or in ASSIGN when thefile is first used in conjunction with an associated ALLOCATEstatement. This date is stored in the file label.

2. A disk file can be deallocated (deleted) using the DEALLOC utility(see Section 5). If the expiration date has not been reached, the filemay only be deallocated if the BYPASS parameter is specified inthe DEALLOC statement.


47 A2 11UJ Rev04 4-17

3. Even if a retention period is specified, a disk file can be opened inoutput mode and its previous contents overwritten (that is, the filename is protected, but the file contents are not).

4. For uncataloged disk files, the EXPDATE parameter in ASSIGN isonly meaningful if the file space is allocated in the current step (withALLOCATE).

5. For cataloged files (disk and tape), the EXPDATE parameter isonly meaningful when a new generation is created; in this case thespecified value overwrites the expiration value that is stored in thecatalog.

6. For uncataloged tape files, the retention period of a file may bespecified each time the file is written, that is, opened in outputmode. If no date is provided in this circumstance then the currentdate is taken as the expiration date.

7. Any EXPDATE value specified for a temporary file is ignored.

8. The VOLPREP utility can delete every existing file on the disk beingprocessed. For this to happen, BYPASS must be specified and, if afile exists for which the expiration date has not been reached, theoperator is asked, by a console message, whether all files are to bedeleted, regardless of the status of their expiration dates.

9. When the expiration date of a tape file has not been reached, thesystem protects the file from being overwritten by another file of adifferent file name. If the expiration date of the tape file has notbeen reached and a new file of a different name is to be writtenthen the volume must first be returned to the scratch state usingthe VOLPREP utility (see Section 5). The presence of a retentionperiod does not prevent the file from being opened in output modeand reloaded, but the file name used must be the same as thatcurrently in the file label.

The expiration date in the EXPDATE parameter is specified in one of the following ways:

• Retention period in number of days (for example, 12).

• Date of expiration in the form: year (2 digits)/day within the year (3 digits). For example,91/046 means the 46th day of the year 1991, or February 15th, 1991.

• Date of expiration in the form: year (2 digits)/month(2 digits)/day(2 digits). For example,91/02/15 means February 15th, 1991.

VOLWR (for tape and cartridge volumes only)

The tape or cartridge must be mounted with the Write-protection mechanism OFF (withwrite ring for a tape, or in write-permit position for a cartridge).


4-18 47 A2 11UJ Rev04

NVOLWR (for tape volumes only)

The tape or cartridge must be mounted with the Write-protection mechanism ON (withoutwrite ring for a tape, or in write-protect position for a cartridge).

OPTIONAL

The file is considered to be a DUMMY file if either the operator indicates to the systemthat the file volumes are not available or if the volumes are available but do not, in fact,contain the file.

DEFER

The step can start even if the specified volume is not mounted. In this case, the volume ismounted when the file associated with the internal-file-name is opened. However, adevice resource is allocated in order to guarantee that the volume can be mounted atopen time, otherwise the job would be aborted if no device were free at that time. Betweenassign and open, the visible device display is:

MSxx ALLOCATED TO RON

with no volume name.

RESIDENT

This specifies that the file is stored on resident disk volumes.

DEVCLASS or device-class-description

Specifies the device class (see Section 3) for the device associated with an existinguncataloged file, or a file to be automatically allocated (temporary or to be cataloged ifCATNOW is specified). Within this class all devices are equivalent and the specificdevice used is determined by GCOS.

DVIDLIST or device-identification-list

For an uncataloged file, this specifies a list of one or more devices (see Section 3) by thedevice names on which the volumes are to be mounted. It is recommended that theDEVCLASS parameter normally be used instead of DVIDLIST.

NOTES: 1. Device names cannot be specified for resident disk volumes.

2. Files that are assigned with the use of the DVIDLIST parameter arenot sharable.


47 A2 11UJ Rev04 4-19

MEDIA

This is specified with either DEVCLASS or DVIDLIST. You specify the names of non-resident volumes supporting the file (uncataloged, temporary, or to be allocated andcataloged when CATNOW is specified). The volume-name is composed of up to sixalphanumeric characters. Unless the volume(s) containing the file is premounted orresident, at execution time a mount message for the required volume(s) is generated onthe operator's console. The maximum number of volume names is 10.

For the printer, the MEDIA parameter gives the print belt and paper identification as a six-character value, as follows:

• Characters 1-2 = print belt identifier.

• Characters 3-6 = form number.

WORK This parameter value can only be specified with the MEDIAparameter for output tapes. It requests the use of a number(specified by the value of MOUNT) of native labelled worktapes.

* The volume names are not known when a job is submitted,but will be supplied by the operator at run time. This valuemay be given for input or output files. It is applicable tocatalogued or uncataloged tape files, and diskette files. Itsuse prohibits device reconfiguration and pre-mounting ofvolumes. When using MEDIA=*, the volumes and theirsequence of mounting is under the complete control of theoperator, so care must be taken to ensure that he has a list ofvolumes in the correct sequence and that he can readilyidentify each volume.

NOTES: 1. A file in a work tape may be used in several steps of a job ifEND=PASS appears in each step that uses it.

2. A work tape can be protected from use by other users ifEND=PASS appears in the ASSIGN in each step which accesses afile in the tape.

3. The VOLPREP or TAPEPREP utilities can be used to prepare awork tape.

4. If TEMPRY (or FILESTAT=TEMPRY) is not specified in ASSIGNwhen a program writes to a file in a work tape, the tape loses itswork status.

5. If the list of volumes specified (for example, in MEDIA) for anordinary tape file in output mode is not sufficient (that is, if moretapes are required), the system automatically assigns work tapes tothe file, until the limit of 10 volume names is reached.


4-20 47 A2 11UJ Rev04

VOLSET

This specifies the volset name where the file is to reside. This parameter can only be usedwhen the volset facility is active on the system and when the file is temporary or is to becataloged (CATNOW parameter is also specified). It can be used for non-existent files,and for files that are already assigned (for example, a temporary file retained from aprevious step by the PASS parameter). Other residency parameters (RESIDENT,DEVCLASS or DVIDLIST and MEDIA) cannot be used if VOLSET is specified. The volsetname consists of up to six alphanumeric characters, chosen by the System Administrator.

The name DFLT is a symbolic name reserved for naming the default volset:

• with the basic function, the site volset is the default volset for all the projects. It is theonly volset available.

• with the full function, a project's default volset is defined by the System Administrator. Ifa project does not have a default volset, the site volset is its default.

For further details, refer to the Administering the Storage Manager Manual.

SUBFILE

Applicable only to a member of a library (identified by external-file-name above). Thisparameter permits the named member to be accessed sequentially. The member-namecan contain up to 31 alphanumeric, hyphen, and underscore characters and must beginwith a letter or a digit. For example, a subfile can be a source library member whichcontains a communications network description. A subfile can also be specified for outputbeing sent to SYSOUT.

SHARE

Specifies the rules for the common sharing of the file, as required within the step (due tomultiple assignments of the same file) or as requested with respect to other concurrentsteps. If the SHARE parameter is omitted, the default values apply. (See the note below).

NORMAL One writer (output processor) or several readers (inputprocessors).

Two or more concurrent assignments with different SHAREvalues are not permitted except between SHARE=NORMALand SHARE=ONEWRITE. For example, if a job is runningwith the values SHARE=FREE, ACCESS=WRITE (seeACCESS below), a request for SHARE=ONEWRITE,ACCESS=READ will not be granted until the first job hasreleased the file.

Note that after an assignment with SHARE=NORMAL andACCESS=READ, a request for SHARE=ONEWRITE andACCESS=WRITE will not be granted.

ONEWRITE One writer and several readers.


47 A2 11UJ Rev04 4-21

FREE No restrictions.

MONITOR This applies to UFAS and IDS/II disk files only. It is used toindicate that file sharing is under GAC (General AccessControl). A file may be assigned simultaneously to severalreaders and writers. Sharing is controlled at access time atthe Control Interval (CI) level rather than at assign time at thefile level.

DIR Applies only to libraries. Each member can be concurrentlyaccessed by several readers or one writer.

NOTE: The default value of SHARE for uncataloged files is NORMAL, except when theparameter SUBFILE is specified; in this case default value for SHARE,assuming it is a library, is DIR. The default value for cataloged files is the valuegiven in the catalog entry for the file; however, if a value that differs from thecatalog entry appears for SHARE, the catalog entry overrides the specified valueand the step has exclusive access to the file.

ACCESS

Specifies the allowable processing modes for the step.

WRITE Allows input, output and append modes.

READ Allows input mode only.

SPWRITE Same as WRITE. Additionally, the current step has exclusivefile control, regardless of the SHARE value.

SPREAD Same as READ. Additionally, the current step has exclusivefile control, regardless of the SHARE value.

RECOVERY Applies only to cataloged files (see the Catalog ManagementGuide); the step has exclusive access for file recoverypurposes.

ALLREAD Same as READ. Additionally, access by others is restricted toREAD only, regardless of the SHARE value.

NOTE: When an ALLOCATE statement is associated with the file, that file is onlyaccessible from within the step (that is, ACCESS=READ is treated asACCESS=SPREAD and ACCESS=WRITE is treated as ACCESS=SPWRITE).


4-22 47 A2 11UJ Rev04

END

Indicates to the system the state in which the file should be left after normal steptermination, as follows:

PASS If the file is temporary it is retained for use by a subsequentstep in the same job, until either job termination or asubsequent step assigns the file without a PASS option, inwhich case the file is deleted at termination of that step. If thefile is permanent, then volume and device identificationassociated with the file is retained. For a temporary orpermanent file that is assigned to a later step in this job, theDEVCLASS (or DVIDLIST), MEDIA, RESIDENT, VOLSETand LABEL parameters do not need to be specified in therelated ASSIGN statement.

An ASSIGN in a subsequent step must specify internal-file-name, external-file-name and FILESTAT (or TEMPRY) inorder to access a passed file. If DEVCLASS (or DVIDLIST),MEDIA, RESIDENT, VOLSET or LABEL are also stated, theymust be consistent with the values specified in the passingstep.

The stated values, if any, for MOUNT, END, ABEND, SHAREand ACCESS apply only to the step in which they arespecified. They are not passed automatically.

NOTE: A file specified by EFN=* cannot be passed.

DEASSIGN A temporary file is deleted at the end of the step or when aCLOSE WITH LOCK is executed in the (COBOL) program.For a permanent uncataloged file that is assigned to a laterstep in this job, the subsequent ASSIGN statement mustinclude full volume and device identification (RESIDENT, orDEVCLASS (or DVIDLIST) and MEDIA).

LEAVE Applies to tape or cartridge files with the following results:

At CLOSE time, the media is left in its current position.

At volume switching time, the media is rewound, except if:

- ENDVOL parameter is specified.

- the ASSIGN was performed with MD=* (any media), inwhich case the media is unloaded;

- the ASSIGN was performed with FSN=NEXT and theaccess was INPUT (case of ACCESS=READ, or INSETwith utilities), in which case the media is left in its currentposition (at EOT);


47 A2 11UJ Rev04 4-23

- the file is a cartridge file on a cartridge driver equippedwith a Sequential Cartridge Loader (SCL) inAUTOMATIC mode, in which case the media isunloaded;

- the program has a request for LEAVE in the VOLUMESWITCHING primitive.

At the end of the step, the last processed media is left in itscurrent position.

In any case, the volume remains reserved until the end of thestep, even if the tape is deassigned or the device isdeallocated.

WARNING

LEAVE is efficient if the number of tape drives is greater than or equalto the number of volumes in the media list.

UNLOAD Applies to tape or cartridge volumes only, with the followingresults:

At volume switching time, the media is unloaded, except if:

a) ENDVOL parameter is specified.

b) files are processed by utilities as an INSET, in whichcase the media is left in its current position (at EOT);

c) files are processed by utilities as an OUTSET, in whichcase the media is rewound;

d) files are cartridge files on a cartridge driver equipped witha Sequential Cartridge Loader (SCL), in MANUAL mode,in which case either b) or c) above applies, depending onthe processing type.

NOTES: 1. In the case of cartridge files on a cartridge driver equipped with aSCL, in AUTOMATIC mode, if you specify the END=UNLOADoption, the last used cartridge and the following unused ones (ifthere are any) declared in the media list of the correspondingASSIGN statement, are unloaded during deassignment. InMANUAL mode, only the last used cartridge is unloaded.

2. END is not applicable if *input-enclosure-name is specified.


4-24 47 A2 11UJ Rev04

3. For multivolume temporary files for which MOUNT is specified, totaldeletion of the file can only occur if a sufficient number of devicesare available to mount all of the volumes of the file simultaneously.However, if MOUNT is not specified (that is, all volumes are to bemounted, by default) when DEASSIGN is stated, total deletion ofthe file is guaranteed. If MOUNT is not specified when PASS isstated, total deletion can only occur if a sufficient number ofdevices is available to mount all of the volumes simultaneously. IfPASS is stated, deletion will occur at the next DEASSIGN relatingto an ASSIGN with END= DEASSIGN, or, at the latest, at end ofjob.

4. Foreign tapes (processed by the Foreign Tape Processor FTP) arealways considered as monofile volumes by GCOS 7.

5. For a tape file for which LEAVE or UNLOAD has not beendeclared, or for which PASS has been specified, the implicit actionis REWIND, with the following observations:

- at close time, the tape is rewound when the ASSIGN hasbeen performed with the POOL option, or when fileconcatenation has been declared.

- at VOLUME SWITCHING time, refer to the description ofVOLUME SWITCHING for END=LEAVE.

- at the end of the step, the tape volume is rewound,except if the ASSIGN was performed with MD=*.

WARNING

When a cartridge library is used, dismounting can be forced. Refer tothe Cartridge Tape Library Unix Server User's Guide, paragraph:Dismounting Library Volume.

ABEND

Indicates to the system the state in which the file should be left if the step is abnormallyterminated. The values PASS, DEASSIGN, LEAVE and UNLOAD are described above.

ENDVOL

Applies to tape and cartridge device with multi-volume file; it concerns all volumes onwhich the file spread on except the last one which is concerned by END parameter. Itindicates to the system the state which the volume should be left as follows:

UNLOAD Intermediate volumes are unloaded at volume switching time.

REWIND Intermediate volumes are rewound at volume switching time.

LEAVE Intermediate volumes are left in their current position atvolume switching time.


47 A2 11UJ Rev04 4-25

MOUNT

The MOUNT parameter applies to UFAS sequentially organized files.

MOUNT defines the number of devices allocated for the file to this step and the number ofvolumes in a particular device class that need to be mounted at step initiation (before stepexecution begins) when POOL is not specified. See POOL for a description of processingwhen POOL is specified. The volumes are those specified by the MEDIA parameter orthose selected by the volset facility when the VOLSET parameter is used. If all thevolumes are not mounted at step initiation, the remaining volumes are mounted duringstep execution according to program requirements. If MOUNT is not present, then in thecase of disks, all volumes are mounted by default. The default value of MOUNT for alldevice classes except disk is 1.

NOTE: If MEDIA=WORK is specified, MOUNT specifies the number of drives to beallocated.

POOL

Specifies that volumes supporting the file are to be mounted (see the MOUNT parameter)on pool devices with the same attributes.

These devices may be allocated to the pool in one or more POOL statements. Therelated POOL statement(s), if present, must precede the ASSIGN statement in the stepenclosure.

When the POOL parameter is used in an ASSIGN statement, the POOL Statement is notmandatory. If the POOL Statement is omitted, the pool of devices is dynamically reservedaccording to all the pool parameters of the step.

When POOL is specified, a pool device is reserved for use prior to the step execution andis assigned to the file when the file is opened. The device is only released and returned tothe device pool when the file is closed. For example, in COBOL this is done with theCLOSE WITH LOCK option or with the CLOSE option. A detailed description of the use ofdevice pools is given in the JCL User's Guide.

FIRST

May only be specified if the POOL option is chosen. It specifies that one or morevolumes (according to the MOUNT parameter value) supporting the file, named inthis ASSIGN statement in this step, are to be mounted on a pool device or devicesbefore the file associated with the internal-file-name is opened in the step, andbefore step execution begins. As a result, the sum of all devices specified with"POOL, FIRST" must not exceed the minimum number of devices defined in acorresponding POOL statement.

NEXT

May only be specified with the POOL option. The volumes supporting the file, namedin this ASSIGN statement in this step, are to be mounted on pool devices during stepexecution, according to program requirements.


4-26 47 A2 11UJ Rev04

LABEL

Specifies the type of volume label according to the values:

NATIVE GCOS standard label organization

NONE No label

NSTD Unknown label format. Allows you to work with files in GCOSnon-standard label and see them like GCOS standard files.

By default, the system expects tape and disk volumes to have standard labelorganizations (LABEL=NATIVE). If a volume is presented to the system which does nothave standard labels then you must specify the label organization explicitly. If the valuespecified by LABEL, NATIVE by default, does not match the labels encountered by theAVR (Automatic Volume Recognition) feature of GCOS, then the execution of the stepcannot start.

The value NONE declares that there are no recognizable labels present on the volume.

When LABEL=NONE is specified for an input tape volume, the GCOS access methodsinterpret the first tape mark encountered as the end-of-file.

FIRSTVOL

Applies only to multivolume tape files. This parameter defines the rank of the first volumeto be accessed at open time, that is, the value gives the position in the media list of thefirst volume to be mounted. For cataloged files, the media list is stored in the catalog; foruncataloged files, the media list is specified by the MEDIA parameter of ASSIGN.

This parameter cannot be specified when the file is not cataloged and the processingmode is neither APPEND nor INPUT.

In addition, if FIRSTVOL is specified for a labelled file, File Management checks that thevolume sequence number (the order of the volume relative to the start of the file) of thevolume chosen is identical to the value of FIRSTVOL. If FIRSTVOL is not specified, thestep proceeds without any check being made.

The EOF value for FIRSTVOL specifies that the first volume to be processed is that whichcontains the end-of-file marker. This is applicable to cataloged files only.

Example:

If the media list is (V1, V2, V3, V4) and FIRSTVOL=3 is specified, then the system willrequest V3 to be mounted, and, at open time, the volume sequence number of V3 will beexamined (to check that it is the third volume of the file).


47 A2 11UJ Rev04 4-27

LASTVOL

For a multivolume file, this parameter defines the rank of the last volume to be accessed,that is, the value specifies the position in the media list of the volume which is consideredto contain the end of the file. A data limit condition (DATALIM return code) will besignalled when the processing of this volume has been completed. The special valueLASTVOL=EOF specifies that the last volume to be processed must contain the end-of-file marker. In this case, for an uncataloged file, an error condition will arise when the lastrecord of the volume is accessed if the media list is incomplete.

LASTVOL=EOF is the default value for sequential files, i.e, the only type which do notrequire all volumes to be mounted at step initiation (tape and diskette).

This parameter cannot be specified for a disk file if an allocation request has been made.

Example:

LFILE,MY.BFIL,LASTVOL=EOF,DEVCLASS=MT/T9/D1600, MEDIA=(V1,V2);

In the above example, if V2 does not contain the end of file MY.BFIL, the step will beabnormally terminated. As LASTVOL=EOF is the default value for tape, it could havebeen omitted above.

However, if LASTVOL=2 were specified the step would terminate normally, even throughV2 does not contain the EOF.

FSN

Applies only to multifile tape volumes; it must be specified for all files on a tape (or tapes)and defines the rank (relative position) of the file in the "family" of files. The value must bean integer between 1 and 253 inclusive. If the value ANY is given, File Management willsearch for the file on the tape at file open time. If the value NEXT is used for a file inoutput mode, the new file will follow the existing files on the tape even if a file of the samename already exists on the tape; (if ANY is specified, the first file with the same file namewill be overwritten).

NOTES: 1. In output processing mode, a file identified by FSN may beoverwritten by another file (provided the retention period hasexpired - see EXPDATE below).

2. The NEXT value is available only in output mode when usingmultivolume files or tapes. Use ANY or a number to process suchfiles in input mode.

WARNING

When LABEL=NONE, ANY or NEXT is assumed as FSN=1.


4-28 47 A2 11UJ Rev04

NBEFN

Refers to tape and diskette files only, where file concatenation is desired. Its value givesthe number of files to be concatenated starting from the file specified by FSN or external-file-name. For tape files the concatenation takes place using the files in the sequence onthe volume (that is, multi-file tape volume).

For diskette files the concatenation sequence is that of the sequence of file labels on theVTOC. A further complication arises in the case of multi-extent diskette files. As a diskettefile may have only one extent per volume, multi-extent implies multi-volume. In suchcases the concatenation exhausts the extents of the multi-extent file and continues withthe file whose label follows that of the last extent. Consequently files on the interveningvolumes may be missed out of the concatenation process.

If the value ALL is specified, then all files on the volume are concatenated. Theconcatenation ends at the end of volume (tapes) or the end of VTOC (diskettes). Ifseveral volumes are listed then the concatenation continues through to the last volume onthe list. If MEDIA=* is used then the processing stops when the operator cancels themount request for the next volume.

DENSITY

Applies exclusively to tape or cartridge files opened in output mode. The use of DENSITYoverrides the tape or cartridge density specified on the label and therefore allows the tapeor cartridge to be written with a density different from that of the existing file on the tape orcartridge. For a multi-file tape or cartridge, the parameter applies only when the first file iswritten.

NOTE: In the absence of the DENSITY parameter, irrespective of the processing modeused, a warning message is issued when there is a conflict between the densitygiven in the DEVCLASS parameter and that in the file label; however, the labeldensity is chosen.

Examples of the ASSIGN Statement

Example 1:

ASSIGN HJFILE, MY.FILE1;

The above example assigns the internal-file-name HJFILE to the cataloged file MY.FILE1.

Example 2:

ASSIGN DMFILE,Z.ABC, EXPDATE=30, DEVCLASS=MS/D500, MEDIA=B012;

An uncataloged disk file with external-file-name Z.ABC is assigned. Provided the spacefor the file is allocated in the current step (with ALLOCATE), an expiration date of 30 daysfrom the current date will take effect.


47 A2 11UJ Rev04 4-29

Example 3:

STEP S1, ...;

ASSIGN SCRFIL, TMP1, TEMPRY, DEVCLASS=MT/T9/D1600, MEDIA=WORK, END=PASS;

...........

ENDSTEP;

STEP S2, ....;

ASSIGN INDATA, TMP1, TEMPRY;

...........

ENDSTEP;

A temporary work file on 9-track tape is passed from one step to another. The file isdeleted at the termination of step S2. Note that it is unnecessary to repeat the residencyparameters (DEVCLASS and MEDIA) in the second step enclosure.


4-30 47 A2 11UJ Rev04

4.4 COMMENT

4.4.1 Function

Enables a comment to be inserted in a job description.

4.4.2 Enclosure

Job, step.

4.4.3 Format

COMMENT 'comment-string';


The COMMENT statement allows a comment to be inserted in a job description.Comments may appear anywhere in a job enclosure other than within an input enclosure.The COMMENT statement is a dummy statement and is not executable.

4.4.5 Parameters

comment-string

The comment-string is a protected string; that is, any character can be used, except that asingle quote within the string must be entered twice in succession. The single quotesenclosing the string appear as part of the comment in the Job Occurrence Report.

Example 1:

COMMENT 'NEXT JOB STEP PRINTS MONTHLY SALES FIGURES';

Example 2:

COMMENT 'OWNER''S NAME & ADDRESS REQUIRED';


47 A2 11UJ Rev04 4-31

4.5 CONSOLE

4.5.1 Function

Defines the destination for user console messages.

4.5.2 Enclosure

Job.

4.5.3 Format

CONSOLE [user-name];


The CONSOLE statement applies to all following SEND statements and to all operatormessages issued by user load-modules (during step execution) and by systemprocedures (for example, execution of Extended JCL Statements).

This statement also determines the source and destination console of the COBOL verbsACCEPT and DISPLAY. See the COBOL User's Guide for details.

The messages are sent to the terminal which is logged on to the system with the givenuser identification. The default terminal is the main console.

4.5.5 Optional Parameter

user-name

The user-name identifies the user of the required terminal. The job (for a SEND) or thestep (otherwise) will abort if the user identification is not associated with a logged onterminal at the time the message is to be sent. If the user-name value is omitted, theconsole associated with the current job is the Main console.


4-32 47 A2 11UJ Rev04

4.6 $DATA

4.6.1 Function

Stores input data in a source library member.

4.6.2 Enclosure

Outside a Job enclosure.

4.6.3 Format

$DATA {member-name } [{(output-library-description)}] {[alphanum 17]*} [{SITE.IN }]

[TYPE = {DATA }] [ {DATASSF}] [ {COBOL }] [ {COBOLX }] [ {RPG }] [ {FORTRAN}] [ {GPL }] [ {JCL }]

[FORMAT = (digits3, digits3, digits3, digits3)]

[END = { EOF }] [ { ENDDATA }] [ {'string 8'}]

[ENDCHAR = 'string1']

[CONTCHAR = 'string1']

[RECSIZE = { 110 }] [ {digits3}]

[REPLACE] [PRINT] [CKSTAT][USER=user-name] [PROJECT=project-name]

[BILLING=billing-name] ;


47 A2 11UJ Rev04 4-33


This statement loads input data into a source library member. It is processed directly bythe Stream Reader and it may be seen as a self contained job with one step, which loadsthe data into the file. As it is functionally equivalent to a job, it cannot be included in a jobenclosure.

The $ sign is mandatory and must appear in position 1 of the record.

All records following the $DATA statement are treated as data records to be loaded intothe output file until a terminator record is encountered. This terminator record may be anyof the following:

• a $ENDDATA statement;

• a $EOS record;

• an EOF (end of file marker);

• a record containing the string specified in END='string 8'.

The output library must be a permanent file that can be accessed immediately at streamreading time (that is, it does not involve waiting for volume mounting or other resources).The USER and PROJECT have to be specified to match the access rules for the outputlibrary file and to conform to job submission rules. A Job Occurrence Report is produced ifthe PRINT parameter is specified or an error is detected during input stream processing.

If the member name already exists on the output-library the input data is not loadedunless the parameter REPLACE is also specified. The storing of input data in a file canalso be done using a standard job enclosure that includes either a CREATE step (see theData Management Utilities Manual) or a LIBMAINT step (see the Library MaintenanceReference Manual). However, by this method, the data is transferred during the executionof the JCL statements whereas with the $DATA statement, the data is stored at StreamReader time. The Stream Reader statement $INPUT loads input data as a member of thelibrary SYS.IN whereas $DATA may be used to load input data directly into a member of apermanent library file.

If a $JOB, $INPUT, or $SWINPUT statement is present in a data enclosure (that is,between the $DATA and $ENDDATA statements) then the result is as follows:

$INPUT treated as a data record.

$SWINPUT executed, if the CKSTAT parameter is present in the $DATAstatement, otherwise it is treated as a data record.

$JOB treated as a data record, if the stream is being read from asequential file, a library member, or from a remote station(RBF); otherwise it leads to an abort.


4-34 47 A2 11UJ Rev04

4.6.5 Parameters


member-name

The first positional parameter, which is mandatory, gives the member name of the libraryin which the data is to be stored. This may be specified either as a name of up to31 characters, which gives the member name in full, or as a name of up to 17 charactersfollowed by an *. In this latter case, the member name is obtained by concatenating thename preceding the *, with a system-generated 14 character date-time string. Thisdate-time string is in YYMMDD-HHMMSS format preceded by the letter D and representsthe year-month-day-hour-minute-second at which the Stream Reader processes the$DATA statement. This date-time stamping may be used to give unique member namesto members that would otherwise be identical.

output-library-description

The second positional parameter specifies the name of the library of which the firstpositional parameter is a member. This parameter is optional and has a default value ofSITE.IN, a resident source library.

The library specified must be a permanent one and all the normal output-library-description parameters except SIZE may be specified.


USER

Specifies the user identification. It is needed if the output library is cataloged andprotected. See the $JOB statement for a full description.

PROJECT

Specifies the project name. See the $JOB statement for a full description.

BILLING

Specifies the name used for accounting control within the PROJECT. The name may beup to 12 characters, the first of which must be alphabetic or numeric, the others may bealphanumeric, hyphen or underscore. The default value is the value specified for thisPROJECT in the site catalog or, failing that, the project-name is used as the billing-namein the job report banner.


47 A2 11UJ Rev04 4-35

WARNING

The BILLING parameter is mandatory in the $JOB statement if there isno default value given in the site catalog.

TYPE

Specifies the format of the member to be loaded. DATA means that the records loadedwill not contain SSF headers nor will there be control records. DATASSF means that therecords loaded will contain SSF headers and that there will be control records. The othervalues refer to language types and are described under the MOVE command in theLibrary Maintenance Reference Manual.

FORMAT

Defines the position of the line number and the text on a record. The four values specifythe starting position of the line number, the ending position of the line number, startingposition of the text and ending position of the text, respectively. Zero values for the linenumber means that there are no line numbers. Line numbers, if given, must be rightjustified and blanks are treated as zeros.

This parameter applies only if TYPE=DATASSF. If this parameter is omitted the default istaken as the FORMAT corresponding to TYPE. This is specified in the LibraryMaintenance Reference Manual.

END

Specifies the format of the statement which marks the end of the input data to be stored.The value ENDDATA, which is the default, means that input data ends at the recordbefore the first $ENDDATA statement that is encountered. If END='string8' has beenspecified, then the last input record stored is the one before the first occurrence of arecord which contains only this string, starting in the first position. If END=EOF isspecified, the last record stored is the last record of the input stream (that is, the onebefore the $EOF). The record which contains $ENDDATA, END='string8', or END=EOF isnot loaded into the output library. Its character representation must be EBCDIC.

ENDCHAR

The character specified by this parameter is considered as an end of record delimiter if itis the last significant character encountered on an input record. Neither the character itselfnor the trailing blanks will be loaded in the output record. See $INPUT for examples of theuse of this parameter.


4-36 47 A2 11UJ Rev04

CONTCHAR

The character specified by this parameter is considered as a continuation mark if it is thelast significant character encountered on an input record. The next record read isconcatenated with the record that contained the continuation character. Neither thecontinuation character nor its trailing blanks are included in the concatenation. See$INPUT for examples of the use of this parameter.

RECSIZE

Specifies the record size. This can be specified only if the input comes from a KDSterminal and in this case its default value is 110. It is ignored for any other type of input.

REPLACE

If the data being loaded is to replace the contents of an existing member of the outputlibrary, the parameter REPLACE must be specified. This parameter should not bespecified if the member name does not exist on the output library.

PRINT

Requests the printing of the records on the JOR. Up to 500 records may be printed.

CKSTAT

This parameter is necessary if any $SWINPUT statements are to appear and beinterpreted in the data-enclosure.

Example:

$DATA SALES*, TOTAL, USER=ACCOUNT, PROJECT=TURNOVER TYPE=DATA, PRINT;

X X X X X X |. . . . . . . |. . . . . . . | input data. . . . . . . |X X X X X X |

$ENDDATA;

If the above is run on July 20th, 1991 at 2:55 and 10 seconds p.m. (14.55.10 on 20 JULY1991) then the input data is loaded as member SALESD910720-145510 of the permanentlibrary TOTAL. This member did not exist before the run. The input data records areprinted.


47 A2 11UJ Rev04 4-37

Example:

$DATA ABC, PROGLIB, USER=PROG, PROJECT=DEVELMT TYPE=JCL, FORMAT=(0, 0, 1, 80) REPLACE, PRINT;

X X X X X X |. . . . . . |. . . . . . |. . . . . . | input data. . . . . . |. . . . . . |X X X X X X |

$ENDDATA;

Before this run the member ABC exists in the permanent library PROGLIB. This examplereplaces the contents of ABC with the input data supplied. The input data consists of JCLstatements in record positions 1 to 80 and there are no line numbers. The input datarecords are printed.

Example:

$DATA ACCT, LIBRARY, USER=CHIEF, CKSTAT;

X X X X X X |. . . . . . |. . . . . . |. . . . . . | data A. . . . . . |. . . . . . |X X X X X X |

Contents of File DATA FILE

$SWINPUT DATA-FILE; X X X X X X | . . . . . . | . . . . . . | . . . . . . | data B . . . . . . | . . . . . . | X X X X X X |X X X X X X |. . . . . . |. . . . . . |. . . . . . | data C. . . . . . | End of File : DATA -FILE. . . . . . |X X X X X X |

$ENDDATA;

The data is to be loaded into the new member ACCT of the library file named LIBRARY.The presence of the parameter CKSTAT advises the Stream Reader to look for$SWINPUT statements in the data-enclosure and to give effect to each as encountered.

The data loaded is as follows: data A - data B - data C.


4-38 47 A2 11UJ Rev04

4.7 DEFINE

4.7.1 Function

Requests file journalization, specifies checkpoint positions on files and file processingperformance parameters. Overrides and complements file parameters in a user programand/or in certain JCL statements; complements the file description in a file label.

4.7.2 Enclosure

Step.

4.7.3 Format

DEFINE internal-file-name

[JOURNAL = {AFTER }] [ {BEFORE}] [ {NONE }] [ {BOTH }]

[CKPTLIM = {digits8 [EOV]}] [ {NO }] [ {EOV }]

[NBBUF = digits5]

[BPB = digits3]

[{SYSOUT }] [{NSYSOUT}]

[ERROPT = {SKIP }] [ {ABORT }] [ {IGNORE }] [ {RETCODE}]

[WRCHECK]

[OPTIMIZE]

[{BPIOC}] [{FRIOC}]

[{RAHEAD}]

[{KEYLOC = digits5}] [{INKEYLOC = digits5}]


47 A2 11UJ Rev04 4-39

[{DLREC }] [{TRUNCSSF}] [{NDLREC}] [{NTRNCSSF}]

[{COMPACT }] [{NCOMPACT}]

[FPARAM]

[LTRKSIZE = digits5]

[FILEORG = {SEQ }][ {RELATIVE}][ {INDEXED }][ {LINKQD }][ {NONE }]

[KEYSIZE = digits3]

[CISIZE = digits5]

[CIFSP = digits2]

[BUFPOOL = alphanum4]

[READLOCK = {NORMAL}] [ {EXCL }] [ {STAT }]

[LOCKMARK]

[FILEFORM = {UFAS }] [ {ANSI }] [ {NSTD }] [ {LINKQD}] [ {NONE }]

[BLKSIZE = digits5]

[RECSIZE = digits5]

[RECFORM = {F }] [ {V }] [ {U }] [ {FB }] [ {VB }]

[FUNCMASK = hexa 8]

[BLKOFF = digits3]

[{CONVERT }][{NCONVERT}]

[DATACODE = {BCD }][ {ASCII }][ {EBCDIC}]

[COLLATE = {BCD }][ {ASCII }][ {EBCDIC}]


4-40 47 A2 11UJ Rev04

[{BSN }][{NBSN}]

[NSORTIDX]

[{PRINTER = (printer-options) }][{TN = (terminal-options)}]

Where printer-options have the form:

[{SLEW}][{NSLEW}]

[MARGIN = digits3]

[PRDEN ={6}][ {8}]

[FORMHT = digits3]

[HOF ={digits3}][ { 1 }]

[FF1 ={digits3 }][ {value of FORMHT}]

[FF2 ={digits3}][ { 0 }]

[CHi = (digits3 [digits3] ...)]

Where terminal-options have the form:

[{PROMPT = char12}][{NPROMPT }]

[EOF = char4]

[{MSG }][{NMSG}]

[{SLEW }] [{NSLEW}] [MARGIN = digits3] [PRDEN ={6}] [ {8}] [FORMHT = digits3]

[HOF ={digits3}] [ { 1 }]

[FF1 ={digits3 }] [ {value of FORMHT}]

[FF2 ={digits3}] [ { 0 }]

[CH1 = (digits3 [digits3] ...)]


47 A2 11UJ Rev04 4-41


The DEFINE statement is used to request the activation of the JOURNAL facility, tospecify checkpoint positions on files and to specify file processing performanceparameters (for example, number of buffers).

The DEFINE statement is also used to override and complement specified file parametersin the corresponding description of the file in the user program and to override andcomplement certain JCL statements, particularly for input and output handling. There areno default values for the parameters within the DEFINE statement. If a parameter is notspecified, its corresponding value, where one exists, in the file description or in the JCL isnot overridden.

For each DEFINE statement except for those associated with standard SYSOUT files,there must be a corresponding ASSIGN statement preceding the DEFINE in the samestep enclosure.

A DEFINE statement associated with the first file of a sequence of concatenated files isalso applied to the others in the sequence. A DEFINE statement may be linked only to thefirst file of a concatenated set as the others do not have unique internal-file-namesthrough which DEFINE could reference them.

The overriding is applied to the file with the specified internal-file-name at the time that thefile is opened. The overriding is effective until the file is deassigned. However, DEFINEdoes not override the contents of the file label (for a disk file, or for tape file opened ininput or append mode), unless the parameter FILEFORM=NSTD applies.

In the case of non-cataloged tape files being processed in output mode, file levelinformation does not override DEFINE statement parameters.

A DEFINE statement associated with a standard SYSIN subfile is ignored.

In general, there is no checking of a specified value against the access method that isused in the program. As a result, some parameter specifications may be useless and willbe ignored.

For example:

• the relationship of the values given in a DEFINE statement with those given in thecorresponding COBOL program is not examined for consistency;

• NBBUF may specify more or fewer buffers than are specified in the program's filedefinition. If more buffers are specified, an abnormal termination of the step may result.


4-42 47 A2 11UJ Rev04

4.7.5 Parameters


internal-file-name

Specifies the file to which the overriding is to apply. Internal-file-name must not exceedeight alphanumeric, hyphen and underscore characters.


JOURNAL

Records images of data blocks on a journal (file or files) which are used in conjunctionwith the Checkpoint/Restart facility (see Section 1). The journal image is used to returnthe data blocks to a pre-abnormal- termination state.

If the file is being processed in input mode (that is, ACCESS=READ, SPREAD, orALLREAD), journals are not used.

AFTER The data block images are those which existed on the Afterjournal (that is, the user records after they have beenmodified). This applies to UFAS and IDS/II files.

BEFORE The data block images are those which existed on the BeforeJournal prior to any modification of the data since the lastcheckpoint was taken. UFAS, and IDS/II files are supported.

NONE No journal file is produced.

BOTH Both the AFTER and BEFORE journals are produced. Thisapplies to UFAS and IDS/II files.

The type of journal to be used in processing a file can be stored in the catalog. In suchcases, if a JOURNAL value is specified in the DEFINE statement, the following rulesapply.

Rule 1: This rule applies if Access Rights have not beenimplemented, or if they have been implemented and the userhas at least the RECOVERY access right (that is,RECOVERY or OWNER) on the file concerned). The rule isthe following. The DEFINE value is effective (that is, DEFINEoverrides the catalog).


47 A2 11UJ Rev04 4-43

Rule 2: This rule applies if Access Rights have been implementedand the user does not have the RECOVERY access right(that is, his access right is LIST, EXECUTE, READ, orWRITE) on the file concerned. The DEFINE value is effectiveonly if the DEFINE offers the same, or more, protection asthe one stored in the catalog. that is:

The DEFINE value is The Result isthe same as catalog value OKBOTH OKAny value or catalog value does not exist OKAll other cases Not OK in ASSIGN or DEFINE depending

on the sequence DEFINE --> ASSIGN orASSIGN --> DEFINE

CKPTLIM

Defines when an automatic checkpoint must be taken. It is independent of a COBOLprogram (which has CALLS to the checkpoint mechanism). The possible values are :

NO No checkpoint is taken.

EOV For a multivolume disk or tape file in the situation where allvolumes where not mounted initially, this value specifies thata checkpoint is taken at the end of each volume.

digits8 This value gives the frequency of checkpoints (that is, acheckpoint is taken once every digits8 records). Note thatEOV may be specified simultaneously in this case.

If monitored files are used by the COBOL step, then an automatic commit is taken insteadof a checkpoint. For further information about checkpoints, refer to the GAC-ExtendedUser's Guide, Section 3.3.6.

NBBUF

Specifies the number of buffers to be assigned to the file.

BPB

Specifies the number of blocks per buffer (up to 255).


4-44 47 A2 11UJ Rev04

SYSOUT

The specification of this parameter forces the use of the SYSOUT mechanism for thewriting of a file, provided the file characteristics (RECSIZE) are acceptable - see theSYSOUT statement. This parameter can be used, for example, where the clause ASSIGN... TO ... -SYSOUT does not appear in a COBOL program.

NOTE: The use of SYSOUT in DEFINE is equivalent to the specification -SYSOUT inCOBOL.

NSYSOUT

The specification of this parameter overrides any request for the SYSOUT mechanism(for example, in the program or in the SYSOUT statement). The SYSOUT mechanism willnot be used to write the file. This is required if you wish to prevent the system from usingthe SYSOUT mechanism for the creation of an uncataloged permanent SYSOUT file onmagnetic tape (the use of the SYSOUT mechanism here would force a record size ofmore than 600 bytes, unless TAPE=NSYSOUT has been specified in the CONFIGstatement OWDFLT).

ERROPT

Specifies the action the system takes when an input/output error occurs.

SKIP Applies only in sequential mode and means the record isignored.

ABORT The step is aborted (SEV=3).

IGNORE Applies only to tapes. The I/O failure is ignored and the datareturned is the part of the record which has been read,padded on the right with conventional characters. IfSEQUENTIAL or DYNAMIC access is being used, the currentrecord pointer points to the next valid record.

RETCODE The system produces an abnormal return code signalling anI/O error (for example, IOFAIL). No further processing of thefile is possible. The current record pointer is undefined incases where SEQUENTIAL or DYNAMIC access is beingused.

WRCHECK

Specifies that each block written to the file is verified at the time of writing (for queued filesonly).

OPTIMIZE

Enables fast read and write access mode, for UFAS sequential files. For furtherinformation, refer to the Batch Booster User's Guide.


47 A2 11UJ Rev04 4-45

BPIOC

If BPIOC is specified, file caching is bypassed. This parameter overrides all other cacheoptions specified in the catalog or assignment parameters. For more information on filecaching, refer to the Large Memory Cache User's Guide.

FRIOC

If FRIOC is specified, file caching is carried out. This parameter overrides all other cacheoptions specified in the catalog or assignment parameters. For more information on filecaching, refer to the Large Memory Cache User's Guide.

RAHEAD

By default, for cached files with sequential organization, the "read-ahead technique" isused when a file block is first referenced, so that the next 16 file blocks are also read. TheRAHEAD parameter can be used to force the read-ahead technique to be used, whetherthe file organization is sequential or not. For more information on file caching, refer to theLarge Memory Cache User's Guide.

KEYLOC

Applies to UFAS indexed files. KEYLOC defines the relative position (from the left) in therecord of the first character of the data record key. The first byte of the record is byte 0.

NOTE: There is a difference of 1 byte between the KEYLOC described in the DEFINEbasic JCL statement or in the OUTDEF parameter group, and the KEYLOCdefined in the PREALLOC statement. For DEFINE and OUTDEF, the first byteof a record is byte 0; for PREALLOC, the first byte of a record is byte 1.

DLREC

Deleted records (those beginning with "FF"X are considered to be deleted) are allowed inqueued files.

NDLREC

Deleted records are not allowed in queued files.

TRUNCSSF

The SSF header and SSF control records are suppressed.

NTRNCSSF

The SSF header and SSF control records are not suppressed.


4-46 47 A2 11UJ Rev04

COMPACT

Records must exist in compacted form on the media.

NCOMPACT

Records must exist in non-compacted form.

FPARAM

Forces the overriding of certain values by parameters specified in the DEFINE statement.

LTRKSIZE

The logical track size of the file.

FILEORG

Defines the file organization (access method).

Abbreviation File OrganizationSEQ SequentialRELATIVE RelativeINDEXED IndexedLINKQD Queued linkNONE None

KEYSIZE

Gives the length in bytes of the record key. The maximum value allowed is 255.

CISIZE

For UFAS files, this gives the size in bytes of the control interval.

CIFSP

For UFAS indexed files; gives the control interval free space as a percentage.

BUFPOOL

For a UFAS disk file, BUFPOOL identifies a "pool" of buffers (a group of buffers with thesame name) used for the file.


47 A2 11UJ Rev04 4-47

READLOCK

Applies only if SHARE=MONITOR has been specified for a UFAS, or IDS/II disk file. Itdefines the lock protocol that you wish to apply. The locks apply at the CI level (not the filelevel) and are freed at the end of the commitment unit in which they are applied. For moredetails see the GAC-Extended User Guide. The possible values are as follows:

NORMAL While a CI is being shared under this lock, the following canaccess it simultaneously.(i) (a) Several NORMAL readersor

(b) One NORMAL writerAND(ii) Several STAT readersAND(iii) No EXCL user (whether reader or writer)

EXCL While a CI is being shared under this lock, the following canaccess it simultaneously:(i) (a) One EXCL readeror

(b) One EXCL writerAND(ii) No NORMAL user (whether reader or writer)AND(iii) Several STAT readers.

STAT While a CI is being shared under this lock, the following canaccess it simultaneously:(i) (a) Several NORMAL readersor

(b) One NORMAL writerOR(ii) (a) One EXCL readeror

(b) One EXCL writerAND(iii) Several STAT readers

Using the normal Boolean convention, these rules may be summarized as follows:

NORMAL is (ia OR ib) AND (ii) AND (iii)

EXCL is (ia OR ib) AND (ii) AND (iii)

STAT is (ia OR ib) OR (iia OR iib) AND (iii)

NORMAL and EXCL are mutually exclusive for a given CI at any time. STAT readers canalways read and are not concerned that updating is taking place while they do so.

LOCKMARK

Applies only if SHARE=MONITOR is specified for a UFAS disk file.The current recordpointer may be retained between consecutive commitment units.

For more details, see the GAC-Extended User's Guide.


4-48 47 A2 11UJ Rev04

FILEFORM

Describes the file. Most formats are self-explanatory.

UFAS applies to UFAS files.

LINKQD applies to queued link files.

ANSI applies to an ANSI magnetic tape file, written in ASCII datacode.

NSTD the tape file format is unknown. Data is delivered by blocks,including tape marks. Labels are not processed by the OPENand CLOSE routines.

NONE The file format is not defined.

BLKSIZE

Specifies the block size in bytes.

RECSIZE

Specifies the record size in bytes.

RECFORM

Specifies the format of the record.

Abbreviation Record FormatF Fixed record formatV Variable record formatU Undefined record formatFB Blocked fixed record formatVB Blocked variable record format


47 A2 11UJ Rev04 4-49

FUNCMASK

Used to specify the tape controller capabilities, pack/depack options for UFAS tape files.In particular, the FUNCMASK parameter is used for nonstandard tape files for which themessage "MEDIA RECOGNITION IMPOSSIBLE" has been generated by GCOS. Thespecified mask, containing eight hexadecimal characters, is loaded in the Magnetic TapeController when the file is opened. See the UFAS User's Guide for details.

BLKOFF

Allows the program to bypass any unwanted information present on certain magnetic tapefiles at the beginning of each block. It applies in particular to ANSI (version 1) tape files.The specified value defines the size of the unwanted data (the block offset) andcorresponds to the relative position in each block of the first byte of required data.

NOTE: The value of BLKSIZE must include the block offset, if any.

CONVERT

Data code is converted for tapes.

NCONVERT

Data code is not converted for tapes.

DATACODE

Defines the data code. Possible values are: BCD, ASCII and EBCDIC.

COLLATE

Specifies the collating sequence in the case of UFAS disk files. The possible values are:BCD, ASCII and EBCDIC.

BSN

Block serial numbers are to exist on a tape file.

NBSN

Block serial numbers are not to exist on a tape file.


4-50 47 A2 11UJ Rev04

NSORTIDX

Disables the updating of secondary indexes of UFAS indexed files in UPDATE processingmode. In this case SORT_INDEX utility must be executed after the close of the file torestore it safely, because file status is unstable.

PRINTER=printer-optionsTN=terminal-options

These options are described in the following sub-sections.

Printer Options

The following options allow you to specify editing parameters for files to be printed:

SLEW

Any paper move instructions (slew control) are obeyed when the file is printed.

NSLEW

When the file is printed by the Output Writer, every skip function is transformed to "skip tonext line": (that is, for this statement each paper move instruction is reduced to a move tothe next line).

MARGIN

Specifies the number of blanks that are to be inserted at the beginning of each line ofprint. The default value is 0 (zero). The value that can be specified is limited by themaximum line width of the printer that is used.

PRDEN

This specifies the vertical print density as six or eight lines per inch. The default value isthe value given by the form number in MEDIA, or, if MEDIA is not specified, the defaultvalue is that of the installation's default printer.

The FORMHT parameter is specified in lines per page. Thus, if a page is defined tocontain n lines, it will cover n/6 inches if PRDEN=6 is given, or n/8 inches if PRDEN=8appears. If PRDEN is to be used to increase the use of the paper, the FORMHTparameter must be changed accordingly. For example, if PRDEN=6 and FORMHT=54,the page occupies 9 inches. If PRDEN is to be changed to PRDEN=8 then FORMHTshould be changed to FORMHT=72 to maintain the use of all 9 inches. Otherwise, the 54lines would occupy about 7 inches.


47 A2 11UJ Rev04 4-51

FORMHT

Specifies the form size as a number of lines. The maximum value is 255. See PRDENabove.

HOF

Head of form: this gives the line number of the first line to be printed on the page. Themaximum value is 255, but see the note below.

FF1

First level of full form; this gives the line number of the last line to be printed on the page.The maximum value is 225, but see the note below.

FF2

Second level of full form: when this line is reached or passed, a return code message isproduced. The maximum value is 225, but see the note below.

NOTE: The following restrictions apply to the values of the form control options:

1 <= HOF <= FF2 <= FFF1 <= FORMHT

CHi

The Vertical Format (VF) tape of a printer is a physical loop containing channels that arepunched in a certain position, to control vertical paper movement. Since DPS7000 printersdo not have VF tapes, vertical paper movement is controlled by a simulated verticalformat unit (VFU). This VFU functions in the same way as a standard 12-channel VF tape,with a limitation of 20 stop levels per form, shared among the 12 channels. For each CHi(where i is a number between 1 and 12) you can specify one or more stop levels, inincreasing order. Each stop level gives a line number (up to 3 digits) whose value must beless than or equal to the value of FORMHT. The maximum number of stop levels for allthe CHi entries is 20.

Example:

CH1=(10, 25, 50), CH2=(5, 15)

This specifies stop levels at lines 10, 25, 50 on channel 1 and lines 5 and 15 onchannel 2.

Terminal Options

The file exists on a terminal. The following options allow you to specify parameters forterminal files. For more details see the IOF Terminal User's Manual.


4-52 47 A2 11UJ Rev04

PROMPT

This parameter defines a prompting message of maximum length 12 characters.

NPROMPT

No prompting will be used.

EOF

This parameter defines a string of four characters used to indicate the end of file in inputmode.

The rest of the TERMINAL options have the same meaning as the PRINTER options ofthe same name.

NMSG

All messages to the console by any other agent than the interactive step are held until thefile is closed.

MSG

Messages to the console are not held.


47 A2 11UJ Rev04 4-53

4.8 $ENDDATA

4.8.1 Function

Terminates the input data after a $DATA statement.

4.8.2 Enclosure

Outside a job.

4.8.3 Format

$ENDDATA;


This statement closes the input data enclosure after a $DATA statement when the ENDparameter was not specified on the $DATA statement. The record containing $ENDDATAis not treated as an input data record to be loaded by $DATA. The $ sign is mandatoryand must be located in the first position of the record. The entire $ENDDATA statement,including the semicolon, must be on one record.


4-54 47 A2 11UJ Rev04

4.9 $ENDINPUT

4.9.1 Function

Terminates an input enclosure.

4.9.2 Enclosure

Job.

4.9.3 Format

$ENDINPUT [input-enclosure-name];


The $ENDINPUT statement marks the end of an input enclosure (See $INPUTstatement). When the statement is recognized by the stream reader, the SYSIN subfilecontaining the input enclosure records is closed.

The $ sign must be present and must be located in the first character position of therecord.



This is meaningful only if the END=MATCH parameter was declared in the $INPUTstatement corresponding to this $ENDINPUT statement. If both input-enclosure-namesmatch, the $ENDINPUT is considered to be the closing statement of the input enclosure.

The $ENDINPUT statement is treated as data contained in the current input enclosure ifthe input-enclosure-name is not identical to one specified in a previous $INPUTstatement.


47 A2 11UJ Rev04 4-55

4.10 $ENDJOB

4.10.1 Function

Terminates a job enclosure.

4.10.2 Enclosure

Job.

4.10.3 Format

$ENDJOB;


The $ENDJOB statement must appear as the last statement of a job which starts with a$JOB statement. Jobs submitted with the RUN statement or the EJR operator commanddo not necessarily require a $JOB statement. If $JOB is omitted, then $ENDJOB is notnecessary. When a job is being submitted to the system, the statement is recognized bythe Stream Reader, which closes the file containing the source JCL statements (see$JOB statement).

If the $ENDJOB statement is required but omitted, then the JCL is translated but the job isaborted. A Job Occurrence Report is produced after JCL translation is terminated.

The $ sign must be present and must be located in the first character position of therecord. The entire $ENDJOB statement must be on one record.


4-56 47 A2 11UJ Rev04

4.11 ENDSTEP

4.11.1 Function

Requests execution of the load module named in the corresponding STEP statement.This is the last statement in the step enclosure.

4.11.2 Enclosure

Step.

4.11.3 Format

ENDSTEP;


The ENDSTEP statement must appear as the last statement of a step enclosure. Stepenclosures are discussed in the STEP statement description. At job execution time, theENDSTEP statement terminates step initiation procedures (resource allocation) andrequests the execution of the load module (program) named in the corresponding STEPstatement.


47 A2 11UJ Rev04 4-57

4.12 EXDIR

4.12.1 Function

Defines steps to execute main-operator commands in GCL format for a job running inbatch mode.

4.12.2 Enclosure

Job.

4.12.3 Format

EXDIR 'command[;command]...';


The main-operator commands described in the System Operator's Guide may besubmitted this way if the batch job is running under a project that has the attribute MAIN.When this is not the case, only the IOF directives described in the IOF TerminalReference Manual may be executed. The maximum length of the command-string is 255bytes. Commands in the command string are separated by a semi-colon (;). The GCLdirectives MWINLIB BIN, BYE and EXDIR may not be executed with EXDIR. The imageof the submitted commands and the error messages (if any) is provided in the JobOccurrence Report.


4-58 47 A2 11UJ Rev04

4.13 EXECUTE

4.13.1 Function

Translates and executes a stored sequence of JCL statements during step execution.

4.13.2 Enclosure

Job.

4.13.3 Format

EXECUTE {[INFILE =] {sequential-input-file-description) } { } { member-name [INLIB =] (input-library-description)}

[VALUES = ([parameter-value 1] [parameter-value2] ] [ [keyword1 = keyword-value 1] ] [ [keyword2 = keyword-value 2] .. ] )]

[PRTFILE = (print-file-description)] [ [PRTDEF = (define-parameter)] ]

[PRTOUT = (sysout-parameters)]

[SIZEOPT = (size-parameters)]

[STEPOPT = (step-parameters)] ;


The EXECUTE statement creates a job step that uses the JCL Translator at job executiontime to translate a stored sequence of JCL statements. After translation, these statementsare submitted for execution. Once the statements have been executed, processing of theoriginal job continues with the statement following the EXECUTE. The effect of EXECUTEis to dynamically invoke, during job execution, a set of JCL statements.

A JCL sequence handled by the EXECUTE statement may contain other EXECUTEstatements. The effect of the execution of each one is to do a JCL translation and then toexecute the translated statements.

The JCL sequence can also refer to input enclosures contained in the original jobdescription and can accept parameter values from the EXECUTE statement (the VALUESparameter).


47 A2 11UJ Rev04 4-59

For each EXECUTE statement, a JCL translation report is produced. By default, thisreport is printed as a standard SYSOUT file, but you may request that it be stored in aspecified file.

NOTE: EXECUTE defines an entire step, but is considered as part of the basicoperating system and treated in this manual as a Basic JCL statement.


It is important to distinguish between INVOKE, a statement interpreted at JCL translationtime, and EXECUTE, a statement activated at execution time. INVOKE is static in thesense that a sequence of JCL statements is inserted into a job description at translationtime and thus becomes part of the job description. EXECUTE is dynamic since thesequence to be executed is not identified and translated until execution time and, oncethe sequence has been executed. It has no further significance to the job description thatcontains the EXECUTE statement. The first three comments/restrictions below are aresult of this basic difference between the two statements.

If a particular EXECUTE statement is executed several times in a job (for example, bymeans of a JUMP statement), it is possible for a different version of the sequence to becreated each time (for example, if the file that contains the sequence is modified betweeneach execution of the EXECUTE statement).

The library search path, if any, defined in the job that contains the EXECUTE statement isnot available when the stored statements are executed. If a library search path is required(for example, for the execution of a LIBMAINT statement contained in the JCL sequence),it must be declared within the sequence itself (by means of the Library Managementstatement LIB).

No PREFIX statement present in the original job is valid within the stored sequence.Therefore, if the job's PROJECT identification is not to be used as the prefix within thesequence, a PREFIX statement must be specified there.

The sequential file that contains the sequence to be translated and executed must be ineither DATA or DATASSF format.

The statements recognized by the Stream Reader ($JOB, $ENDJOB, $INPUT,$ENDINPUT, $DATA, $ENDDATA, $SWINPUT) must not appear inside a JCL sequencecalled by EXECUTE. Therefore, the sequence must not contain input enclosures.

The sequence must contain one or more complete step enclosures. Extended JCLStatements (including ATTACH, EXECUTE and RUN, but not including SORTWORK)can be considered as complete step enclosures.

If a warm restart occurs during the execution of the EXECUTE statement, the restart isalways done from the beginning of the step (that is, the entire translation is repeated). If awarm restart occurs during the execution of the translated sequence, the standard repeatrules apply (see the System Administrator's Manual).

If an error occurs during translation of the JCL sequence, the system sets the stepseverity to 4. The abnormal termination of the job can be avoided by means of a JUMPstatement with a suitable SEV value (see JUMP).


4-60 47 A2 11UJ Rev04

4.13.5 Parameters


sequential-input-file-description

Identifies the file that contains the JCL sequence to be EXECUTED. The format is givenin Section 2. The file must be in DATA or DATASSF format.


VALUES

Specifies the parameter values that will be passed to the JCL sequence. See the INVOKEstatement for a description of the parameter.

PRTFILE

The print-file-description identifies the permanent SYSOUT file which will contain the JCLTranslator report. If this parameter is omitted, the report is sent to a standard SYSOUTsubfile. The format is the same as for sequential-file-description above, with the addition,optionally, of the EXPDATE and DENSITY parameters (see ASSIGN); furthermore, thedefault value of the ACCESS parameter is WRITE.

PRTDEF

Allows you to specify editing parameters for the SYSOUT file identified by the PRTFILEparameter. The parameters of the parameter group define-parameters are listed anddescribed in Section 3.

PRTOUT

Allows you to specify output handling parameters for the SYSOUT file identified by thePRTFILE parameter. Any of the parameters of the SYSOUT statement (except theinternal-file-name) may be specified for the parameter group sysout-parameters. Theseare described in Section 3.

SIZEOPT

Allows you to specify size-parameters which are listed in Section 3 and described underthe SIZE statement.


47 A2 11UJ Rev04 4-61

STEPOPT

Allows you to specify parameters to control the execution of the EXECUTE step-definingstatement. Any of the STEP parameters, except DUMP=ALL, DEBUG and the OPTIONSparameter, may be specified for the parameter group step-parameters.

Example 1:

EXECUTE (EXEC.LIB, SUBFILE=SEQ1), VALUES =(X12, FILE=MY.LIB);

The effect of the above example is to translate, at step execution time, the JCL sequencestored in member SEQ1 of library EXEC.LIB, substituting the value X12 for everyoccurrence of &FILE, and to execute the translated statements.

Example 2:

EXECUTE JCLSEQ.EXFL, STEPOPT=(DUMP=DATA, LINES=50);

The above statement will translate the JCL sequence stored in the cataloged fileJCLSEQ.EXFL and introduce the translated statements for execution. A limit of 50 lines ofprinter listing will apply to the EXECUTE step (that is, to the translation of the sequence),if the EXECUTE step terminates abnormally, the system will dump the data segments.


4-62 47 A2 11UJ Rev04

4.14 $INPUT

4.14.1 Function

Opens an input enclosure and names the SYSIN subfile into which the records of theenclosure are to be stored.

4.14.2 Enclosure

Job.

4.14.3 Format

$INPUT input-enclosure-name

TYPE =[{DATA }] [{COBOL }] [{RPG }] [{FORTRAN}] [{JCL }] [{COBOLX }] [{GPL }] [{DATASSF}]

[FORMAT = (digits3, digits3, digits3, digits3)]

[END = {ENDINPUT }] [ {DOLLAR }] [ {EOF }] [ {MATCH }] [ {'string8'}]

[ENDCHAR = 'string1']

[CONTCHAR = 'string1'}

[PRINT] [CKSTAT]

[{CVALUES}] [{JVALUES}]

[INFILE ={(diskette-file-name }] [ { { * } }] [ {MEDIA ={(volume-name [volume-name] ...)})}];


47 A2 11UJ Rev04 4-63


The $INPUT statement, together with a corresponding $ENDINPUT statement, are theboundary statements of an input enclosure. An input enclosure allows data or processor-specific commands to be included inside a job description. This data is either input to auser program or system utility, or it may be a source program, which is the input to acompiler (see the TYPE parameter).

The $INPUT statement is recognized by the Stream Reader. The data that is read isstored in a temporary subfile of the system SYSIN file. Each SYSIN subfile is identified bythe input-enclosure-name which is given in the $INPUT statement.

The $ sign must be present and must be located in the first character position of therecord.

An input enclosure may occupy any position in the job enclosure other than within a stepenclosure. Furthermore, one input enclosure may be made available to any number ofsteps in a job.

The ASSIGN statement for an input enclosure has the form:

ASSIGN internal-file-name, *input-enclosure-name;


Input-enclosure-names must be unique within a job enclosure.

The total number of input enclosures and ASSIGN statements (including the ASSIGNstatements for input enclosures) must not exceed 31 in any step.

No more than 252 input-enclosure files in JCL, or 251 input-enclosure files in GCL, maybe associated with a particular job. Note that a single definition of an input enclosure (thatis, the data records between $INPUT and $ENDINPUT) can give rise to more than oneinput enclosure, if input enclosure parameter substitution is used (see below).

Use of Parameter Substitution in Input Enclosures

An input enclosure can contain parameter references (of the form "&string") that aredefined in the current job description within one or more SET_VALUES statements orMODIFY_VALUES statements. Parameter substitution can take place if (and only if)either the JVALUES parameter is specified in the associated $INPUT statement.

Each time a reference to the input enclosure is encountered during JCL translation, a newversion of the input enclosure is created: each parameter reference is replaced by thevalue associated with it. The updated input enclosure will be used at execution time.

If CVALUES is specified in $INPUT, the system substitutes the values specified or appliesthem, by default, at the current level of nesting (see INVOKE). If JVALUES is used, thevalues that apply at the level of the job description (for example, as specified by a RUNstatement) are used, irrespective of the level of nesting of the associated ASSIGNstatement.

A detailed explanation of the use of parameter substitution in input enclosures is given inthe JCL User's Guide.


4-64 47 A2 11UJ Rev04

Restrictions

Whereas input enclosures containing parameter references can be associated (byASSIGN) with invoked JCL sequences, parameter substitution is not permitted within aninvoked input enclosure (see INVOKE).

Parameter substitution is permitted only within input enclosures of type DATA orDATASSF.

An input enclosure containing either of the parameters CVALUES or JVALUES cannot beused more than 31 times in ASSIGN statements of any number of steps.

Protection From Parameter Substitution

A contiguous sequence of records in an input enclosure can be "protected" from theparameter substitution mechanism: a record containing the five characters "//BOD"(starting in column 1) must precede the first record to be protected, and a recordcontaining the five characters "//EOD" in the first 5 columns must follow the last record tobe protected. Each time a version of the input enclosure is created, these two delimitingrecords are removed from the sequence, but no parameter substitution is made within thesequence.

This feature is particularly useful if an input enclosure contains MAINTAIN_LIBRARYediting statements, where & characters are not to be interpreted as parameter references(see the Text Editor User's Guide for details of the MAINTAIN_LIBRARY editing facilities).

Order of Application of Parameters

The parameters of the $INPUT statement are applied in the following order:

CKSTAT

If CKSTAT is specified then the $SWINPUT feature is applied first, except in the followingtwo cases:

(1) END=DOLLAR has been specified, in which case a $SWINPUT encountered in theinput enclosure is interpreted as the end of the input enclosure and not as a$SWINPUT statement.

(2) END='$SWINPUT' or END='$SWI' has been specified, in which case a $SWINPUTor a $SWI encountered in the input enclosure is interpreted as the end of the inputenclosure and not as a $SWINPUT statement, unless the $SWINPUT (or $SWI) andits parameters appear on the same record.


47 A2 11UJ Rev04 4-65

Example:

$SWINPUT XXXX END='$SWINPUT'; $SWINPUT FILE-A;

The second $SWINPUT statement above is treated as a $SWINPUT statement, andnot the end of the input enclosure. However,

$SWINPUT XXXX END='$SWINPUT'; $SWINPUT FILE-A;

the second $SWINPUT statement above is treated as the end of the input enclosureand not as a $SWINPUT statement, because its parameter is not on the samerecord.

CONTCHAR; and/or ENDCHAR

This feature is applied next.

FORMAT

Applied to the result of the preceding two features.

Parameterization

Input-enclosure parameterization is applied last.

4.14.5 Parameters



The name with which the programmer refers to the SYSIN subfile that contains therecords of the input enclosure. The name must not exceed 16 characters and may containletters, numbers (0-9) and the hyphen and underscore characters.

The input-enclosure-name must be unique within a job.


4-66 47 A2 11UJ Rev04


TYPE

Specifies the type (and implied format) of the input enclosure records. The types RPG,FORTRAN, JCL, COBOLX, GCL and GPL (and their implied formats) are described in theLibrary Maintenance Reference Manual. The other values are as follows:

DATA Data for a user program or system utility is entered with nomodification of the input format and no header added to thebeginning of each input record. This value can also be usedwhen COBOL or FORTRAN or RPG source statements areentered. If TYPE and FORMAT are omitted, DATA applies bydefault.

COBOL This can be used for a COBOL source program. An SSFheader is added to the beginning of each input record andprocessed automatically by the system.

DATASSF An SSF header is added to the beginning of each inputrecord and processed automatically by the system. Each datarecord is numbered (in the SSF header), starting at 10 withan increment of 10 for each record. An SSF control record isplaced at the beginning of the SYSIN subfile. If FORMAT isspecified but TYPE is not then TYPE defaults to DATASSF.This value can be used:- when input data to a COBOL object program is to be

ACCEPTED from SYSIN;- when RPG source statements are entered;- when FORTRAN source statements are entered.

FORMAT

Defines the format of the input records. If this is specified, then TYPE must not be DATAfor the output records. If FORMAT is not specified, then the default is the formatcorresponding to TYPE. These are listed in the Library Maintenance Reference Manual.The 4 values specify respectively:

• The location in the input record of the first digit of the line number. The first location in arecord is 1 and leading blanks are treated as zeros. If 0 is specified it means that thereare no line numbers.

• The location in the input record of the last digit of the line number. A value of 0 meansno line numbers are given.

• The location in the input record of the first text character.

• The location in the input record of the last text character.


47 A2 11UJ Rev04 4-67

END

Indicates to the input reader how the input enclosure is terminated, as follows:

ENDINPUT input enclosure terminated by the next $ENDINPUTstatement. This is the default value, if the input enclosure isnot stored on a separate diskette file.

DOLLAR input enclosure terminated by the next input record which hasa dollar sign ($) in column 1. The record is analyzed as arecord outside an input enclosure. The statements $HOL,$BIN and $MAP are exceptions. These statements areprocessed as part of the input enclosure.

EOF The input enclosure is terminated by the end of file conditionon a diskette file. This parameter can be specified only ifINFILE references a diskette file and it is also the defaultvalue in such a case.

MATCH input enclosure terminated by the first $ENDINPUT statementwhich specifies the input-enclosure-name in this statement.This permits the insertion of a complete input enclosurewithin the input enclosure defined by this $INPUT statementand its matching $ENDINPUT.

string8 The input enclosure ends with the first record which startswith this string. This terminator record is not treated as one ofthe input enclosure data records. Its character representationmust be EBCDIC.

ENDCHAR

Applies only to input enclosure records of DATA or DATASSF type. It can be used withinput enclosures where each record contains a particular character as its last non-blankcharacter. The character concerned is specified in the ENDCHAR parameter. Thischaracter and all trailing blanks will be removed from the input enclosure records. Thevalue supplied by ENDCHAR may be protected (that is, enclosed in single quotes). Notethat a blank may be specified as last-character. This character must be protected.

When ENDCHAR is specified, any record that does not contain the last-character in therequired character position is concatenated to the next record. This concatenationcontinues (up to the maximum record length of 256 characters) until a record thatcontains the specified character in the last non-blank position is encountered. In otherwords, ENDCHAR allows you to supply a particular character to signify the end of arecord.

WARNING

If ENDCHAR appears in $INPUT, the last record must contain thespecified character.


4-68 47 A2 11UJ Rev04

Examples of ENDCHAR:

In the following examples, the lower-case letter b is used to represent a blank character.

Example 1:

ENDCHAR=Q

record input (80 characters): 1234Q5678Qbb9bQbbb............b

record stored (14 characters): 1234Q5678Qbb9b

Example 2:

ENDCHAR='b'

record input (80 characters): bVENIbVIDIbVICIbbb............b

record stored (15 characters): bVENIbVIDIbVICI

Example 3:

ENDCHAR= / records input (80 characters): AAAbbb.................b BBB/bbb................b CCCbbb.................b DDD/bbb................b EEE/bbb................b

records stored: AAAbbb.................bBBB (83 characters) CCCbbb.................bDDD (83 characters) EEE ( 3 characters)

CONTCHAR

Applies only to records of DATA or DATASSF type. For each input record that containsthe specified character in the last non-blank character position, this character is deletedtogether with all trailing blanks, and the record is concatenated to the following one. Thecontinuation-character may be protected by single quotes. A record formed by the use ofCONTCHAR must not exceed the maximum length of 255 characters.


47 A2 11UJ Rev04 4-69

Examples of CONTCHAR

In the following example, the letter b is used to represent a blank character.

Example:

CONTCHAR=-

records input: ABCDE-FFF-bbbAXZ-bbb........b 12345-678-bbb999bbb...........b -XYZbbb...............b

records stored: ABCDE-FFF-bbbAXZ12345-678-bbb999bbb.......b -XYZbbb....................b

Examples of ENDCHAR and CONTCHAR Used Together

The parameters ENDCHAR and CONTCHAR may be combined in the same $INPUTstatement, provided a different character is specified for each one.

In the following examples, the letter b is used to represent a blank character.

Example 1:

CONTCHAR= -, ENDCHAR=9

records input: ABCD9b-bXZ-bbb........b XZZZ9b-bAB-9bbb..........b

record stored: ABCD9b-bXZXZZZ9b-bAB-

Example 2:

Consider the following input enclosure (80 characters per record):

$INPUT, CONTCHAR=+, ENDCHAR=/; AAAbbb....................b BBB/bbb...................b CCCbbb....................b DDD+bbb...................b EEE/bbb...................b FFFbbb....................b GGG+bbb...................b HHH/bbb...................b $ENDINPUT;


4-70 47 A2 11UJ Rev04

The following records are stored:

AAAbbb......................bBBB (83 characters) CCCbbb......................bDDDEEE (86 characters) FFFbbb......................bGGGHHH (86 characters)

WARNING

If the result of the use of ENDCHAR and/or CONTCHAR is a record oflength zero, the record is ignored.

PRINT

If this parameter is specified, the contents of the input enclosure are printed in thetranslation part of the Job Occurrence Report at job introduction time. Up to 200 inputrecords per job can be printed.

CKSTAT

If this parameter is specified, the Stream Reader checks each input enclosure record for a$SWINPUT statement. If such a statement is found, it is interpreted and executed.

CVALUES

Applies only to input records of DATA or DATASSF type. It specifies:

• that the input enclosure contains parameter references;

• that, at execution time, the system will use a version updated by the substitution ofparameter values that apply at the current invoked level within the job.

JVALUES

Applies only to input records of DATA or DATASSF type. It specifies:

• that the input enclosure contains parameter references;

• that, at execution time, the system will use a version updated by the substitution ofparameter values that apply at job level.

INFILE

Applies only to cases where the job description is stored on a diskette and it specifieswhere the input data records are to be found.

diskette-file-name

This is the external-file-name of the diskette file which contains the data records.


47 A2 11UJ Rev04 4-71

MEDIA=*

No specific diskette volume name is given. The first volume encountered which contains afile name which matches the diskette-file-name, is taken as the volume. The fileconcerned may be multi-volume.

MEDIA=(volume-name)

The file is to be searched for on the volume or volumes listed.

If the MEDIA parameter is omitted, then the file is searched for on the diskette volumethat contains the job description. By using the INFILE parameters, an input enclosure canbe retrieved from diskette files which may be on the same volume as the job descriptionor on subsequent volumes in the input stream. If an input enclosure is stored in amultivolume diskette file then only the volumes containing the first or the last extent maycontain job descriptions or other input enclosure files.

The only data retrieved from the intermediate volumes (that is, volumes which do notcontain the first or the last extent) of a multivolume diskette file is taken from the extentsof that file. No other files on these volumes are accessible during this process. A similarrestriction applies to concatenation of multi-extent diskette files (see File Concatenation inthe ASSIGN statement). If the END parameter has not been specified, then the inputenclosure is closed by $ENDINPUT or by the end of file condition.

Example 1:

$JOB MYJOB, USER=SMITH, PROJECT=Q141;

STEP MYPROG, (NEW.MYLIB, DEVCLASS=MS/M500, MEDIA=B015);

ASSIGN FILE1, *MYFILE;

SYSOUT PRTFILE;

ENDSTEP;

$INPUT MYFILE; . . .

data . . .

$ENDINPUT;

$ENDJOB;

In the above example, the input enclosure MYFILE contains data and ends with a$ENDINPUT statement.


4-72 47 A2 11UJ Rev04

Example 2:

If the job in the previous example was being read from a diskette then the $INPUTstatement could be as follows:

$INPUT MYFILE INFILE=(FILE1, MEDIA=(XYZ1,XYZ2,XYZ3));

The input enclosure data will be retrieved from the file FILE1 which will be searched for onthe volumes XYZ1, XYZ2 and XYZ3. The enclosure will end when a $ENDINPUTstatement is encountered or an end of file condition arises on FILE1.


47 A2 11UJ Rev04 4-73

4.15 INVOKE

4.15.1 Function

Inserts a sequence of JCL statements, stored in a source format as a member of a libraryor entered from an input enclosure, into the current job description.

4.15.2 Enclosure

Job.

4.15.3 Format

INVOKE {*input-enclosure-name1 } { member-name [{(input-library-description)}]} { [( SYS }]}

VALUES=( [parameter-value1 [parameter-value2]...] [keyword1=keyword-value1 [keyword2=keyword-value2]...])

[UPDATE=*input-enclosure-name2] [LIST = ALL];


The INVOKE statement requests that a JCL sequence in source format be entered from aJCL source library or from an input enclosure. If a label is defined inside an invokedsequence, this label cannot be referenced outside the invoked sequence. Furthermore, itis not possible to "jump" outside the invoked sequence. The same label can be definedboth inside and outside the sequence with no subsequent ambiguity. In addition, a LIBstatement in an invoked sequence applies only to that sequence.

An invoked sequence of JCL may contain other INVOKE statements. Up to nine levels of"nesting" are permitted and these invoked members can be stored in up to fifteenlibraries.

An invoked sequence must contain one or more entire step enclosures and cannotcontain an input enclosure, a $JOB statement, nor a $ENDJOB statement. The VALUESparameter allows parameter substitution in the invoked sequence, and the UPDATEparameter enables you to edit the invoked sequence before it is translated.


4-74 47 A2 11UJ Rev04

If the invoked sequence contains an assignment of an input enclosure whose $INPUTstatement specifies the CVALUES parameter, a new input enclosure will be created bythe substitution of the parameter values that apply currently to the invoked sequence (see$INPUT).

Temporary files and permanent files cataloged in private catalogs must not be used,unless the CATALOG is auto-attachable or unless the input stream is submitted using aRUN statement.

4.15.5 Parameters


input-enclosure-name1

The name of the SYSIN input enclosure which contains, in DATA or DATASSF format,the invoked JCL sequence. The corresponding $INPUT statement must not specifyCVALUES or JVALUES since parameter substitution is not allowed within an invokedinput enclosure.

member-name

Identifies the library subfile (member) containing the JCL statements to be entered. Thename must not exceed 31 alphanumeric, hyphen and underscore characters and muststart with a letter or a digit.


input-library-description

Identifies the user source library which contains the named member. See Section 3 for theformat of this parameter.

WARNING

If the library file is not resident (that is, it is not on the resident systemdisk), there is a possibility that the system will be unable to access thefile at JCL translation time (for example, if the volume containing thefile is not mounted); if this happens, the job will be aborted. Thissituation can be avoided by the use of an EXECUTE statement (seethe JCL User's Guide for more details).


47 A2 11UJ Rev04 4-75

SYS

SYS indicates the resident system library, SYS.HSLLIB. If alibrary-description is not specified, SYS applies by default.

VALUES

The parameter-value or keyword-value defines the actual value to be used in the invokedJCL sequence in place of the &i (1 < i < 99) or &keyword. This value may be a protectedstring (that is, any characters enclosed in single quotes except that a single quote insidethe string must be entered twice in succession) of up to 128 characters. A parameter-value in a string can be omitted by entering a comma in its place, resulting in twoconsecutive commas or two commas separated by one or more spaces.

Alternatively, if spaces are being used as separators, missing parameter values can beindicated by #. In this case, the corresponding value is an empty string; however, if aVALUES or MODVL statement exists within the invoked JCL sequence, it provides thedefault value for the omitted parameter.

If the parameter-value of a VALUES parameter is NIL, the &i or &keyword is not replacedand the corresponding parameter in the invoked JCL is ignored (even if a default value isstated in a VALUES or MODVL statement). Note that &0 and &00 are always replaced byempty strings.

Example:

If the INVOKE statement is: INVOKE SEQ4, SYS, VALUES=(MYFILE1,,NIL,TAPES=3);

and the member SEQ4 contains: ASSIGN TESTFILE, NEW.&1, &2, MOUNT=&TAPES; ........................ VALUES OLD.FIL, 'DEVCLASS=MS/M500,MEDIA=VOLA',TEMPRY; ........................ ASSIGN FIL2, &1, &2, &3;

the result will be: ASSIGN TESTFILE, NEW.MYFILE1, MOUNT=3; ......................... VALUES OLD.FIL, 'DEVCLASS=MS/M500,MEDIA=VOLA',TEMPRY; ......................... ASSIGN FIL2, MYFILE1, DEVCLASS=MS/M500,MEDIA=VOLA;

In the above example:

• the value of &2 in the first ASSIGN becomes an empty string.

• for the second ASSIGN, the values of &1 and &3 in the INVOKE (MYFILE1 and "NIL"respectively) apply; the stated values in the VALUES statement (OLD.FIL and TEMPRYrespectively) would have applied only if no corresponding values had been specified inthe INVOKE.

• the file with the external-file-name NEW.MYFILE1 in the first ASSIGN can be acataloged, passed, or RESIDENT file whereas the corresponding file in the secondASSIGN is an uncataloged file.


4-76 47 A2 11UJ Rev04

UPDATE

Specifies that the "Mini-Editor" commands stored in the input enclosure identified by*input-enclosure-name2 must be applied to the invoked JCL sequence before translation.The use of the Mini-Editor is described in the JCL User's Guide.

The corresponding $INPUT statement must not contain the CVALUES parameter or theJVALUES parameter (that is, parameter substitution not allowed within the inputenclosure). Note that the invoked JCL sequence may itself be an input enclosure.

Example 1:

INVOKE SEQ1, INV.LIB, VALUES=(X12, FILE=MY.LIB), UPDATE=*UP;

In the above example, the contents of member SEQ1 of the library INV.LIB are updatedaccording to the editing commands contained in input enclosure UP; then the VALUESreplacements are performed on SEQ1 and the final version is invoked into the current jobdescription.

Example 2:

INVOKE *CRDSEQ, UPDATE=*EDITS;

In the above example, the contents of input enclosure CRDSEQ are edited from thecommands in input enclosure EDITS and the result is invoked into the current jobdescription.

LIST=ALL

The source JCL and all expansions of JCL sequences are listed, along with errormessages.


47 A2 11UJ Rev04 4-77

4.16 $JOB

4.16.1 Function

Marks the beginning of a job enclosure and gives job identification.

4.16.2 Enclosure

Job.

4.16.3 Format

$JOB job-name

[USER = user-name]

[PROJECT = project-name]

[BILLING = billing-name]

[NSTARTUP]

[LIST = {SOURCE}] [ {NO }] [ {ALL }]

[JOR = {NORMAL}] [ {NO }] [ {ABORT }]

[CLASS = {identifier2}]

[{HOLD }] [{HOLD = digits2}]

[HOLDOUT]

[PRIORITY = digit1]

[RECSIZE = {110 }] [ {digits3}]

[REPEAT]

[HOST = {name4}] [JOBLANG = {GCL}] [ {JCL}]

[EXPVAL];


4-78 47 A2 11UJ Rev04


The $JOB statement, if used, must be the first statement of a job description. Its functionis primarily to provide identification in terms of user-name, project-name and a symbolicjob-name. The $JOB and $ENDJOB are not needed if only one job is submitted using aRUN statement or an EJR operator command.

The $JOB statement is recognized by the Stream Reader, which stores the jobdescription statements in the backing store. The $ sign must be present and must belocated in the first character position of the record except when the job is submitted from asource using a RUN statement or the EJR operator command.

If a valid site catalog exists, any values specified in the $JOB statement for USER,PROJECT and BILLING must correspond exactly with the entries in the site catalog. Thebilling of EJR command is significant only if the submitted job does not contain the $JOBstatement.

4.16.5 Parameters


job-name

The name by which the job is known to the user. The name is composed of up to eightalphanumeric, hyphen and underscore characters. The first character must bealphanumeric. The job-name must appear on the same record as the statement name($JOB). The job is known to the system by its Run Occurrence Number (RON).

If there is no $JOB statement, then the job-name is the member-name (RUN member orEJR) or external-file-name (RUN efn). If the name exceeds 8 characters, only the first 8are used.

USER

Specifies the name of the user. The name is composed of up to twelve alphanumeric,hyphen and underscore characters. The first character must be alphanumeric.

The USER parameter is not mandatory if it is submitted in any of the following ways:

• EJR operator command; in this case, the submitter identification is taken as the default.

• RUN statement; in this case the IOF user or spawning job user is taken as the default.

Apart from these three exceptions, if the USER parameter is omitted, the job execution isnot requested. The job is given a run occurrence number (RON), and the Job OccurrenceReport is produced.


47 A2 11UJ Rev04 4-79

If Access Rights have been implemented the USER value may be restricted as follows:

• If the submitter is the main or station operator, any USER value can be given;

• If the submitter is a batch or IOF user, the USER must be the submitter.


PROJECT

Specifies the name of the project associated with the given user. The name can consist ofup to twelve alphanumeric, hyphen and underscore characters. The first character mustbe alphabetic or numeric.

WARNING

The PROJECT parameter is mandatory in the $JOB statement if thereis no default value given in the site catalog, or if no site catalog exists.

BILLING

Specifies the name used for accounting and control of the current PROJECT. The nameis composed of up to twelve alphanumeric, hyphen and underscore characters. The firstmust be alphabetic or numeric. If BILLING is omitted and no default value in the sitecatalog is associated with the current project, the PROJECT name itself is used for theBILLING in the job report banner.

WARNING

The BILLING parameter is mandatory in the $JOB statement if there isno default value given in the site catalog, or if no site catalog exists.

NSTARTUP

Start-up sequences are logically inserted after the $JOB statement if they exist in thestart-up source library SITE.STARTUP. A start-up sequence may contain all the systemlevel commands and directives which may be executed in batch mode. In Batch, two start-up sequences may be attached to a project in the catalog, a mandatory start-up sequenceand an optional start-up sequence. The available start-up sequences are the following:

SITE_B

<project>_B

<project>_<user>_B


4-80 47 A2 11UJ Rev04

Rules for Implementing Start-up Sequences:

1. Any of the three start-up sequences can be specified as mandatory.

2. Only <project>_B and <project>_<user>_B can be specified as optional.

3. The mandatory start-up is executed before the optional start-up.

4. The optional start-up sequence can be inhibited by specifying NSTARTUP in $JOB,STARTUP =0 in EJR or RUN_JOB, or using the field STARTUP of the inputstructure if the programmatic interface is used.

5. If the project is SYSADMIN, and NSTARTUP is specified, then both the mandatoryand optional startup sequences are inhibited.

LIST

Allows you to select the type of information to be printed when listing the JCL on the JobOccurrence Report.

SOURCE The source JCL, inserted Stream Reader statements,records inserted using a $SWINPUT statement with theCONSOLE parameter, and error message are listed.

ALL The source JCL and all expansions of JCL sequences whichare entered using INVOKE, $SWINPUT, and project start-upare listed, along with error messages.

NO Only Stream Reader statements, comments and errormessages are listed.

If Access Rights have been implemented and you do not have the READ right over thefile(s) containing the information to be printed, then LIST is ignored.

JOR

Determines the situations in which the Job Occurrence Report (JOR) is to be produced.The possible values are:

NORMAL The JOR is printed. This is the default.

ABORT The JOR is printed only if the job aborts.

NO The JOR is not printed.


47 A2 11UJ Rev04 4-81

CLASS

The job is attached to the job class defined by one or two letters. There are 16 job classeswhich are defined by a single letter between A and P and 416 job classes of two lettersfrom AA to PZ. The job class allows you to define the default scheduling and executionpriorities and a maximum multi-programming-level for jobs of the class. The operator cansuspend and reactivate a given class, permitting flexibility and efficient use of machineresources. The use of job class allows you to control job-selection processing and tomanage the serial execution of jobs.

The class of a job may be restricted through the site catalog based on its PROJECTidentification. Each project can be attached to a batch default class and an IOF defaultclass. Up to 26 classes can be attached to a project. Any job submitted with a job classthat does not exist, or that is not accessible to the project, is launched in class P.

HOLD

Specifies that, after JCL translation, the job has "hold" status. The job cannot bescheduled for execution until the operator issues a RELEASE_JOB command (RJ) or ajob which is executing suppresses the HOLD with a JCL statement RELEASE.

If a value is specified with the HOLD parameter, this becomes the HOLD count for the job.This is decremented by 1 each time a JCL statement RELEASE is issued. The job is thenmade available for scheduling once the HOLD count becomes 0 (zero). The HOLD countmay be forced directly to 0 if an RJ operator command is issued with the STRONG option.

HOLDOUT

If this parameter is present, output files produced by the job are not printed automaticallybut are held back until released by the RELEASE_OUTPUT command (RO).

PRIORITY

Specifies a one-digit scheduling priority between 0, the highest priority, and 7, the lowestpriority. Jobs are scheduled according to this priority.

The scheduling priority of a job may be restricted through the SITE catalog based on itsPROJECT identification. If your specified priority exceeds the maximum value allowed forthe PROJECT, then this maximum value is used instead and a warning message isissued.

Within a specified priority, jobs are scheduled on a first-in-first-out (FIFO) basis.

NOTE: A job will not be scheduled if the maximum number of jobs in the same class isalready scheduled.

The default value for PRIORITY depends on the job class.


4-82 47 A2 11UJ Rev04

RECSIZE

Applies only if input comes from a KDS terminal. It specifies the record length of thetransmitted diskette files. The default value is 110.

REPEAT

Specifies that the job may be repeated from the beginning, at the discretion of theoperator, after a warm restart. It is meaningful only in the case where the step in whichthe abort occurred does not itself have the REPEAT option. If there is a STEP REPEAToption, the step will be repeated (on the decision of the operator). If not, a repeat of thewhole job will be considered.

If the REPEAT option is omitted, the entire job cannot be repeated.

HOST

Identifies the site on which the job is to be run, if different from the site where the JCL isentered or stored. It consists of up to 4 alphanumeric characters. The site specified in thisparameter must be a DPS-7 or DPS-7000 system.

JOBLANG

Identifies the Command Language used for the JOB description:

GCL GCOS Command Language

JCL JOB Control Language

When omitted; the value given at submission time, if any, is used. If this has also beenomitted, the JOBLANG value defaults to JCL.

EXPVAL

Specifies that the expansion of the values in the JCL of the job is shown in the JobOccurrence Report. This parameter is only applicable when JOBLANG = JCL.

Example:

$JOB DMJOB, USER=DJM, PROJECT=MECTP, HOST=BP3C;

In the above statement, job DMJOB will be transferrred to the system BP3C and thenexecuted on that system.


47 A2 11UJ Rev04 4-83

4.17 JUMP

4.17.1 Function

Alters, conditionally or unconditionally, the sequential execution of the JCL from thecurrent statement to another statement. Provides facilities to avoid job abort when a stepterminates abnormally.

4.17.2 Enclosure

Job or step.

4.17.3 Format

JUMP {label-name} {CONTINUE }

[{ } {EQ} ] [{STATUS} {NE} ] [{SEV } {GE} digits5]; [{SWi } {GT} ] [{IOF } {LE} ] [{ } {LT} ]


The JUMP statement alters, conditionally or unconditionally, the JCL execution sequencefrom the current statement. Control normally passes to the labelled JCL statementcorresponding to the label-name specified in the JUMP statement. If CONTINUE isspecified, the next JCL statement is executed. This is useful particularly in the case of astep abort (see below).

The JUMP statement may test the status or severity code passed on by a step, or asystem switch that you previously set with a LET statement or by a COBOL program(external switch). The jump will or will not be performed depending on the current value ofthe code or switch tested. If the label-name (or CONTINUE) is specified on its own, anunconditional jump is made. If JUMP is specified within a step enclosure, thecorresponding labelled JCL statement must appear within the same step enclosure.Specifying JUMP within a step enclosure allows you to bypass certain JCL within a stepas the result of the satisfaction of a condition being tested.


4-84 47 A2 11UJ Rev04

If JUMP is specified within a job enclosure, but outside a step enclosure, the labelled JCLstatement must also appear within the job enclosure and outside a step enclosure.

Within a job enclosure a jump can be forward or backward. You can bypass or re-executeas many steps, in sequence, as desired. Within a step enclosure a jump must be forward.

Since the JUMP statement takes effect at job execution, a jump to a Translator statement(for example, INVOKE, VALUES) is meaningless. JUMP (effective at execution) cannotbe used to bypass a LIB statement (effective at translation); see Example 4 below. Theprevious remark also applies to VALUES and MODVL statements; see Example 5 below.

STATUS, SEV, SWi or IOF

A conditional jump is only made when the tested condition is true. If a step is aborted, theremainder of the job is also aborted, unless a JUMP statement testing one of the systemvariables STATUS or SEV follows the JCL describing the step (that is, JUMP followsENDSTEP for the aborted step and precedes the next STEP statement, if any). In thiscase, if a true condition exists, normal execution of the job continues according to thespecified label-name. Any JCL statements between the aborted step and the JUMPstatement are bypassed. If the reserved label "CONTINUE" is specified, executioncontinues with the next JCL statement.

4.17.5 Parameters

The parameters of the JUMP statement are positional (that is, they must be given in theorder in which they appear in the format).


label-name

The label assigned to the JCL statement which is to be executed next, eitherunconditionally or if the specified condition is true. Label-name can be up to eightalphanumeric, hyphen and underscore characters in length and must begin with a letter ora digit.

CONTINUE

A reserved label-name indicating that, even in the event of a step abort, normal executionof the job is to continue with the next statement.


47 A2 11UJ Rev04 4-85


STATUS

Used to test the step completion code which is set by a program. The digits5 valuefollowing the specified relational operator (for example, EQ) is initialized to 0 at stepinitiation time. It can have the following values:

• User normal termination or user step abort (when the REPEAT parameter is not usedin STEP) - user specified value between 0 (that is, normal) and 32767. Note that avalue of 10000 or more represents abort status.

• Operator abort - 50000

• System abort - greater than or equal to 60000.

NOTE: 0 indicates a normal termination.

SEV

Used to test the step severity code which is set by a user program, a system abort or anoperator TERMINATE JOB (TJ) command. The digits5 parameter can assume an integervalue between 0 and 6, inclusive. The following table gives the correspondence betweenSEV and STATUS.

SEV STATUS0 0-991 100-9992 100-99993 10000-199994 20000-327675 500006 > 60000

SWi

A system switch that you set with the LET command to indicate a program conditionwhich you wish to associate with the value 0 or 1 for the switch. The character i must bean integer value between 0 and 31, indicating the switch which is to be tested. The digits5parameter in this case, must take the value 0 or 1. These switches are initialized to 0 atjob initiation time ($JOB statement) but can be preset for a "spawned" job by means of theRUN statement or for a released job (RELEASE).


4-86 47 A2 11UJ Rev04

IOF

This is a system switch. It is equal to 1 if the job is running in IOF mode and is 0 if the jobis executing in batch mode. In this case the digits5 parameter must take the value 0 or 1.

The relational operators have the following meanings:

EQ EQual to

NE Not Equal to

GE Greater than or Equal to

GT Greater Than

LE Less than or Equal to

LT Less Than

Example 1:

$JOB A, .....; STEP LM1, .....; . . . ENDSTEP; JUMP FIN, SEV, GT,1; STEP LM2, .....; JUMP CAS, SEV, EQ, 1; ASSIGN IFN1, FILE1, .....; JUMP ENDLM2; CAS; ASSIGN IFN1, FILE2,....; ENDLM2: ENDSTEP; FIN: $ENDJOB;

If step LM1 results in a severity code equal to 0, step LM2 is executed and FILE1 isassigned to IFN1.

If step LM1 results in a severity code equal to 1, step LM2 is executed and FILE2 isassigned to IFN1.

In all other cases, the JUMP statement following the ENDSTEP for step LM2, causes ajump to the JCL statement labelled FIN (that is, $ENDJOB).


47 A2 11UJ Rev04 4-87

Example 2:

In the event of an abort of a load module the job description continues to be scannedsequentially until one of the following JCL statements is encountered:

$ENDJOB job execution is abnormally terminated.

STEP* job execution is abnormally terminated.

JUMP status codes (or switches) are tested and, if the condition istrue, job execution continues normally according to the label-name specified.

* This is basic JCL, but the action applies also to an extended JCL statement which isexpanded to a step description.

Consider the following test:

$JOB FIRSTJOB,....; STEP LM1, ...; . . . ENDSTEP; STEP LM2, ...; . . . ENDSTEP; JUMP CONTINUE; RUN OTHERJOB, ...; STEP LM3, ...; . . . ENDSTEP; $ENDJOB;

Step LM2 is executed only if step LM1 terminates normally. However, since the JUMPstatement specifies CONTINUE, OTHERJOB is introduced and step LM3 is executedwhatever the result of step LM2.


4-88 47 A2 11UJ Rev04

Example 3:

$JOB SWITCHER, ...; START: STEP LM1, ...; . . . ENDSTEP; JUMP T3, SW1, EQ, 1; LET SW1, 1; STEP LM2, ...; . . . ENDSTEP; JUMP START; T3: STEP LM3, ....; . . . ENDSTEP; $ENDJOB;

Since SW1 is initialized to 0 when the job is initialized, the order of execution is as follows:

• Step LM1 is executed followed by step LM2 if SW1 is still 0; otherwise a jump is madeto step LM3 (which is labelled T3).

• An unconditional jump is made back to step LM1 (which is labelled START).

• Step LM3 is executed (which is labelled T3).

Example 4:

$JOB ... ; . . LIB SL INLIB1=LIBX; JUMP STEP2, SW1, EQ, 1; . LIB SL INLIB1=LIBY; STEP2: LIBMAINT SL LIB=LIBZ; . . . . $ENDJOB;

The idea is to use LIBX as the input library (for the LIBMAINT step) if the SW1 is set to 1and, LIBY if switch SW1 is set to O. The statement LIB is processed at Job translationand the second statement LIB for LIBY overrides the statement LIB for LIBX. At theexecution time, the Jump statement is not active and the input library is LIBY.


47 A2 11UJ Rev04 4-89

Example 5:

$JOB ........; . . . VALUES X=FIRSTVAL; . . . X=FIRSTVAL, effective . . . JUMP NEXT, SW1, EQ, 1; MODVL X=SECONDVAL; . . . . . . NEXT : STEP ........; . . . X=SECONDVAL, effective . . ENDSTEP; . . . . $ENDJOB;

VALUES and MODVL are effective at job translation. MODVL gives a new valueSECONDVAL to &X. This new value is effective through to $ENDJOB (assuming thatthere are no other MODVL or VALUES except the two shown), irrespective of whether ornot the jump to NEXT takes place at execution time. Thus, even if SW1 is 1 and thestatements between JUMP and NEXT:STEP are skipped at execution time, &X will stillhave the value SECONDVAL from the position of the MODVL statement through to the$ENDJOB statement.


4-90 47 A2 11UJ Rev04

4.18 LET

4.18.1 Function

Sets the value of a system switch (or all system switches) or sets the step severity code toan integer value between 0 and 4 inclusive.

4.18.2 Enclosure

Job or Step.

4.18.3 Format

LET {SWi {0} } { {1} } { } {SW hexa8 } { } {SEV digit1 };


The LET statement can be used to set a system switch value to 0 or 1 to be tested by asubsequent JUMP statement which specifies the same switch.

Alternatively, all system switches can be simultaneously set from left to right to a specifiedhexadecimal value. You decides with what program condition each switch is to beassociated. A third use of LET is to assign, outside a step enclosure, a specific value tothe step severity.


47 A2 11UJ Rev04 4-91

4.18.5 Mandatory Parameters

SWi

The SWi parameter specifies one of 32 system switches which must be set to a value of 0or 1. These switches are normally initialized to zero when the job is initiated. However, theinitial switch values can also be set by RUN or RELEASE or by the operator using theoperator commands MDJ or EJR.

SW

The SW parameter references all system switches.

Hexa8 A string of up to eight hexadecimal characters is specified asthe set of 32 values to which all system switches aresimultaneously set, from left to right. For example, FAB00000sets SW0, SW1, SW2, SW3, SW4, SW6, SW8, SW10 andSW11 to the value 1 and all other switches to zero. (F (hex)=1111 (binary), A=1010 and B=1011).

SEV

The step severity code is set to the value supplied for digit1, an integer between 0 and 4inclusive. After the execution of the LET statement, the job is in the same state as if astep had terminated with a severity code of the specified value. Therefore if the givenvalue is equal to 3 or more, the job is put in the abort status; this situation can beintercepted by use of the JUMP statement. If several LET SEV statements occur together,only the last one is taken into account.

This form of the LET statement is useful with the INVOKE feature. By inserting LET SEVat the end of an invoked sequence, a user can set a severity value which can be tested inthe calling job by means of a JUMP statement appearing immediately after the INVOKE.Thus, the result of the test will be independent of the severity set by the last executed stepin the invoked sequence.

Restriction

This form of the LET statement must not occur inside a step enclosure.


4-92 47 A2 11UJ Rev04

4.19 LIB

4.19.1 Function

Defines a search path of input libraries to be used by a subsequent extended JCLstatement.

4.19.2 Enclosure

Job.

4.19.3 Format

[{SL }] [{CU }] {TEMP }LIB [{LM }] [[INLIB1 =] {(input-library-description)}] [{SM }] [{BIN}]

{TEMP } [[INLIB2 =] {(input-library-description)}]



{TEMP } [[INLIB5 =] {(input-library-description)}];


47 A2 11UJ Rev04 4-93


The LIB statement defines a search path of input libraries to be used in a subsequentextended JCL statement. The library member concerned is searched for, first in INLIB1,then INLIB2, INLIB3, etc. If the same member name is present in more than one library,the first one encountered is processed. Alternatively, you may restrict the search to aspecific library by giving its INLIB number in the extended JCL statement.

The LIB statement may appear anywhere in a job enclosure. A LIB statement is effectiveuntil overridden by a subsequent LIB statement of the same type (the type being SL, CU,LM, SM, or BIN). The major use of LIB is to define input libraries for a subsequentLIBMAINT statement. However, LIB SL can be used to specify input for the compilers (forexample, COBOL, FORTRAN), and LIB CU can be used to indicate input to LINKER.

The maximum length of the search path defined with LIB depends on the type of library.

The maximum values are:

3 for SL, SM, and BIN1 for LM5 for CU

There must be no gaps in the search path; that is, if INLIB 3 is given so must INLIB1 andINLIB2. For example, if there are two libraries in the search path these must be INLIB1AND INLIB2 (and not INLIB1, INLIB3 or INLIB2, INLIB3).

The keywords INLIB1= may be omitted, in which case the first mentioned library becomesINLIB1, the second becomes INLIB2, etc.

In contrast to the way the VALUES JCL statement operates, a LIB statement of a mainJCL sequence applies to an invoked sequence (that is, a sequence invoked with theINVOKE JCL statement) until a LIB statement (if any) is encountered within the invokedsequence. A LIB statement in an invoked sequence is effective only within this sequence.Thus after the INVOKE statement, the last LIB statement of the main JCL sequence (thatis, the invoking sequence) is again applicable to the main sequence.

A LIB statement in a main JCL sequence is not applicable to an executed JCL sequence(that is, a sequence executed with the EXECUTE JCL statement). A LIB statement withinan executed JCL sequence is applicable only within this sequence (thus it is notapplicable to the main sequence after the EXECUTE statement).

A LIB statement in a main JCL sequence is applicable to a JCL sequence "inserted" in themain sequence with the $SWINPUT statement. In contrast to the cases of INVOKE andEXECUTE, a LIB statement within the switched sequence (that is, the sequence insertedwith $SWINPUT) is applicable to the main sequence after the $SWINPUT statement.

The LIB statement is effective at JCL translation time, consequently the JUMP statement(which is effective at execution time) cannot be used to "jump around" a LIB statement.

For more details on the use of LIB with LIBMAINT, see the Library Maintenance User'sGuide.


4-94 47 A2 11UJ Rev04

4.19.5 Parameters



Defines an input library to be used in the search path. TEMP means a temporary library. Ifthe keyword INLIBi = is given then i is the rank of the library in the search path. If INLIBi =is omitted then the position of the library in the LIB statement determines its rank in thesearch path.


The optional parameter specifies the library type as follows:

SL for a Source Language Library. This is the default.CU for a Compile Unit LibraryLM for a Load Module LibraryBIN for a Binary Library.

Example:

$JOB .............; . .1 LIB SL INLIB1 = (.MYLIB1); . } . } . } scope of 1 . } . }2 LIB SL INLIB1 = (.MYLIB2); . } . } . } scope of 2 . } . }

3 LIB CU INLIB1=(.MYLIBX) INLIB2=TEMP; . } . } . } scope of 2 and 3 . } . } $ENDJOB;


47 A2 11UJ Rev04 4-95

The first LIB statement defines .MYLIB1 as the input SL Library. The second LIBstatement overrides this, so that the input SL becomes .MYLIB2. The third LIB statementdefines a CU library search path. As this LIB statement is for a different type of library(namely CU), it does not override the LIB SL statement and .MYLIB2 remains the effectiveSL library.

LIB $JOB .............; . . .1 LIB SL INLIB1=(.MYLIB1); . } . } . } . } scope of 1 . } . } . } JUMP X1 SWO, EQ, 1;2 LIB SL INLIB1=(.MYLIB2); . } . } JUMP X2 SW3, EQ, 1; } . } scope of 2 . } . } . }3 LIB SL INLIB1=(.MYLIB3) . } . } . } . } scope of 3 . } . } } X1 : LIBMAINT SL .......; } } . } . } . } . }

4 LIB SL INLIB1=(.MYLIB4); . } X2 : LIBMAINT SL .......; } . } . } scope of 4 . } . } . }

$ENDJOB;

As the LIB statements take effect at translation time, they are not affected by thepresence of JUMP statements (effective at execution) in the job. So irrespective of theactual execution path through the job (determined by the JUMP statements), each LIBstatement overrides the preceding one and the scope of each is as indicated above.


4-96 47 A2 11UJ Rev04

4.20 MESSAGE

4.20.1 Function

Sends a message to the operator's console at JCL translation time.

4.20.2 Enclosure

Job.

4.20.3 Format

MESSAGE 'string105';


The MESSAGE statement allows you to display a message on the operator's console atthe time of JCL translation. The maximum permissible length of a message is 105characters.


47 A2 11UJ Rev04 4-97

4.21 MODVL

4.21.1 Function

Modifies default values for parameters in JCL statements.

4.21.2 Enclosure

Job, INVOKE sequence or an EXECUTE sequence.

4.21.3 Format

MODVL [parameter-value-1 [, parameter-value-2] ... ]

[keyword1=keyword-value-1 [keyword2=keyword-value-2] ...];


This statement modifies the current set of parameter values. Only those parameterswhich explicitly appear in the MODVL statement are affected by it. Otherwise the effect ofa MODVL statement is similar to that of the VALUES statement. A MODVL statementdoes not nullify the effects of a preceding MODVL or VALUES statement except for thoseparameters which are given values on the current MODVL statement.

The values apply to all following JCL statements until another MODVL statement, aVALUES statement, the end of the current sequence of JCL or the end of the jobenclosure. The values set by MODVL can apply to values omitted within the VALUESparameter in INVOKE, EXECUTE and RUN or the EJR operator command.

The MODVL statement cannot be used to set values in the $JOB, $INPUT, $ENDINPUT,$DATA or $SWINPUT statements, nor in a following VALUES statement. Parameter-value-i replaces the value of the positional parameter &i and keyword-value-i replaces thevalue of the keyword parameter keyword-i. Positional and keyword parameters arediscussed in Section 2 and the rules concerning parameter substitution in JCL statementsare discussed in the JCL User's Guide.

MODVL statements are cumulative in effect that is, each one gives a value to a parameterwhich previously did not have one, or adds values of new parameters that have not yetappeared, or changes the value of a parameter, but leaves unaltered those parametersthat were not explicitly specified on the MODVL statement. This should be contrasted withVALUES which nullifies those parameters that do not explicitly appear on the statement.To nullify a parameter value with MODVL, specify the value NIL.


4-98 47 A2 11UJ Rev04

If commas are being used as separators, missing positional parameter values areindicated by commas without a preceding value. If spaces are being used as separators,a # sign indicates a missing positional parameter value. Missing parameter values to theright of the last value specified need not be indicated by commas or # signs. See Example1 below. No action is needed for missing keyword parameters as these are identified bythe keyword and not by their position.

MODVL modifies values methodically from the leftmost to the rightmost parameter in thestatement.

4.21.5 Optional Parameters

parameter-value-i

Defines the new default value for the string &i (where 1 < i < 99) in an invoked JCLsequence or in a job description.

The value now specified replaces the existing value, if any, which may have been given bya preceding VALUES or MODVL statement. The value supplied must follow the syntaxrules for the parameter(s) for which it is defined; however it may be a protected string (thatis, any character string enclosed in single quotes, except that a single quote inside astring must be entered twice in succession) of up to 128 characters. The position of aparameter value relative to other parameter values in a MODVL statement defines thevalue i for the identification of the associated i.

keyword-value-i

Defines the new default value to replace every occurrence of &keywordi in a invoked JCLsequence or in a job description. The value now specified replaces the existing value, ifany, which may have been given by a preceding VALUES or MODVL statement. Thevalue defined must follow the syntax rules of the parameter(s) for which it is defined;however it may be a protected string of up to 128 characters. The maximum length of akeyword is 8 characters.

Example 1:

There are 10 positional parameters (&1 through &10) and values p2, p4, p6 are to begiven to the 2nd, 4th and 6th respectively (that is, &2,&4,&6). The following 4 MODVLstatements are equivalent:

MODVL , p2,, p4,, p6,,,,;

MODVL , p2,, p4,, p6;

MODVL # p2 # p4 # p6 # # # #;

MODVL # p2 # p4 # p6;


47 A2 11UJ Rev04 4-99

The previously existing values, if any, of &2, &4 and &6 are replaced with p2, p4 and p6respectively. It does not matter whether &2 had no old value or had an old value suppliedby a preceding VALUES or MODVL statement; its value is now p2 and remains so untilchanged by another MODVL or VALUES statement.

The values of the parameters for which no new values are given are not affected by theMODVL statement. Thus &1, &3, &5, &7, &8, &9 and &10 retain whatever values theyhad, if any, before the MODVL statement took effect.

Example 2:

Consider the following sequence:

VALUES DK1= 'MD=K116 DVC=MS/M500' DK2= 'MD=K200 DVC=MS/M500';

&DK1 refers to MD=K116 DVC=MS/M500.&DK2 refers to MD=K200 DVC=MS/M500.

MODVL DK1= 'MD=C200 DVC=MS/M500';

&DK1 refers to MD=C200 DVC=MS/M500.&DK2 refers to MD=K200 DVC=MS/M500.


4-100 47 A2 11UJ Rev04

4.22 OUTVAL

4.22.1 Function

Sets default output handling and output editing values for parameters of SYSOUT andWRITER statements in the current job.

4.22.2 Enclosure

Job.

4.22.3 Format

OUTVAL [CLASS = identifier1] [PRIORITY = digit1]

[WHEN =(JOB }] [ {STEP }] [ {IMMED }] [ {DEFER }] [ {digits5}]

[{HOLD }] [{NHOLD}]

[NAME =identifier8]

[{BANNER }] [{NBANNER}]

[ {JOB }] [BANLEVEL = {OUTPUT}] [ {COPY }] [ {MEMBER}]

[BANINF = (alphanum12 [,alphanum12] ...)]

[COPIES = digits2]

[DEVCLASS = device-class [ MEDIA = volume-name}]

[DEST = [host-name].station-name]

[{SLEW }] [{NSLEW}]

[{DELETE}] [{NDELETE}];


47 A2 11UJ Rev04 4-101


The OUTVAL statement overrides the system default values which apply to everySYSOUT file of the current job. It cannot appear inside a step enclosure but may bespecified between steps; it is valid until the next OUTVAL statement (or until the end ofthe job if there are no more OUTVAL statements). The overriding works as follows:

1. At job initialization, the default output parameters correspond to the standard systemparameters.

2. Each time an OUTVAL statement appears, the specified parameters replace thepreceding default values as the new default values. If no parameters are specified(that is OUTVAL;), the standard system parameters replace the preceding defaultvalues.

3. Each time a WRITER or SYSOUT statement is encountered, the default values ofthe previous OUTVAL statement, if one exists, are used; however, any parametervalues explicitly stated in the WRITER or SYSOUT statement temporarily overridethe defaults. (See below).

JOR and JOBOUT

The system defines by default the following output characteristics for the file (known asJOB-REP) that contains the Job Occurrence Report:

CLASS=C, PRIORITY=3, WHEN=JOB, COPIES=1

However, you can override these values in the first OUTVAL statement for printed outputthat appears before the first step; in this case, the WHEN parameter, if specified, isignored and the value JOB still applies. If no OUTVAL appears before the first step, or ifthe first OUTVAL before the first step does not contain any parameters, the defaultsystem values apply. Any such OUTVAL statement affects all following SYSOUT andWRITER statements until the next OUTVAL statement, if any, appears.

The group of standard SYSOUT files that have the same characteristics as JOB-REP,including compiler, linker and step output, is regarded for output purposes as a single file,known as the "JOBOUT". Consequently, the OUTVAL statement, if any, that applies toJOB-REP also determines which standard SYSOUT files will be considered as part of theJOBOUT.

4.22.5 Parameters

For a description of all OUTVAL parameters, see the parameter descriptions for theSYSOUT statement. Note however that station or class dependent parameters are re-evaluated. If the output class, device class or media derive from a destination other thanOUTVAL, then these new values override the OUTVAL values. Similarly, if a new class isspecified, the priority of this class overrides the priority specified in the OUTVALstatement.


4-102 47 A2 11UJ Rev04

4.23 POOL

4.23.1 Function

Requests the allocation of one or more devices in the same device-class to a pool, for theduration of a step.

4.23.2 Enclosure

Step.

4.23.3 Format

{[{ 1 }*] }POOL {[{ digits2} ] device-class [MAX = digits2]}; { } { } { device-name }


The function of the POOL statement is to allocate one or more devices of a given device-class to a pool. The pool of devices is reserved for use by a step for the whole of thestep's duration.

More than one POOL statement can be used in a step. The effect is to add the devices tothe pool corresponding to the appropriate device class. Devices can be requested from apool by an ASSIGN statement. In this case, one or more POOL statements namingdevices with the same attributes may precede the ASSIGN statement in the stepenclosure. See the ASSIGN statement, POOL parameter.

The POOL statement is used to minimize, in certain cases, the number of devices that areallocated to a step. This can be best shown by considering an example.

Assume that you wish to process two files that are stored on different volumes. TwoASSIGN statements are required in the step enclosure. From the system viewpoint,devices are allocated on an additive basis. Thus, the assignment of two files on differentvolumes is taken as a request for the allocation of two devices.

It is possible, however, that you wish both files to be processed sequentially in time, thatis, the second volume may be mounted on the same device when processing of the firstfile is completed.


47 A2 11UJ Rev04 4-103

You know then, that one device is sufficient, but cannot, without POOL, indicate this to thesystem. For an installation with a limited number of available devices, this presents aproblem which is made worse as more ASSIGN statements that request different volumesare specified.

To overcome this problem, you specify in both ASSIGN statements that you wish to use apool device and indicates which file (and therefore which volume) is to be processed first.

At step execution, when processing of the first file is ended, you issue an order to openthe second file. This results in a request to mount the second volume on the same (pool)device, which is still reserved for use by the current step.


The attributes of the device-class specified in the ASSIGN statements corresponding tothe POOL statement must be identical to those of the device-class named in POOL.

If the requested number of devices in a device class are not immediately available, thestep must wait until the POOL statement can be satisfied.

Once the step has started, the requested number of devices is guaranteed to the step;however, if another step has assigned a file contained on a volume that is mounted onone of the pooled devices of this step, the other step will be able to access that file(subject to any file sharing restrictions that apply to the file).

4.23.5 Parameters

Pool devices are described by specifying either the device class or device name.


device-class

Specifies the device class and its attributes for the device being pooled (see Section 3).This form of identification is recommended in preference to the "device-name" format.

device-name

The format is given in Section 3. When specified, no other parameter is coded and onlythe one named device is allocated. Thus, if more than one pool device is requested usingdevice-names, it is necessary to specify one POOL statement for each such device. Theeffect is that the devices are added into the same pool.


4-104 47 A2 11UJ Rev04


The first optional parameter is used when a specified minimum number of devices of agiven class must be allocated to the pool. The default value is 1 and the maximum valueis 99. The asterisk (*) must immediately follow the specified value. The step will not beinitiated until the minimum number of devices is available and these resources have beenallocated to the step.

MAX

Specifies the maximum number of devices to be allocated, if available.

NOTE: The difference MAX-minimum number of devices represents a conditionalrequest for devices.

Example:

POOL 2*MT/T9/D1600

Requests two 9 track tape devices for tape density 1600 bits per inch (b.p.i.).

POOL MS/M500

Requests one MSU0555 disk device.

POOL MT/T9/D1600, MAX=2;

The step can be initiated only if at least one 9 track tape drive is free: another 9 track tapedrive is conditionally requested.

POOL 0*MS/M452, MAX=1

A MSU0452 disk drive is conditionally requested. In this case, the step may be initiatedeven if no MSU0452 disk drive is available.

POOL MS02

Requests one disk device whose identifier is MS02.


47 A2 11UJ Rev04 4-105

4.24 PREFIX

4.24.1 Function

Defines a prefix to be placed before every external file name that begins with a dot ".".

4.24.2 Enclosure

Job.

4.24.3 Format

PREFIX {prefix-name } {project-name};


The PREFIX statement is used to override the default prefix value for external file names.The default prefix-name is the name of the project with which the job is associated; it iseither specified in the PROJECT parameter of the $JOB statement or taken from the sitecatalog.

Each PREFIX statement that appears in a job description overrides the previous one.

See the Catalog Management Manual for a description of the use of prefixes.

Comments and Restriction

PREFIX does not apply to external file names in protected strings (that is, enclosed inquotes).

The new external file name, composed of the prefix-name followed by the old external file(which starts with a period) must follow the rules for external file name (see Section 3).

The prefix-name may contain several component names (see Section 3) and periodseparators. This allows you to specify automatic prefixing for several levels of the cataloghierarchy (see Example 2 below).


4-106 47 A2 11UJ Rev04


prefix-name

The value given for prefix-name will be prefixed to every occurrence of an external filename that starts with a period and is not in a protected string.

The maximum permissible length of prefix-name is 42 characters. If prefix-name is notspecified, the prefix is set to the project name.

Example 1:

Consider the following sequence of statements:

PREFIX SALES; STEP......; ASSIGN UPD, .ACCTS; ENDSTEP;

The effect of the PREFIX is to replace .ACCTS by SALES.ACCTS.

Example 2:

PREFIX AREA1.CUSTOMER; STEP ST1,....; ASSIGN IFN1, .ACCTS; ASSIGN IFN2, .ADDRESSES; ENDSTEP;

In the above example, the two ASSIGN statements become :

ASSIGN IFN1, AREA1.CUSTOMER.ACCTS; ASSIGN IFN2, AREA1.CUSTOMER.ADDRESSES;


47 A2 11UJ Rev04 4-107

4.25 QASSIGN

4.25.1 Function

Establishes the correspondence between the symbolic and external queue names andspecifies a queue structure, message format and the method of scanning. Also allocatesan MCS queue to the job step.

4.25.2 Enclosure

Step.

4.25.3 Format

QASSIGN symbolic-queue-name [.symbolic-subqueue1-name [.symbolic-subqueue2-name [.symbolic-subqueue3-name]]]

external-queue-name1

[SITE = node-name]

[ {IN } ] [ {INOUT ACCESS = {LIN} } ]; [ { { RR} } ] [ {OUT [REPLY = external-queue2-name]} ]


The QASSIGN statement is used to establish the correspondence between the symbolic(internal) queue name, as specified in the CD area (Communication Description) of theMCS COBOL program, (or in the H_CDOUT or H_CDIN of a GPL application) and theexternal queue name defined in the network description.

A QASSIGN statement is required for each input queue used in a step. A symbolic inputqueue can have one or more associated subqueues. Each subqueue must be identifiedby a QASSIGN statement which names the symbolic queue and the symbolic subqueue.

A QASSIGN statement is not required for a symbolic output queue (a symbolic outputqueue can be implicitly identified by the terminal name).


4-108 47 A2 11UJ Rev04

Up to 26 QASSIGN statements may be specified in a step enclosure. The first QASSIGNstatement for a given queue defines the subqueue method of scanning for all subqueuesrelated to the queue. In this case, the ACCESS parameter, if present on followingQASSIGN statements related to the same queue, is ignored. A symbolic-subqueue-namemust be unique within a step enclosure.

Where disk queues are used, no ASSIGN statement is required because the file isopened at system level and is therefore shareable by all process groups.

The connection mode between correspondents and input and output message format canbe specified. Automatic insertion of end of line characters (that is carriage return, linefeed) may also be requested.

Refer to the Communications Processing Facility, and MCS User's Guide for more detailson the use of the QASSIGN statement.

4.25.5 Parameters


symbolic-queue-name

Identifies the queue name as follows:

• in MCS COBOL, in data-name-1 of the CD area (input and output)• in GPL, by QUEUE_NAME of H_CDOUT or H_CDIN

The symbolic-queue-name consists of up to 12 alpahanumeric, hyphen and underscorecharacters.

external-queue1-name

Identifies the queue name as specified in the Network generation. The external-queue-name consists of up to 12 alphanumeric, hyphen and underscore characters.


symbolic-subqueue-name

Identifies a subqueue associated with the named queue; it consists of up to 12alphanumeric, hyphen and underscore characters. This parameter does not apply if OUTor INOUT is specified. It is applicable only for input queues for partitioning the logicalqueue as follows:

• in MCS COBOL in data-name-2, data-name-3 and data-name-4, of the input CD area;

• in GPL, by SUBQUEUE_NAME, SUBQUEUE2_NAME and SUBQUEUE3_NAME ofH_CDIN.


47 A2 11UJ Rev04 4-109

SITE

Identifies a DSA system which can either be 'lsys' or 'rsys' for DPS 7000.

IN

Specifies that the named queue is an input queue. Applicable only to program queues.This is the default.

INOUT

Processing is both input and output mode. A subqueue cannot be specified in INOUTmode. Applicable only to program queues.

OUT

Specifies that the named queue is an output queue. A subqueue cannot be specifiedwhen OUT is used.

ACCESS

Specifies the method of scanning subqueues on a receive action. ACCESS does notapply if OUT is specified.

LIN

Each receive action initiates a scanning of the subqueues, beginning with the firstsubqueue. This is the default value for ACCESS.

RR

A "round robin" search is performed. The search resumes at the subqueue immediatelyfollowing the subqueue that provided data on the last receive.

REPLY

Specifies the external-queue-name of the queue where messages issued within thecurrent step are sent (applies to INOUT and OUT parameters only). For COBOL, thisqueue name must appear in the SYMBOLIC SOURCE field of the receiver's INPUT CD(see the COBOL 85 Language Reference Manual, Communication Section). For GPL, thequeue name must be defined in the H_CDIN. Applicable only to application-to-applicationcommunication.

Notes on Line Length and the Number of Blocks

These are network generation options. The number of blocks specifies the number oflogical lines to be inserted into a message sent to the terminal queue by the application.The line length specifies the length of the logical line.


4-110 47 A2 11UJ Rev04

4.26 RELEASE

4.26.1 Function

Removes a job from HOLD status and makes it available for scheduling.

4.26.2 Enclosure

Job.

4.26.3 Format

RELEASE job-name [{SWITCHES = {hexa8} }] [{ {PASS } }] [{ }] [{SWITCHi = {0} [SWITCHj = {0}].. .}]; [{ {1} {1} }]


The RELEASE statement is interpreted at job execution time as releasing a job which waspreviously put into HOLD status. If two or more jobs have the specified job-name and therelevant job attributes (see the Restriction below), all those jobs are released when theRELEASE is executed.

Where the job in HOLD state has a HOLD count associated with it, the effect ofRELEASE is to reduce this count by 1. The job in HOLD status is not actually releaseduntil this count becomes 0.

Severity codes returned by RELEASE are:

SEV Meaning

0 RELEASE executed successfully.

1 The job (or jobs) to be released was not in HOLD status andRELEASE is ignored.

2 No job in the system had the specified job-name and therelevant job attributes (see the Restriction below).

Restriction

The job to be released must have the same attributes (user-name, project-name) as thejob which contains the RELEASE statement.


47 A2 11UJ Rev04 4-111

4.26.5 Parameters


Job-name

Identifies the job to be released. See $JOB for a full description of this parameter.


SWITCHES

Specifies the initial value of all system switches in the released job.

The hexa8 represents a value of up to eight hexadecimal characters to which the switchesare set. If less than 8 characters are given, zeros are added on the right to make a total of8 characters.

PASS

Indicates that the values of the switches of the released job are to be set identical to thoseof the releasing job at the time that the RELEASE is executed.

SWITCHi

The specific switches listed are set to their associated values. Other switches are left asthey were on the HOLD job before RELEASE was executed.


4-112 47 A2 11UJ Rev04

4.27 REPORT

4.27.1 Function

Prints a message in the JOR (Job Occurrence Report) at execution time.

4.27.2 Enclosure

Job or Step.

4.27.3 Format

REPORT 'string110';


The REPORT statement allows you to place a message in the execution part of the JORat execution time. The message can be up to 110 characters long.

REPORT should be used instead of SEND wherever possible, in order to avoid contactingthe operator unnecessarily.

REPORT can be used, in conjunction with JUMP, to provide in the JOR a trace of theexecution of a particular job description or to summarize what has happened during theexecution of a job.


47 A2 11UJ Rev04 4-113

4.28 RUN

4.28.1 Function

Requests the execution of a job that is independent from the job issuing the RUNstatement.

4.28.2 Enclosure

Job.

4.28.3 Format

RUN

{[INFILE =] (sequential-input-file-description) } { [INDEF = (define-parameters}] } { } { {member-name} } { { } [INLIB =) (input-library-description)} { {star-name } }

[INFILE2 = (sequential-input-file-description) [INDEF2 = (define-parameters)]]



[CLASS = identifier2]

[HOLD]

[HOLDOUT]

[PRIORITY = digit1]

[JOBS = ([job-name1] [job-name2])]

[VALUES = ([parameter-value1] [parameter-value2]...] [keyword1=keyword-value1 [keyword2=keyword-value2]...])]


4-114 47 A2 11UJ Rev04

[{SWITCHES = hexa8 }] [{ PASS }] [{ }] [{SWITCHi= {0} [SWITCHj= {0} ]...}] [{ {1} {1} }]

[DELETE]

[SIZEOPT = (size-parameters)]

[STEPOPT = (step-parameters)];


The RUN statement requests the introduction into the system of a separate job streamfrom that in which the statement occurs (that is, a "spawned" job stream). The RUNstatement and the EJR operator command are identical in function. The structure of thedisk library member or sequential input file named in the RUN statement must be that ofan input job stream. The effect is as if the operator had initiated the Stream Reader toread the specified job stream.

The data format may be DATA or DATASSF. Non-native files may be used if their filecharacteristics are given by the INDEF parameter group. In all cases, file characteristicsmust be compatible with Stream Reader rules (for example, record size must not exceed255 characters). Secondary input may come from files defined by INFILE2, INFILE3 andINFILE4 if a $SWINPUT statement references them.

The JOBS parameter allows you to select a particular job or sequence of jobs from the jobstream in the named files. If JOBS is omitted, all the jobs in the stream are selected forthe input stream. Note that if Access Rights have been implemented, only an operatorproject can run a job whose user-name is different from that of the calling job.

If CLASS, PRIORITY, HOLD OR HOLDOUT are specified in the RUN, the statedparameter values override those in the $JOB statements of the selected jobs.

If only one job is submitted, the $JOB and $ENDJOB statements are not needed. Thedefault value for the job-name is the member-name (RUN member-name) or external-file-name (RUN efn). If the length exceeds 8 characters, only the first 8 characters are used.

If the VALUES parameter is used, the spawned jobs are updated with the specified valuescorresponding to the positional parameter-values or to the associated keyword-values.

If a warm restart is performed as a result of an incident which occurred during theexecution of RUN step (RUN produces its own job step), processing of the input streamwill resume from the job immediately following the last job that was successfullyintroduced into the system.

NOTE: The RUN statement defines an entire step, but is considered as part of the basicoperating system and is treated in this manual like a Basic JCL Statement.


47 A2 11UJ Rev04 4-115

4.28.5 Parameters


The only mandatory parameter group is the one which identifies the file that contains thejob stream. This may be specified as a sequential input file (optionally preceded byINFILE=) or as member (or members) of an input library (optionally preceded by INLIB=).The parameters of a sequential-input-file-description and of an input-library-descriptionare listed in Section 3.

In the case of an input library the member (that is, subfile) may be identified by itsmember-name. The member-name must not exceed 31 alphanumeric, hyphen andunderscore characters and must begin with a letter or a digit.

Alternatively the member (or members) of a library file may be identified by the star-name(see the Library Maintenance Reference Manual for an explanation of this). Essentiallythis convention permits the selection of one or more library file members according towhether their names match a specified pattern; as a special case, all members may beselected. The members selected are included in their name order (using EBCDICcollating sequence). The job description(s) in each member must be complete. The valueSYS for INLIB identifies the system library SYS.HSLLIB.


INDEF

May be used to associate define-parameters (see Section 3) with the sequential-input-filein which the job stream is stored.

INFILEi

Specify secondary input files (2<i<4) which are referenced by $SWINPUT statements.The contents of these files are included in the job stream at the position where theirrespective $SWINPUT statements occur. Specifying these on the RUN statementensures resource availability at execution time.

INDEFi

Specify the define-parameters to be associated with the file referenced by thecorresponding INFILEi (where 2<i<4).


4-116 47 A2 11UJ Rev04

CLASS

Specifies the job class of the spawned jobs (see $JOB for more information). Thespecified CLASS overrides the CLASS contained on the $JOB statements in the spawnedjob stream.

HOLD

Places the selected jobs in "hold" status (see HOLD parameter in the $JOB statement).

HOLDOUT

Holds back the output files produced by the selected jobs until the operator releases them(RO command).

PRIORITY

Specifies a scheduling priority between 0, the highest priority, and 7, the lowest priority.The selected jobs are scheduled according to this priority which overrides the priorities, ifany, specified on their $JOB statements.

Within a specified priority, jobs are scheduled on a first-in-first-out (FIFO) basis.

NOTE: Even a high priority job will not be scheduled if the maximum number of jobs inthe same class is already scheduled.

JOBS

Allows you to select a sequence of jobs from the stored job stream. Job-name1 gives thename of the first job in the sequence and job-name2 gives the name of the last job. Thusall jobs from job-name1 to job-name2 inclusive are selected from the input file. JOBSshould not be used if several members of a library file are being selected using the star-name convention.

If job-name1 is omitted, the sequence starts with the first job contained in the input file. Ifjob-name2 is omitted, the sequence finishes with the last job contained in the input file. Ifthe JOBS parameter is omitted, all jobs contained in the input file are selected for theinput stream.

NOTE: JOBS=(JBA, JBA) may be written as JOBS=JBA. This specifies that only onejob, named JBA, will be selected.


47 A2 11UJ Rev04 4-117

The above explanation can be illustrated as follows:

no JOBS parameter every job is selected.

JOBS=X or the job X is selected.JOBS=(X,X)or JOBS=(X X)

JOBS=(,X) every job up to job X (inclusive) is selected.

JOBS=(X,) every job starting from job X (inclusive) is selected.

JOBS=(X,Y) every job starting from job X up to job Y (both inclusive)or JOBS=(X Y) is selected

VALUES

Specifies the parameter values that will be passed to the JCL sequence. See the INVOKEstatement for a description of VALUES, and the JCL User's Guide for an explanation ofparameter substitution.

SWITCHES

Specifies the initial value of all system switches in the selected jobs. The hexa8represents a value of eight hexadecimal characters to which the 32 switches areinitialized, corresponding, from left to right, to switches SW0 to SW31. For example,SWITCHES=40000001 will set switches SW1 and SW31 to the value 1. If less than 8characters are given then zeros are added on the right to arrive at a total of 8 characters.

PASS

If this value is specified for SWITCHES, the values of the switches in every selected jobare set according to the values in the calling job (that is, the job which contains the RUNstatement) at the time the RUN step is executed.

SWITCHi

The switches listed are set to the values specified. Those not listed have an initial value of0 (contrast with the rule for SWITCHi in the RELEASE statement).

DELETE

Applies only if the input comes from a source library. It requests deletion of the memberafter it has been processed by the Stream Reader. If the star-name convention has beenused to select members, then they are deleted after the last one has been processed bythe Stream Reader. If a member cannot be properly processed (for example, due to apermanent I/O error) then deletion does not take place.


4-118 47 A2 11UJ Rev04

SIZEOPT

Allows you to specify size-parameters. See Section 3 and the SIZE statement.

STEPOPT

Allows you to specify parameters to control the execution of the RUN step-definingstatement. Any of the STEP parameters except DUMP=ALL, DEBUG and the OPTIONSparameter can be specified for the parameter group step-parameters.

Examples 1:

RUN DMJOB16, SYS;

This introduces the job stream contained in member DMJOB16 of the system librarySYS.HSLLIB.

Example 2:

If the RUN statement is RUN WJCIII, JSTREAM.TEST1, VALUES=(NEW.TFILE, FLSTAT=NIL), CLASS=D;

and one of the requested jobs contains: $JOB JOB1, USER=BIG, PROJECT=YIN; . . . . . . . . ASSIGN TFILE, &1, &FLSTAT;

the result will be: $JOB JOB1, USER=BIG, PROJECT=YIN, CLASS=D; . . . . . . . . ASSIGN TFILE, NEW.TFILE;

Example 3:

RUN WELL1E, MST.STRS, JOBS=(,JBX3);

This will select from the job stream in subfile WELL1E of library MST.STRS, a sequenceof jobs starting from the first one up to the job named JBX3.

Example 4:

RUN QDLY, ACCT.PROC, JOBS=(NAT1,), VALUES=(TAPE=X393);

All jobs from NAT1 to the last job in the specified job stream will be introduced to thesystem, once every occurrence of &TAPE in these jobs has been replaced by the stringX393.


47 A2 11UJ Rev04 4-119

4.29 SEND

4.29.1 Function

Sends a message text from the user to the operator.

4.29.2 Enclosure

Job or Step.

4.29.3 Format

SEND 'string105'

[{user-name}] [{MAIN }]


The SEND statement is normally used to inform the operator of certain processingrequirements, such as the need for more sort work tapes, or in conjunction with theresults of conditional JCL statement (JUMP, LET) execution. When you wish to note theresults of JCL statement execution when the operator need not be involved at the time,the REPORT statement should be used instead.

The operator concerned is the operator of the console associated with the job issuing theSEND unless either user-name is specified or a CONSOLE statement has appearedpreviously in the job description. Note that the SEND statement operates at job executiontime whereas the MESSAGE statement operates at JCL translation time.


4-120 47 A2 11UJ Rev04

4.29.5 Parameters


'string105'

The message is a string of up to 105 characters which are printable on the operatorconsole. The Command Interpreter adds the run occurrence number before the messagewhen it is sent to the operator.


user-name

Identifies a user (and therefore a terminal) that is logged to the system. If this parametervalue is omitted, the message will be displayed on the operator console associated withthe issuing job by default, or, if a CONSOLE statement has been declared previously inthe job, the message will be displayed on the console identified by the CONSOLEstatement. The user-name parameter allows you to override either of those values.

MAIN

The use of this parameter allows you to override a previous CONSOLE statement tospecify that the current message will be sent to the main operator console.


47 A2 11UJ Rev04 4-121

4.30 SIZE

4.30.1 Function

Declares the size of a working set required for the execution of a given job step.

4.30.2 Enclosure

Step.

4.30.3 Format

SIZE [declared-working-set]

[CHPPAGE = digits]

[NBBUF = digits4]

[POOLSIZE = digits];


The SIZE statement is used to declare the size of the working set, in units of 1024 (1K)bytes. The working set is the amount of memory required for code and data segmentsand process control structures. Included in these segments are data management buffersused for Input/Output operations, which are declared when the file is opened. Thereforethe SIZE statement includes segments resident in memory permanently during execution(that is, process control structures), and segments which are loaded from the backingstore as and when required during execution (that is, code and data segments).

When the system can provide the declared-working-set value stated in SIZE, as well asother resources (e.g., devices, volumes, files) step execution can be initiated. If thesystem cannot fulfil the memory requirements at step initiation, the step is "WAITINGFOR MEMORY" in the same way as it may be waiting for a device or volumes (see theJCL User's Guide). Once step execution is proceeding, the amount of memory availableto a step can vary from the stated declared-working-set value, depending on theinstantaneous load and the requirements of the executing step, except when theMAXMEM or MINMEM options of STEP are used (see STEP).

You can make an initial estimate of the memory requirements for a particular step byreferring to the value tables in the System Administrator's Manual.


4-122 47 A2 11UJ Rev04

During optimization of the declared-working-set value, the linker listing can be used toobtain values for process control structures and the number and size of code and datasegment. The Job Occurrence Report gives information relating to the memoryrequirements of the buffers. In the cases where a reasonable estimate of the declared-working-set value cannot be made, the MAXMEM option of the STEP statement can beused in conjunction with the SIZE statement to generate a graph of execution efficiency(as an inverse function of the number of missing segments stated in the JOR), against thedeclare-working-set value. The MAXMEM option informs the system that the executingstep is under going performance measurements and, whatever its load, it is never allowedmore memory than the one stated in the SIZE statement. If no value or a value less than200K is declared, size is forced to 200 KBytes.

The channel program page size default value can be overwritten in cases where achannel program overflows the 4 pages available to it.

The default size of the total UFAS buffer pool can be overwritten using the POOLSIZEparameter of SIZE: the default value may be inadequate when more than one file is beingaccessed by a step (see the UFAS-EXTENDED User's Guide).


declared-working-set

Specifies the amount of memory required in units of 1 KBytes. It includes the valuespecified, or applying by default, for POOLSIZE. The default value is 200 KBytes.

CHPPAGE

Gives the size of a channel program page in bytes. The default value is 4096 bytes(4 KBytes).

NBBUF

Specifies the number of buffers which are required for the non-swappable memory(program control structures). The number of buffers must not exceed 4,000. The defaultvalue is 50.

POOLSIZE

Specifies the maximum size of the UFAS buffer pool in units of 1 KBytes. It is included inthe value specified (or applying by default) for the declared-working-set. It must notexceed the declared-working-set value. The default value is 15 KBytes less than the valueof SIZE.


47 A2 11UJ Rev04 4-123

4.31 STEP

4.31.1 Function

Opens a step enclosure and names a load module to be executed.

4.31.2 Enclosure

Job.

4.31.3 Format

STEP

load-module-name (input-library-description)

[XPRTY = digit1]

[CPTIME ={9999999}] [ {digits7}]

[ELAPTIME ={9999 }] [ {digits4}]

[LINES ={99999999}] [ {digits8 }]

[DUMP ={NQ }] [ {DATA [PRIVATE]}] [ {ALL [PRIVATE]}]

[DEBUG [= (sequential-input-file-description)]]

[OPTIONS = 'string4096']

[REPEAT]

[{MAXMEM}] [{MINMEM}];


4-124 47 A2 11UJ Rev04


The STEP statement must be the first statement of a step enclosure. Its function is torequest the loading of the load module whose execution constitutes the job step. The loadmodule is a member of a load module library which is either a temporary library created bythe system or a permanent cataloged or uncataloged user library.

Statements that follow the STEP statement (and constitute the step enclosure) requestthe resources that are required for step execution. The STEP statement must be matchedwith a corresponding ENDSTEP statement, which must be the last statement of the stepenclosure.

4.31.5 Parameters


load-module-name

Specifies the required load module for step execution. Its length must not exceed 31alphanumeric, hyphen and underscore characters and must begin with a letter or digit.This is the first positional parameter of STEP.


Identifies the required load module library. The expansion of input-library-description isgiven in Section 3. This is the second positional parameter of STEP.

For the standard temporary library, TEMP. LMLIB, the parameter TEMP is specified.

SYS specifies the system library, SYS.HLMLIB.

4.31.5.2 Optional Parameter

XPRTY

Specifies a step execution (dispatching) priority between 0, the highest priority, and 9, thelowest priority. The default value for XPRTY is determined by the CLASS of the jobcontaining the step. The execution priority of a step can be modified by the operator.

NOTE: The system uses execution priorities between 0 and 3. Therefore, for user jobs,the recommended value for execution-priority is between 4 and 9, inclusive.


47 A2 11UJ Rev04 4-125

CPTIME

Specifies a maximum permitted CPU usage time for the step, in units of one-thousandthsof a minute. If the specified value is exceeded, the job is abnormally terminated (SEVvalue 3) and the return code TIMEOUT is produced.

The default value (9999999) means that there is effectively no limit on CPU usage time.

ELAPTIME

Specifies a maximum permitted clock-time during which the step can execute. The unit oftime is one minute. The default value (9999) means that there is no limit on the elapsedtime for step execution. If the specified value is exceeded, the job is abnormallyterminated (SEV value 3) and the return code TIMEOUT is produced.

LINES

Specifies the maximum number of printer records that may be written to each SYSOUTfile by the step. If the limit is exceeded, the job is abnormally terminated and the returncode ERLMOV is produced. The default value (99999999) means that there is effectivelyno limit.

NOTE: If several copies of a SYSOUT file are produced (see the COPIES parameter ofSYSOUT, WRITER, OUTVAL), only the first copy is taken into account for theLINES parameter.

DUMP

Specifies if a dump listing is to be produced in the event of an abnormal step termination,and if so, what its contents will be.

NO By default, no dump listing is produced.

DATA Only segments containing data are dumped.

ALL All segments of the step are dumped.

PRIVATE Only those segments private to the process (type 3) aredumped.

DEBUG

Specifies that step execution is in debug mode. The default is that step execution is innormal mode. The Program Checkout Facility (PCF) commands are retrieved from thesequential input file specified, in a batch environment. In an IOF environment thesecommands come from your console.


4-126 47 A2 11UJ Rev04

OPTIONS

Specifies a string of up to 4096 characters to be read by a user program during loadmodule execution. Refer to the appropriate User's Guide (for example, FORTRAN) fordetails about the use of OPTIONS.

REPEAT

Specifies that the step is to use the Checkpoint/Restart facilities. This provides the stepwith a recovery point (either the beginning of the step itself or a checkpoint) at which it canpossibly be restarted after a system crash or abnormal termination of a step.

If a file is specified by EFN*, a step with the REPEAT option cannot be repeated from aCheckpoint after a system crash or abnormal termination of a step.

If REPEAT is not specified, by default the step has no recovery points and cannot berestarted. In this case, calls to checkpoints are treated as dummy statements. However,the entire job can be repeated (see the REPEAT option on $JOB).

MAXMEM

If this self-identifying-parameter appears, throughout the execution of the step the systemwill limit to the value of the declared-working-set (applying by default or specified in SIZE)the memory that is available to the step. The declared-working-set is reserved for the stepbut, in addition, the total amount of memory available to the step at any instant cannotexceed the declared-working-set value. This parameter should only be used when theperformance of the step is being evaluated in order to find an optimum declared-working-set value (see JCL User's Guide).

MINMEM

MINMEM applies only to telecommunications jobs. If this self-identifying parameterappears, throughout the execution of the step the system will guarantee for the step thevalue of the declared-working-set.

Examples:

STEP MJPROG, TEMP;

STEP DMPROG, (NEW.DMLMLIB, DEVCLASS=MS/M500, MEDIA=B016);

STEP COBSTEP, NLIB.TEST, DUMP=DATA, REPEAT;

The first example names the load module MJPROG for execution. The module is to befound in the standard temporary library TEMP.LMLIB.

The second example refers to the load module DMPROG. This module is to be found inthe library NEW.DMLMLIB. This library is not cataloged and resides on the MSU0555 diskvolume B016.

The third example refers to the load module COBSTEP which is a member of the libraryfile NLIB.TEST. If the step terminates abnormally the data segments are dumped. If asystem crash occurs, the step will be repeated from the beginning of the step (or from thelast checkpoint if any has been taken).


47 A2 11UJ Rev04 4-127

4.32 $SWINPUT

4.32.1 Function

Switches input from the current input stream (or file) to another file.

4.32.2 Enclosure

Job, step, input-enclosure, data enclosure.

4.32.3 Format

$SWINPUT {[INFILE]= (sequential-input-file-description) } {member-name [INLIB =] (input-library-description) } { } { {'string105' [ANSWERS = ('string105' } } { { ['string105']...)] } } {CONSOLE = { } } { {('string105' ['string105'] ) } } { { END = 'string8' } } { };


The $ sign is mandatory and it must be in the first position of the record.

This statement is recognized and processed by the Stream Reader. The effect of a$SWINPUT statement is to cause a switch in the input stream from the current stream (orfile) to the file named in the $SWINPUT statement. Logically the effect may also beconsidered as equivalent to the removal of the $SWINPUT statements from the stream bythe Stream Reader and the replacement of each by the contents of the file which itreferences.

Temporary files and permanent files cataloged in private catalogs must not be usedunless the input stream is submitted using a RUN statement. A $SWINPUT statementcan appear anywhere within a job-enclosure, an input-enclosure or a data-enclosure; itmay be embedded in a JCL statement but it must not be embedded in a Stream Readerstatement ($JOB, $ENDJOB, $INPUT, $ENDINPUT, $DATA, $ENDDATA, $SWINPUT).

The file referred to by $SWINPUT must not contain a $ENDJOB or a $ENDDATAstatement.


4-128 47 A2 11UJ Rev04

If a $SWINPUT statement appears within an input-enclosure or data-enclosure theparameter CKSTAT must be specified on the $INPUT or $DATA statement. The end offile condition on the file to which the input has been switched causes a return to thestream containing the $SWINPUT statement.

Instead of referencing a file, a $SWINPUT statement may refer to CONSOLE input. If thejob has been generated by another job using a RUN statement, the console concerned isthat of the spawning job submitter. Otherwise the console is that of the submitter, that is,main operator, RBF operator or IOF user, the console is taken as the main operator.

Any number of $SWINPUT statements may appear in a stream, but the level of nestingcannot exceed 10. The files referenced by a $SWINPUT statement may be assignedusing the INFILE 2, INFILE 3 and INFILE 4 parameters of the RUN statement.

The $SWINPUT statement is useful in an IOF environment.

4.32.5 Mandatory Parameters

The only mandatory parameters are those which specify the file to which the input streamis to be switched. This may be done in one of the following ways, a sequential input file, amember of an input library, a CONSOLE or a DISKETTE. The meaning of each is asfollows.

sequential-input-file-description

This may be prefixed by INFILE=. It references a sequential file whose contents will beincluded in the input stream in place of the $SWINPUT statement. This parameter groupis listed in Section 3.


This may optionally be prefixed by INLIB=. It references an input-library from which amember (specified by member-name) will be selected. The contents of this member willreplace the $SWINPUT statement in the input stream. This parameter group is listed inSection 3.


47 A2 11UJ Rev04 4-129

CONSOLE

Specifies that the switched input is to come from a console. The way in which the consoleconcerned is selected is described in the STATEMENT DESCRIPTION above.

The console input may be supplied in either of the following two ways:

(1) ANSWERS option

This functions as follows: the 'string 105' preceding ANSWERS specifies the promptmessage that is sent to the console to solicit the desired input. The string followingANSWERS defines the possible valid inputs. The console operator is given threeattempts to give one of these valid replies before the job is aborted. A valid reply isinserted in the input stream in place of the $SWINPUT statement. The first validreply constitutes the only switched input in this case. If ANSWERS and the validreplies are not specified, any reply up to one record length is accepted.

(2) END option

In this case several lines of input are expected from the console. The leftmost stringis the initial prompt message sent to the console to solicit the first line of input. Thenext string is the repeat prompt message which is sent to the console to solicit thesecond and each subsequent line of input. If the second string is missing, it defaultsto the first string. Both of these are positional parameters. The string specified withEND= is the terminator line which indicates the end of the input. The data suppliedby the operator, as replies to the prompts, is not restricted to being one of a set ofvalid responses, as it is in the case of ANSWERS. The replies given before theterminator line form the switched input data which is inserted in place of the$SWINPUT statement in the original stream.


4-130 47 A2 11UJ Rev04

4.33 SYSOUT

4.33.1 Function

Requests the use of the SYSOUT mechanism for a file which is to be written in thecurrent step; notifies the Output Writer mechanism for the printing the file, known as aSYSOUT file. In addition, SYSOUT can be used to override certain standard optionsprovided by the SYSOUT mechanism for the handling of the SYSOUT file.

NOTE: A permanent sequential or library file which is associated with the specifiedinternal-file-name is called a permanent SYSOUT file. If no ASSIGN statementis associated in the current step with the internal-file-name, the system uses astandard SYSOUT subfile.

4.33.2 Enclosure

Step.

4.33.3 Format

SYSOUT internal-file-name


[PRIORITY = digit1]

[WHEN ={JOB }] [ {STEP }] [ {IMMED }] [ {DEFER }] [ {digits5}]

[HOLD ] [NHOLD ]

[NAME = identifier8]


[ {JOB }] [ {OUTPUT}] [BANLEVEL = {COPY }] [ {MEMBER}]


[COPIES = digits3]

[DEVCLASS = device-class [MEDIA = volume-name]]


47 A2 11UJ Rev04 4-131

[DEST = [host-name].station.name]

[{SLEW }] [{NSLEW}]

[{DELETE }] [{NDELETE}];


The SYSOUT statement activates the SYSOUT mechanism for writing records producedby your program; its secondary function is to inform the Output Writer how to handle theSYSOUT file, by overriding certain default output parameters defined within the system forSYSOUT files, for example:

• identification of the output;

• certain output delivery characteristics;

• the time of the notification of the Output Writer.

Standard SYSOUT Files

If no ASSIGN statement is associated in the current step with the specified internal-file-name, a temporary subfile of the standard SYSOUT file is automatically assigned by thesystem. This subfile is erased after its contents have been printed. The WHEN parametercan be used to specify when the Output Writer will be requested to output the file.

If a COBOL program contains the suffix-SYSOUT in the SELECT ... ASSIGN clause (seeCOBOL 85 Language Reference Manual, section "File Control"), the SYSOUT statementcan be omitted unless parameter are to be overridden. The SYSOUT mechanism will becalled automatically, the file name given in the program will be assigned to the standardSYSOUT file, and the records written to the file will be printed by the Output Writer, whichwill be notified by default at the end of job execution.

Permanent SYSOUT Files

The SYSOUT statement requests the SYSOUT mechanism to write the records to thepermanent file associated with the specified internal-file-name by means of an ASSIGNstatement in the current step. The Output Writer will be notified at a time governed by thevalue of the WHEN parameter to print the contents of the file - but see below for the casewhere WHEN=DEFER is specified.

If no SYSOUT statement is given for the file but a COBOL program contains the suffix-SYSOUT in the SELECT ... ASSIGN clause, the SYSOUT mechanism will be used towrite records to the file, but the file contents will not be printed; this also applies if aSYSOUT statement with the parameter WHEN=DEFER appears. In both cases, to printthe file, a WRITER statement must be included at a later stage, normally in another job.

For further information on the SYSOUT and Output Writer mechanisms, refer to the JCLUser's Guide.


4-132 47 A2 11UJ Rev04


The SYSOUT statement cannot be used to refer to the subfile that contains the JobOccurrence Report. The OUTVAL statement, described earlier, can be used instead.

The DEFINE statement can be used to override output edition parameters, for example,margin setting or form height definition. For permanent SYSOUT files written using theSYSOUT mechanism (see the comment below), all editing parameters specified byDEFINE or applying by default are incorporated into the structure of the file; this meansthat the editing parameter values will automatically apply when the file is output at a laterstage by WRITER, unless at that time the FPARAM parameter is specified (seeWRITER).

When the system allocates space for a standard SYSOUT file, a record size of greaterthan 600 bytes is established. This action is an efficiency requirement of the SYSOUTmechanism. Correspondingly, when you reserve space for a permanent SYSOUT file, thePREALLOC utility should specify a record size of greater than 600 bytes withRECFORM=VB in order to use the SYSOUT mechanism; for SYSOUT files only, thisspecification is independent of the record size declared in your program. If the space for apermanent SYSOUT file is allocated using the ALLOCATE statement, the DEFINEstatement can be used to declare the desired record size. On the other hand, if you wishto write a file with a record size of less than 600 bytes, the SYSOUT mechanism cannotbe used to edit the file; in this case, the effect of the SYSOUT statement is to output thefile according to the output and editing parameters that apply (by default, and/or inSYSOUT, and/or in DEFINE), but if you use WRITER for the file in the future, you mustrespecify those parameters. For a file with a record size of less than 600 bytes, the use ofSYSOUT with WHEN=DEFER is pointless.

4.33.5 Parameters


internal-file-name

Identifies the SYSOUT file. If no corresponding ASSIGN statement is present in thecurrent step, a subfile of the standard SYSOUT file is assigned automatically.


47 A2 11UJ Rev04 4-133


CLASS

Allows you to categorize each output file that is produced according to the requirements ofa particular output group. The associated value is a single letter of the alphabet. Eachclass has a corresponding default output priority (See PRIORITY below).

If the CLASS parameter is omitted, the default value is C. For local outputs, the defaultCLASS value can be modified either at system generation time, or by using theCATMAINT command MDS (MoDify Station).

The operator can control the production of output on a class basis. For example, if printedoutput which uses a particular type of paper is grouped into the same output class, theoperator can arrange to print all of that class at the same time. In this way, the need tochange the paper is minimized.

PRIORITY

Takes an integer value between 0 and 7 and indicates the priority of selection by theOutput Writer of the SYSOUT file, where 0 has the highest urgency and 7 the lowest.Therefore, PRIORITY specifies the ordering for the output of a SYSOUT file relative toother SYSOUT files that are waiting for the services of the Output Writer.

Within the output queue, SYSOUT files are ordered from the highest to the lowest priorityand, for a given priority, ordering of output for display is on a FIFO (first-in-first-out) basis.The default value depends on the specified output class (or the default output class), asfollows:

A B C D E F to Z

1 2 3 4 5 6

These default values may be modified at system configuration time or by the MDCoperator command. For RBF stations, they may be modified by the CATMAINT commandMDS (MoDify Station). Note that the valid priority values 0 and 7 are not used in thesedefault values, unless you specify them with the GCL command MDC OC, or by using theCONFIG or CATMAINT utilities.

NOTE: The output-priority specified here does not correspond with either thescheduling-priority of the $JOB statement, or with the step-execution-priority ofthe STEP statement.

WHEN

Specifies the point at which the Output Writer is notified that the output is to be displayed.One of the following values may be given:

JOB Notification when job execution is terminated. This is thedefault value.


4-134 47 A2 11UJ Rev04

STEP Notification when step execution is terminated. This is usefulfor multi-step jobs, since Output Writer action can take placeconcurrently with the execution of other steps of the samejob.

NOTE: If the step is repeatable; WHEN=IMMED or digit5 is replaced by WHEN=STEPto avoid duplication of output. If the job is repeatable, enqueueing is delayeduntil the end of the job.

IMMED Notification when the SYSOUT file is closed. This allowsOutput Writer action to commence before the termination ofthe step, if circumstances permit.

DEFER For a permanent SYSOUT file only; no notification is sent tothe Output Writer. The printing of the file must be requestedby a WRITER statement, normally in a different job at a latertime. When DEFER is specified, all other optional parametersexcept DEVCLASS and MEDIA are ignored.

digits5 For public SYSOUT files only, a separate SYSOUT file iscreated each time this number of pages has been output.After each such file is completed, it may be edited by theOutput Writer depending on the output class and priority. Forexample, if WHEN=100 each 100 pages of output constitutesa separate SYSOUT file. The Output Writer can processeach file (that is, 100 pages) as soon as it is complete.

NOTE: Note that the time interval between output Writer notification and thecommencement of display on the output device is clearly dependent on currentOutput Writer activity and on the priority associated with the SYSOUT file. Evenif IMMED is specified, the printing may still be delayed beyond the execution ofthe step or job.

HOLD

If this parameter appears, the Output Writer will be prevented from selecting the SYSOUTfile for display on the output device until the operator issues a RO command. Its effect isto suspend temporarily a SYSOUT file which is on the output request queue (the list, inorder of priority, of files waiting to be output by the Output Writer). Note that the HOLDparameter takes effect after the Output Writer has been notified; therefore it isindependent of the WHEN parameter. The NAME parameter should be specified whenHOLD is given, in order that the operator can identify the output from this particularSYSOUT.

NHOLD

The SYSOUT file will be output without the intervention of the operator. This parametercan be used for the current file to override a HOLD parameter in a previous OUTVALstatement.


47 A2 11UJ Rev04 4-135

NAME

Specifies a symbolic-name to be associated with the output of a SYSOUT file produced bythe Output Writer. This name can be useful in case of abnormal termination duringprinting of the output, and can be referred to in various operator commands. The name iscomposed of up to eight alphanumeric, hyphen and underscore characters and mustbegin with a letter. The use of NAME is strongly recommended if HOLD is specified.

NOTE: The system automatically provides a unique index for each unit of outputwhether or not NAME is specified. Both the symbolic-name and the index can bedisplayed on the operator's console by means of the DO command. In contrast,the system gives a special name to all DUMP outputs (for example DUMPsproduced by the COBOL DUMP facility).

BANNER

Resets the effect of a previous BANNER specification at OUTVAL level.

NBANNER

Specifies that the banner pages are not to be printed.

BANINF

Allows you to replace on the banner pages the following four standard entries used by thesystem: Run Occurrence Number (RON), User-name, job-name, Billing. Eachreplacement value may be up to 12 characters in length. If n values are specified, where nis less than or equal to 4, then the last n entries are replaced. Empty values cannot bespecified.

Example:

RON: X123, user-name: MAXI, job-name: PRIM, billing: CAP

If BANINF=(MINI, SEC, PES) is specified, the following entries will be printed:

X123 MINI SEC PES

BANLEVEL

Allows you to request the insertion of a banner between each member or copy of anoutput, or to restrict the occurrence of a banner to cases of output, baninf, or jobswitching.

Note that the banners are more detailed when they concern only one member, one copyor one output; outname, file-identification, member-name or copy-number are indicatedwhere applicable.


4-136 47 A2 11UJ Rev04

Any output which is enqueued immediately, at the end of the step or by the earlymechanism, and which is therefore eligible to be printed separately from jor jobout, isenclosed by copy level banners.

For outputs enqueued at the end of job, such as jor jobout, job level banners are insertedonly in the case of job or baninf switching, even if several copies are requested.

Note that BANLEVEL=MEMBER does not apply to outputs spooled on another site, sinceif this is the case, the members are gathered together by the server spooling mechanism.

BANLEVEL=JOB requests the insertion of a banner when job switching is detected byroute processing. However, this has no gathering action on the different outputs of thejob, and therefore should not be used for outputs that are enqueued before the end of job.

COPIES

Specifies the number of copies of the SYSOUT file data to be produced by the OutputWriter for this statement. The maximum value is 99 and the default value is 1.

DEVCLASS

Gives the device class and attributes of the output device - a printer, for example. Thedefault device class is installation dependent.

MEDIA

For a printer, the volume-name gives the print belt character set and paper identificationas a six-character value, as follows:

• characters 1-2: character set;

• characters 3-6: form number.

The default value is installation dependent.

DEST

Applies to a RBF (Remote Batch Facility) environment. It gives the RBF station or theremote host (or possibly a station of this remote host), where the output is to be delivered.If DEST is not specified, the output is delivered to the station which issued the job. TheDEFAULT CLASS, device, DEVICE CLASS and MEDIA are those of the station to whichthe output is attached.

SLEW

Any paper move instructions (slew control) are obeyed when the file is printed. This valueapplies by default in the absence of a previous OUTVAL statement with the valueNSLEW.


47 A2 11UJ Rev04 4-137

NSLEW

When the file is printed by the Output Writer, every skip function is transformed to "skip tonext line"; (that is, for the SYSOUT statement, each paper move instruction is reduced toa move to the next line).

DELETE

Applies only to a member of a permanent SYSOUT library file. If DELETE is specified, thesubfile associated with the internal-file-name is deleted once the data to be output hasbeen printed. Care should be taken with the use of this parameter, since the Output Writerdoes not check if other output requests (by SYSOUT or WRITER) are pending for this file.Normally, that is if DELETE does not appear in the current SYSOUT nor in a previousOUTVAL, no deletion of a library member occurs.

If the output concerned is cancelled by a CO [STRONG] command, any subfiles notentirely printed by the Output Writer will not be deleted.

NDELETE

Applies only to a member of a permanent SYSOUT library file; it applies by default if noprevious OUTVAL has specified DELETE. If NDELETE appears, there is no deletion ofthe subfile after the data has been output. It can be used to override for the currentSYSOUT file a DELETE parameter that appears in a previous OUTVAL statement.

Example 1:

SYSOUT LIST1, WHEN=STEP, NAME=HAJ;

This informs the Output Writer at the end of the current step to print the SYSOUT file withinternal-file-name LIST1; the name HAJ is associated with the output.

Example 2:

SYSOUT HJPRINT, BANINF=(NJOB, PROJX);

The contents of the file with internal name HJPRINT will be printed. The entries NJOB andPROJX will appear on the banner pages in place of the current job-name and billingrespectively. The RON and the user-name to be printed will be unchanged.

Example 3:

Consider the following sequence of JCL statements.

ASSIGN DMPRINT, MY.LIB, SUBFILE=TEMPA;

SYSOUT DMPRINT, COPIES=2, DELETE;

This produces two copies of library subfile TEMPA and deletes the subfile after it hasbeen printed.


4-138 47 A2 11UJ Rev04

4.34 VALUES

4.34.1 Function

Sets default values for specified parameters in the JCL statements which follow theVALUES statement.

4.34.2 Enclosure

Job, or an INVOKE sequence or an EXECUTE sequence.

4.34.3 Format

VALUES [parameter-value1 [parameter-value2] ...]

[keyword1 = keyword-value1 [keyword2 = keyword-value2]...];


The VALUES statement sets values to be used for substitution in symbolic parameterreferences in a job enclosure. These values can also be default parameter values topermit omission in a parameter list within the VALUES parameter in INVOKE, EXECUTEand RUN or for the values which can be specified in the EJR operator command. ThisVALUES statement must be contained in the JCL sequence called by INVOKE,EXECUTE, RUN or the EJR operator command. The default values apply to all followingJCL statements until another VALUES or MODVL statement, the end of the job enclosureor the end of the current sequence of JCL.

A parameter-value replaces a &1, where "i" indicates the position of the parameter-valuein the VALUES statement (1<i<99). The keyword-value replaces a &keyword.

Parameter-values are positional parameters whereas keyword-values are contained inkeyword parameters (see Section 2).

The VALUES statement cannot be used to set values in the $SWINPUT statements nor ina following VALUES statement.

A VALUES statement nullifies the preceding VALUES statement if any exists. It alsonullifies the effects of preceding MODVL statements.

See the JCL User's Guide for the rules concerning parameter substitution in JCLstatements.


47 A2 11UJ Rev04 4-139


parameter-value

The parameter-value-i defines the default value for the &i (1<=i<=99) string in an invokedJCL sequence or in a job description. This value must follow the syntax rules of theparameter(s) for which it is defined; however, it may be a protected string (that is, anycharacter string enclosed in single quotes, except that a single quote inside a string mustbe entered twice in succession) of up to 128 characters. The position of a parametervalue relative to other parameter-values in a VALUES statement defines the value of i forthe identification of the associated &1.

If commas are being used as separators, missing positional parameter values areindicated by commas without a preceding value. If spaces are being used as separators,a # sign indicates a missing positional parameter value. Missing parameters to the right ofthe last value specified need not be indicated by commas or # signs. See Example 2below.

keyword-value

The keyword-valuei defines the default value to replace every occurrence of & followed bythe specified keywordi in an invoked JCL sequence or in a job description. This valuemust follow the syntax rules of the parameter(s) for which it is defined; however it may bea protected string of up to 128 characters. The maximum length allowed for a keyword is8 characters.

Example 1:

VALUES MYFILE ,,MS/M500,STAT=TEMPRY;

The above statement defines the default values MYFILE and MS/M500 for everyoccurrence of &1 and &3 respectively and the default value TEMPRY for everyoccurrence of &STAT; by default, every occurrence of &2 will be replaced by an emptystring (that is, the parameter will be ignored). Consider the following statement:

ASSIGN IFN&2A, &1, DEVCLASS=&3, MEDIA=ABC, &STAT;

Provided the default values specified in the above VALUES statement are not overridden(that is, by a RUN statement), the ASSIGN statement becomes:

ASSIGN IFNA, MYFILE, DEVCLASS=MS/M500, MEDIA=ABC, TEMPRY;

Example 2:

There are 10 positional parameters (&1 through &10), and values p2, p4, p6 are to bespecified for the 2nd, 4th and 6th (that is, &2, &4, &6) respectively. The following 4VALUES statements are equivalent:

VALUES , p2,, p4,, p6,,,,;

VALUES , p2,, p4,, p6;

VALUES # p2 # p4 # p6 # # # #;

VALUES # p2 # p4 # p6;


4-140 47 A2 11UJ Rev04

4.35 WRITER

4.35.1 Function

Requests the Output Writer mechanism for use with an existing permanent SYSOUT file.

4.35.2 Enclosure

Job.

4.35.3 Format

WRITER { (sequential-input-file-description) { } { [{PART = (ai [:bi] [ai+1 [:bi+1]] ...) }] } { [{ }] } { [{SELECT = ( [ron [ : index ]] ...)}] } { [{ output-name }] } { } {(input-library-description) } { } { SUBFILES = ({member-name [member-name] ...} } { {star-name [star-name]... })}


[PRIORITY = digit1]

[WHEN ={JOB }] [ {IMMED}]

[{HOLD }] [{NHOLD}]

[NAME = identifier8]


[ {JOB }][ {OUTPUT}][BANLEVEL = {COPY }][ {MEMBER}]


[COPIES = digits2]


47 A2 11UJ Rev04 4-141

[DEVCLASS = device-class [MEDIA = volume-name]]

[DEST = [host-name].station-name]]

[DATAFORM ={SSF [REPORT = {string 2}]}] [ {SARF {ALL } }] [ {DOF }] [ {ASA }]

[NUMBER]

[{FPARAM }] [{NFPARAM}]

[{SLEW }] [{NSLEW}]

[{DELETE }] [{NDELETE}]

[PRINTER = {printer-options)] ;

where the format of 'printer-options' is given in the description of the DEFINEstatement.


The WRITER statement requests the use of the Output Writer mechanism for an alreadyexisting permanent SYSOUT file, on disk or on tape. The file may be UFAS sequential ora library file, cataloged or uncataloged, and may or may not have been created with theSYSOUT mechanism. The WRITER statement is often specified in a job other than theone in which the file was created. Reference is made to the SYSOUT mechanism in theSYSOUT statement description above; a more detailed explanation is given in the JCLUser's Guide.

The WRITER statement allows you to specify non-standard values for output-editingparameters (for example, margin setting, printing density) and for output handling (forexample, output destination, number of copies).

Specific pages of the SYSOUT file or specific subfiles of a SYSOUT library file can beselected for output.


Any value of the output handling parameters (for example, DEST, COPIES) specified, forexample with a SYSOUT statement, when the file was written, applied only for the jobstep during which the file was written. If you wish to override any of the standard values ofthese parameters, the new values must be specified in the current WRITER statement.


4-142 47 A2 11UJ Rev04

If the file to be output was written using the SYSOUT mechanism, any editing parameters(that is, PRINTER) given in this WRITER statement would be ignored. In other words, it isassumed that the original specifications given when the file was written still apply.However, if you wish to override the original specifications (applied by default, orcorresponding to the MEDIA value given in the SYSOUT statement, or as specified by aDEFINE statement), the FPARAM parameter must be given in the WRITER statement.

The WRITER statement may only occur in a job enclosure outside a step enclosurewhereas the SYSOUT statement only occurs inside a step enclosure.

The action of the Output Writer to print the specified file is not necessarily synchronouswith the execution of the job which contains the WRITER statement. Therefore apermanent SYSOUT file should not be deleted (for example, using DEALLOC) in thesame job as the request to output its contents (or even in later jobs if sufficient time hasnot elapsed), as there is a danger that the file will be deallocated before it has beencompletely printed. For this reason, a temporary file or an input enclosure is not permitted.Therefore, see the description of the DELETE parameter for the SYSOUT statement.

4.35.5 Parameters


Either sequential-input-file-description or input-library-file-description, but not both, mustappear.

The sequential-input-file-description identifies a sequential file (or a single library member)to be output by the Output Writer. The expansion of this parameter group is given inSection 3. Note that this file description can identify a single library member with theSUBFILE parameter.

In this case, it is possible to:

• print just certain pages (with the PART parameter) or;

• print several copies (with the COPIES parameter) or;

• select the reports(s) to be printed (with the SELECT parameter), if the file concernedhas been produced by the Output Writer.

Example:

WRITER (.MYLIB,SUBFILE=S1), COPIES=6;

The member S1 of the cataloged library file .MYLIB is printed 6 times.

The input-library-file-description identifies the library which contains the subfiles (specifiedby the SUBFILES parameter described below) that are to be output by the Output Writer.The expansion of this parameter is given in Section 3.


47 A2 11UJ Rev04 4-143

SUBFILE

Applies only to library files. It selects for printing the required subfiles of the specifiedlibrary file. The contents of all named library members are output. By the use of the starconvention (see the Library Maintenance Reference Manual), any number of families ofsubfiles may be selected.

In this case, the PART, SELECT, and COPIES parameters are not applicable.

Example:

WRITER (.MYLIB), SUBFILES=(S1, S2, S3);

The members S1, S2, and S3 of the cataloged library file .MYLIB are printed.

If a single subfile is to be printed, then it is more efficient to do this with a sequential-input-file-description rather than with an input-library-file-description.


See the description of the parameters of the SYSOUT statement for an explanation of allthe parameters not included below (that is, the output handling parameters CLASS,PRIORITY, HOLD, NHOLD, NAME, BANNER, NBANNER, BANINF, DEVCLASS, MEDIA,DEST, SLEW, NSLEW, DELETE, NDELETE).

PART

Allows you to define which part or parts of the specified file (or simple library subfile) is/areto be output. Each value pair (ai: bi) specifies the required part in terms of the first and lastpages of the file to be output. Each value supplied must be a digit or a string of digits. Thedefault value of any bi is ai. A list of value pairs, separated by commas, must appear inascending order of page number (that is, the value of ai must be less than or equal to thevalue of bi, and the value of bi must be less than the value of aj where j = i+1). In the lastpair (ai : bi), bi may take the value $ to mean that the upper limit is the end of file. In thiscase, the ai is necessary and it cannot take the value $.

Example:

PART=(4:7, 9, 11:11, 13:$)

This example specifies page 4, 5, 6, 7, 9, 11, and 13 to end of file. Note that the secondpage specification could have been written 9:9 and the third could have been written 11.Note that the last pair is valid even if 13 happens to be the end of file. However, the lastpair cannot be written $:$ or $.


4-144 47 A2 11UJ Rev04

SELECT

Specific reports of a job may be selected by run occurrence number (ron), or by indexwithin ron, or by output-name within ron. The SELECT parameter applies only if thespecified file was produced with the Output Writer. If the specified value is a runoccurrence number (ron) all outputs from the job with that ron are printed. If the value is ofthe form ron:output-name, the named output from the job with the specified ron is printed.If the value is of the form ron: index, the output with the specified index from the job withthe specified ron is printed. (See the description of the SYSOUT statement, NAMEparameter, for a brief explanation of the output index).

COPIES

Specifies the number of copies to be produced. The maximum value is 99, and the defaultis 1. COPIES has no effect if SUBFILES or PART is specified. COPIES is also ineffectiveif the file to be processed by WRITER has been created by the Output Writer.

WHEN

Specifies the point at which the Output Writer is notified that the output is to be printed.One of the following values is specified:

JOB Notification when job execution is terminated. This is thedefault value.

IMMED Notification as soon as the WRITER statement is executed.

Note that the time interval between Output Writer notification and the commencement ofdisplay on the output device is clearly dependent on current Output Writer activity and thepriority of the job class associated with the SYSOUT file. Even if IMMED is specified, theprinting may still be delayed beyond the execution of the job.

DATAFORM

Applies only if the SYSOUT mechanism was not used when the file was written. It isignored for SYSOUT files in SYSOUT format. DATAFORM overrides the output dataformat computed by WRITER. This is only useful for ASA outputs as SSF and DOFrecords are automatically recognized by WRITER. SARF is assumed when the file is inneither SSF nor DOF format.

SSF The records of the SYSOUT file contain data and an SSFheader. This is the default.

SARF The records of the SYSOUT file contain pure data only.

DOF This must be specified when printing a 100 Program Modepermanent SYSOUT file. It is a device-dependent dataformat.

ASA The records of the SYSOUT file contain data and a one-byteASA header (that is, slew-control byte). This first characterindicates the skip function to be performed during outputprocessing of the record. See the Unit Record Devices User'sGuide for details.


47 A2 11UJ Rev04 4-145

REPORT

Applies to files created by the COBOL Report Writer. When a value (two characters long)is supplied it becomes the record-identification-code; only records that are preceded bythis code are taken into account by WRITER. The record-identification-code is notdisplayed when a record is output. If any characters other than alphanumeric ones areused for the code value, they must be enclosed in quotes. If the REPORT parameter isomitted, any record-identification-codes that exist are displayed (that is, the records areoutput in full).

ALL If this value is specified for REPORT, every record of the fileis output, irrespective of the presence of a record-identification-code. The record-identification-code is notdisplayed. This is the default.

WARNING

For the use of the Record Selection feature of the COBOL ReportWriter, the file to be output must be in SSF format. Therefore theSYSOUT mechanism must not be used (when the file is written) to editthe file to SYSOUT format (see the SYSOUT statement above and theJCL User's Guide for details of the SYSOUT mechanism).

NUMBER

Applies only if SSF source library members are being printed. It specifies that the linenumber (in the SSF header) must also be edited. This parameter is only available for non-temporary libraries.

FPARAM

Applies only to files in SYSOUT format (that is, edited with the SYSOUT mechanism).This parameter is required if any editing parameters (PRINTER) which have beenspecified in this WRITER statement are to be obeyed. If FPARAM is omitted, the originalspecifications at the time of file writing will apply even if PRINTER is given in the WRITERstatement. In other words, FPARAM is used to force the current editing parameters.

NFPARAM

The opposite of FPARAM. Editing parameters currently being supplied are not valid forfiles already in SYSOUT format. This is the default if FPARAM is not specified.


4-146 47 A2 11UJ Rev04

PRINTER

Applies to files in SYSOUT format provided FPARAM is specified, and to files not writtenin SYSOUT format. The parameter values supplied here override those that apply bydefault (and, in the case of files in SYSOUT format when FPARAM is specified, thoseapplied by DEFINE at file creation).

printer-options Allow you to specify editing parameters for files to be outputon a line printer. See the DEFINE statement for thedescriptions of the parameters (but note that SLEW andNSLEW are not included in the PRINTER parameter set forWRITER - see the WRITER format above).

Examples:

WRITER HJ.REPS, COPIES=3;

This prints 3 copies of the permanent SYSOUT file HJ.REPS.

WRITER NOV.FIGS, PRINTER=(PRDEN=8, FORMHT=80);

Assuming that the file NOV.FIGS was not written with the SYSOUT mechanism, thisWRITER statement prints its contents, setting the print density to 8 lines per inch and thevalue of FORMHT to 80.

47 A2 11UJ Rev04 5-1

5. Extended JCL Statements

The extended Job Control Language is similar in format to the basic Job ControlLanguage. However, each extended JCL statement is usually expanded into a step.Therefore, except for SORTWORK and GSORTWK, you must never write the statementinside a step enclosure. The rules for writing basic JCL also apply to writing extended JCLstatements.

The extended JCL statements are shown in alphabetical order in Table 5-1 on thefollowing pages. Note that the extended JCL statements EXDIR, EXECUTE, and RUN,are described in Section 4 of this manual (they are treated as Basic JCL Statements).

In Table 5-1, the Statement column lists the name of the extended JCL statement. TheDocument column gives the reference code of the manual in which you can find detailedinformation about the statement. The Function column gives a brief description of theextended JCL statement. The document reference codes are explained in Table 5-2.


5-2 47 A2 11UJ Rev04

Table 5-1. Extended JCL Statements (1/3)

Statement Document FunctionBINDER BIUG Enables execution of Binder commands.C CLUG Compiles a C source programCATALOG CATM Places an object (file or directory) in a catalog.CATBUILD CATM Creates a private catalog.CATCHECK CATM Checks the validity of catalog structures.CATDELET CATM Deletes a private catalog.CATEXTD CATM Increases the size of a catalog.CATLIST CATM Lists catalog structures.CATMAINT SADM Creates, modifies and deletes information in

the site catalog.CATMODIF CATM Modifies the description of a file in a catalog.CATMOVE CATM Moves (copies) structures from one catalog to

another.CBL COUG Compiles a COBOL source program.CMDMGT GCPM Compiles GCL source procedures.COMPARE DMUT Compares logically the contents of two

separate files and prints the differences.CREATE DMUT (1) Loads or reorganizes a UFAS file.

(2) Copies an IDS/II file.DEALLOC DMUT Re-allocates the space previously allocated to

a disk, diskette or cataloged tape file.DMLPROC IDUG Pre-processes a COBOL program that

contains DML statements.DUMPJRNL TDSU Extracts the OWN data of a TDS user from

the After Journal and appends them to a TDSUser Journal File.

FILALLOC DMUT Preallocates space for any kind of disk file.FILCHECK DMUT Ensures that a sequential or library disk file

may be processed by the standard accessmethods.

FILDUPLI DMUT Copies the contents of a source file intoanother file of identical type.

FILLIST DMUT Lists selected subsets of the label, catalog andusage information of a specified file.

FILMAINT DMUT (1) Changes data or control structures insidethe physical records of a disk file.(2) Dumps the physical records of a nativedisk or tape file.

FILMODIF DMUT (1) Changes the name and/or expiration dateof a disk or diskette file.(2) Modifies the catalog status of a disk ortape file.(3) Clears data from a disk or diskette file.

FILREST DMUT Restores the contents of a disk file from a tapefile or a sequential UFAS disk file.

Extended JCL Statements

47 A2 11UJ Rev04 5-3


Statement Document FunctionFILSAVE DMUT Saves the entire contents of a disk file onto a

tape file.FILTFR UFTG Transfers a file to a remote site, and may

create, rename, or delete the file.FORMGEN FOUG Invokes the Format Generator Utility program

which generates forms to be used on ascreen.

FOR77 F7UG Compiles a FORTRAN77 source program.GPL GPUG Compiles a native GPL source program.GSORT SMUG Concatenates up to 9 input files and sorts the

resulting file according to keys specified in aseparate file.

GSORTWRK SMUG Specifies the device type (tape or disk) andamount of work space to be allocated whenthe SORT utility is dynamically invoked (e.g.through the SORT verb) within a userprogram.

JAGEN TDSU Calls the After Journal MaintenanceProcessor.

JASMAINT FRFU Enables execution of JAS maintenancefunctions.

LIBALLOC DMUT Requests space allocation for user libraries.LIBDELET DMUT Deletes a library and deallocates its space or

erases the contents of its directory andmembers while retaining the library space.

LIBMAINT LMRM Calls the library maintenance processorLINKER LKUG Links one or compile units into an executable

load module.MERGE SMUG Merges up to 8 input files according to keys

specified in a separate file.MIRFIL DMUT Duplicates the contents of a MIRROR ALONE

disk to an empty standard FBO-formatteddisk, creating a pair of mirrored disks.

MIRSTART DMUT Creates a pair of mirrored disks from twostandard non-MIRROR FBO-formatted diskswithout any files.

PASCAL PAUG Compiles a native PASCAL source program.PREALLOC DMUT Allocates space for a disk or cataloged tape

file.PRINT DMUT Prints records from a file.ROLLFWRD TDSU Brings restored files to restart point by using

the After Journal.SETLIST DMUT Produces a report which displays the names

of all the member files of file-sets and showsthe pairing of input and output files.


5-4 47 A2 11UJ Rev04


Statement Document FunctionSHIFT CATM Updates the generation group of a cataloged

file.SORT SMUG Concatenates up to 9 input files and sorts the

resultant file according to keys specified in aseparate file.

SORTIDX DMUT Sorts and loads the secondary indexes of aUFAS indexed sequential file.

SORTWORK SMUG Specifies the device type (tape or disk) andamount of work space to be allocated whenthe SORT utility is dynamically invoked (e.g.through the SORT verb) within a userprogram.

SYSMAINT TDAG Enables execution of system maintenancecommands.

TAPEPREP DMUT Labels and formats a tape volume for use byGCOS, or removes the existing standardlabels.

UNCAT CATM Removes an object from a catalog.URINIT GSOG Updates the system file that contains unit

record device control parameters.VOLCHECK DMUT Checks the integrity of a disk volume.VOLCOMP DMUT Compares two tape or disk volumes of the

same type and reports the differences.VOLDUPLI DMUT Copies the contents of an entire disk or tape

volume onto another volume of the same type.VOLLIST DMUT Lists the contents of a native disk, or tape

volume.VOLMAINT DMUT Displays physical records from a named disk,

diskette or tape volume. It can also modify thephysical records of a disk volume.

VOLMODIF DMUT (1) Declares defective tracks on disk volumeswithout deleting the files on the volume.(2) Formats free-extent disk areas;(3) Resets the sequential allocation flag ondiskette volumes.

VOLPREP DMUT Labels and formats a disk or tape volume foruse by GCOS, or removes the existingstandard labels.

VOLREST DMUT Restores the contents of a disk volume from atape file.

VOLSAVE DMUT Saves the contents of a disk volume into anative labelled tape file.

VSETLIST ASMG Produces a list of all the volumes in theconfiguration, showing the space usage andavailability.

Extended JCL Statements

47 A2 11UJ Rev04 5-5

Table 5-2. Explanation of Document Codes used in Table above

Code Manual NameASMG Administering the Storage Manager Guide 47 A2 36UFBIUG Binder User's Guide 47 A2 11UPCATM Catalog Management Manual 47 A2 35UFCLUG C Language User's Guide 47 A2 60ULCOUG COBOL 85 User's Guide 47 A2 06ULDMUT Data Management Utilities Manual 47 A2 34UFF7UG FORTRAN 77 User's Guide 47 A2 16ULFSEG Full Screen Editor User's Guide 47 A2 06UPFOUG FORMS User's Guide 47 A2 15UJFRFU File Recovery Facilities User's Guide 47 A2 37UFGCPM GCL Programmer's Manual 47 A2 36 UJGPUG GPL User's Guide 47 A2 36ULGSOG GCOS 7-V8 System Operator's Guide 47 A2 53USIDUG IDS/II User's Guide 47 A2 12UDIDUG Full IDS/II User's Guide 47 A2 07UDLKUG Linker User's Guide 47 A2 10UPLMRM Library Maintenance Reference Manual 47 A2 01UPPAUG PASCAL User's Guide 47 A2 52ULSADM System Administrator's Manual 47 A2 54USSMUG Sort/Merge User's Guide 47 A2 08UFTDAG TDS Administrator's Guide 47 A2 32UTTDSU TDS COBOL Programmer's Guide 47 A2 33UTUFTG UFT User's Guide 47 A2 13UC


5-6 47 A2 11UJ Rev04

47 A2 11UJ Rev04 A-1

A. JCL Statement Names and Abbreviations

This appendix lists, in alphabetical order, the names of all Basic and Extended JCLstatements for which standard abbreviations exist. The acceptable abbreviation(s) is givennext to each statement.

Examples of job descriptions, first with complete statements, and then with abbreviatedstatements, are given at the end of this appendix.

NOTES: 1. The names of statements are given in complete form throughoutthis JCL Reference Manual, and in GCOS 7 documentation ingeneral.

2. Not all JCL statements have acceptable abbreviations.


A-2 47 A2 11UJ Rev04

Table A-1. JCL Statement Names and Abbreviations (1/2)

Statement Name Abbreviation(s)ALLOCATE ALCASSIGN ASGATTACH ATTCATALOG CATCATBUILD CBDCATCHECK CCKCATDELET CDLCATEXTD CEXTCATLIST CLSCATMAINT CMNCATMOVE CMVCOBOL CBLCOMMENT COMMCOMPARE CMPCONSOLE CNSLCREATE CRDEALLOC DALCDEFINE DEFDMLPROC DMLPENDDATA EDATAENDINPUT EINENDJOB EJOBENDSTEP EST ESTPEXECUTE EXCFILCHECK FCKFILDUPLI FDUPFILMODIF FMODFILREST FRSTFILSAVE FSVFORTRAN77 F7CINPUT ININVOKE IVK IVJASMAINT MNJASLABEL LBLLIBALLOC LALCLIBDELET LDLLIBMAINT LMNLINKER LINK LKMERGE MRGMESSAGE MSGMODIFY MODMODVL MVLOUTVAL OVL

JCL Statement Names and Abbreviations

47 A2 11UJ Rev04 A-3

Table A-2. JCL Statement Names and Abbreviations (2/2)

Statement Name Abbreviation(s)PREALLOC PALCPREFIX PFXPRINT PRQASSIGN QASGRELEASE RLSREPLACE REPLREPORT RPTSFLIST SFLSSHIFT SHFSIZE SZSORTFMT SFMTSORDIDX SIDXSORTWORK SWKSTEP STPSWINPUT SWISYSOUT SYOUNCAT UNCVALUES VALUE VLVOLCHECK VCKVOLCOMP VCMPVOLDUPPLI VDUPVOLPREP VPRPVOLREST VRSTVOLSAVE VSVWRITER WR


A-4 47 A2 11UJ Rev04

Examples of Job Descriptions

Example 1, with statement names given in full:

$JOB SCOTTY, USER = TOM, PROJECT = ONE; OUTVAL; OUTVAL COPIES = 2; STEP TSTA, MST.CDM; ASSIGN IN99, .DAT99; ASSIGN SCR99, .ERR99; ENDSTEP; JUMP CONTINUE; JUMP END, SEV, LT, 3; WRITER .ERR99; END:$ENDJOB;

Example 2, with abbreviated statement names:

$JOB SCOTTY, USER = TOM, PROJECT = ONE; OVL; OVL COPIES = 2; STP TSTA, MST.CDM; ASG IN99, .DAT99; ASG SCR99, .ERR99; EST; JUMP CONTINUE; JUMP END, SEV, LT, 3; WR .ERR99; END:$ENDJOB;

47 A2 11UJ Rev04 B-1

B. Character Conversion

This appendix contains conversion tables for the Extended Binary-Coded DecimalInterchange Code (EBCDIC) codes, and the American Standard Code for InformationExchange (ASCII) hexadecimal codes.

These tables also give the COBOL collating sequences, and the corresponding graphicrepresentations or meanings, as interpreted internally by the DPS 7000 system.


B-2 47 A2 11UJ Rev04

B.1 ASCII

ASCI IEBCDIC

COBOL C / SCode : S ymbol

00010203

04050607

08090A0B

0C0D0E0F

10111213

14151617

18191A1B

1C1D1E1F

20212223

24252627

00010203

372D2E2F

1805250B

0C0D0E0F

10111213

3C3D3226

18193F27

1C101E1F

404F7F7B

5B6C5Q7D

1234

56464748

2363812

13141516

17181920

61625139

25266440

29303132

6580128124

9210981126

NULSOHSTXETX

EOTENQACKBEL

BSVHTVLFVVTV

FFVCRVSOVSI V

DLEDC1DC2DC3

DC4NAKSYNETB

CANEMVSUBESC

FSVGSVRSVUSV

V| |"#

$%&'

ASCI IEBCDIC


ASCI IEBCDIC


D enotes that no contro l codeor graph ic sym bol is p resent

C O B O L C /S denotes "co lla ting sequence",obta ined from the dec im al convers ion o fthe E B C D IC hexadec im al va lue, then add 1 .

28292A2B

2C2D2E2F

30313233

34353637

38393A3B

3C3D3E3F

40414243

44454647

48494A4B

4C4D4E4F

4D5D5C4E

68604861

F0F1F2F3

F4F5F6F7

F8F97A5E

4C7E6E6F

7CC1C2C3

C4C5C6C7

C8C9D1D2

D3D4D5D6

78949379

108977698

241242243244

245246247248

24925012395

77127111112

125194195196

197198199200

201202210211

212213214215

()°+

'-./

0123

4567

89:;

<=>?

0ABC

DEFG

HIJK

LMNO

50515253

54555657

58595A5B

5C5D5E5F

60616263

64656667

68696A6B

6C6D6E6F

70717273

74757677

D7D8D9E2

E3E4E5E6

E7E8E94A

E05A5F6D

79818283

84858687

88899192

93949596

979899A2

A3A4A5A6

216217218227

228229230231

23223323475

2259196110

122130131132

133134135136

137138146147

148149150151

152153154163

164165166167

PQRS

TUVW

XYZ[ c

\] !^-

.abc

defg

hijk

lmno

pqrs

tuvw

Ø

Character Conversion

47 A2 11UJ Rev04 B-3

ASCIIEBCDIC

COBOL C/SCode : Symbol

ASCIIEBCDIC


ASCIIEBCDIC


D enotes that no contro l codeor graph ic sym bol is present

C O B O L C /S denotes "co lla ting sequence",obta ined from the decim al convers ion o fthe E B C D IC hexadecim al va lue, then add 1 .

ú

ÓÕ

ÓÕ

ú

ò

ASCIIEBCDIC


F0F1F2F3F4F5F6F7

F8F9FAFBFCFDFEFF

78797A7B

7C7D7E7F

80818283

84858687

88898A8B

8C8D8E8F

90919293

94959697

98999A9B

9C9D9E9F

A7A8A9C0

6AD0A107

20212223

24150617

28292A2B

2C090A1B

30311A33

34353608

38393A3B

04143EE1

168169170193

1072091628

33343536

3722724

41424344

45101128

49502752

5354559

57585960

52163223

xyz{

|}-DEL

A0A1A2A3

A4A5A6A7

A8A9AAAB

ACADAEAF

80818283

84858687

8889BABB

BCBDBEBF

C0C1C2C3C4C5

41424344

45464748

49515253

54555657

58596263

64656667

68697071

72737475

767778808A8B

66676869

70717273

74828384

85868788

899099100

101102103104

105106113114

115116117118

119120121129139140

aaa

aaaç

néèë

èfîï

iBAÄ

AAAA

N

ÊË

ÎÏÏÏ

C6C7C8C9CACB

CCCDCECFD0D1

D2D3D4D5D6D7

D8D9DADBDCDD

DEDFE0E1E2E3

E4E5E6E7E8E9

EAEBECEDEEEF

8C8D8E8F909A

9B9C9D9E9FA0

AAABACADAEAF

808182838485

868788898A8B

BCBDBEBFCACB

CCCDCECFDADB

141142143144145155

156157158159160161

171172173174175176

177178179180181182

183184185186187188

189190191192203204

205206207208219220

Y

°a

°

o

i

D

Ø

~

Ç

Ø

ÈÍ

«»

¶

±

æ

Æ

¿

•

γ

µ

ρ

ρ

É

÷

£

.°§

--.x

¶

γ

¿

¼½¾

û

3

òóõ

DCDDDEDFEAEBECED

EEEFFAFBFCFDFEFF

221222223224235236237238

239240251252253254255256

üù

ÿ2

3üù

u

ô

ö


B-4 47 A2 11UJ Rev04

B.2 EBCDIC

ASCIIEBCDIC


00010203

04050607

08090A0B

0C0D0E0F

10111213

14151617

18191A1B

1C1D1E1F

20212223

24252627

00010203

9C09867F

978D8E0B

0C0D0E0F

10111213

9D850887

1819928F

1C101E1E1F1F

80818283

840A171B

1234

5678

9101112

13141516

17181920

21222324

25262728

29303132

33343536

37383940

NULSOHSTXETX

HTV

DEL

VTV

FFVCRVSOVSIV

DLEDC1DC2DC3

BSV

CANEMV

FSVGSVRSVUSV

LFVETBESC

ASCIIEBCDIC


ASCIIEBCDIC


D enotes that no contro l codeor graph ic sym bol is p resent

C O B O L C /S denotes "co lla ting sequence",obta ined from the decim al conversion o fthe E B C D IC hexadec im al va lue, then add 1 .

28292A2B

2C2D2E2F

30313233

34353637

38393A3B

3C3D3E3F

40414243

44454647

48494A4B

4C4D4E4F

88898A8B

8C050607

90911693

94959697

98999A9B

14159E1A

20A0A1A2

A3A4A5A6

A7A85B2E

3C282B21

41424344

45464748

49505152

53545556

57585960

61626364

65666768

69707172

73747576

77787980

ENQACKBEL

SYN

EQT

DC4NAK

SUB

v

äa

à

ç

[ ç.

<(+! ]

50515253

54555657

58595A5B

5C5D5E5F

60616263

64656667

68696A6B

6C6D6E6F

70717273

74757677

26A9AAAB

ACADAEAF

80815D24

2A293B5E

2D2FB2B3

B4B5B6B7

B8B97C2C

255F3E3F

BABBBCBD

BEBFC0C1

81828384

85868788

89909192

93949596

979899100

101102103104

105106107108

109110111112

113114115116

117118119120

&éêë

è

îï

i

] !$

°);

-/

Ä

ç

|.

%->?

Ë

Ï

Ø

áãå

ñ

ÈÌÍ

ÉÈ

Ñ

ÅÃ

Å

ÁÅ

^

ì

ß

Character Conversion

47 A2 11UJ Rev04 B-5

ASCIIEBCDIC


ASCIIEBCDIC


ASCIIEBCDIC


D enotes that no contro l codeor graph ic sym bol is present

C O B O L C /S denotes "co lla ting sequence",obta ined from the decim al convers ion o fthe E B C D IC hexadecim al va lue, then add 1 .

ASCIIEBCDIC


F0F1F2F3F4F5F6F7

F8F9FAFBFCFDFEFF

78797A7B

7C7D7E7F

80818283

84858687

88898A8B

8C8D8E8F

90919293

94959697

98999A9B

9C9D9E9F

C2603A23

40273D22

C3616263

64656667

6869C4C5

C6C7C8C9

CA6A6B6C

6D6E6F70

7172CBCC

CDCECFD0

121122123124

125126127128

129130131132

133134135136

137138139140

141142143144

145146147148

149150151152

153154155156

157158159160

\:#

0'=

0abc

defg

hi

y

°jkl

mnop

qr°°

o

A0A1A2A3

A4A5A6A7

A8A9AAAB

ACADAEAF

80818283

84858687

B8B9BABB

BCBDBEBF

C0C1C2C3C4C5

D17E7374

75767778

797AD2D3

D4D5D6D7

D8D9DADB

DCDDDEDF

E0E1E2E3

E4E5E6E3

7B4142434445

161162163164

165166167168

169170171172

173174175176

177178179180

181182183184

185186187188

189190191192

193194195196197198

m-st

uvwx

yzi

DY

c£

.

o§

I

-".x

{ABCDE

C6C7C8C9CACB

CCCDCECFD0D1

D2D3D4D5D6D7

D8D9DADBDCDD

DEDFE0E1E2E3

E4E5E6E7E8E9

EAEBECEDEEEF

46474849E8E9

EAEBECED7D4A

4B4C4D4E4F50

5152EEEFF0F1

F2F35C9F5354

55565758595A

F4F5F6F7F8F9

199200201202203204

205206207208209210

211212213214215216

217218219220221222

223224225226227228

229230231232233234

235236237238239240

~

3031323334353637

3839FAFBFCFDFEFF

241242243244245246247248

249250251252253254255256

«

»

»

ρ±

Ì

∂

æ

Æ

¿

ρ•

γ

¶¼

½¾¿

FGHI

ô

ö

ö}J

KLMNOP

QRIûü

üÿ\+ST

UVWXYZ

2ÔO

Ö

01234567

893UÜ

ù

ÒÓ

Ò

ÙÚ

Ó


B-6 47 A2 11UJ Rev04

47 A2 11UJ Rev04 g-1

Glossary

basic JCL statement A statement that requests a specific system operation.

batch job A job that runs without user intervention.

boolean parameter A parameter that takes only the values 0 (NO) or 1 (YES).

cartridge library A cartridge storage module equipped with a robot to performthe mounting/dismounting operations. Allows unattendedcartridge operations.

catalog A file that records the links between a master directory and itsfiles.

compaction A hardware recording mode on cartridge, following the IDRCstandard (Improved Data Recording Capability), andincreasing the effective cartridge data capacity.

control interval (CI) The unit of transfer between main memory and a file on disk.

conventional batch job A job that runs sequences of Job Control Language (JCL)statements.

CU library Compiled Unit library - a library that holds compiledprograms.

data enclosure The part of a job beginning with a $DATA statement andending with a $ENDDATA statement, that contains data to beloaded into a specific library.

data field A unit of information belonging to a record.

device class Specifies the type of disk, cartridge, tape drive.

directory A group of files in a hierarchical tree structure.

EJR See ENTER_JOB_REQUEST operator command.

ENTER_JOB_REQUEST operator commandRequests the execution of one or more jobs or submits ajobset request.

E-tape Enhanced-capacity half-inch cartridge tape (0.5 mil thick,1100 feet long), it is also called long tape or thin tape. Is twotone colored and can only be used on 36-track devices.


g-2 47 A2 11UJ Rev04

EXECUTING state The job state where an IN SCHEDULING job is executed.

extended JCL statement A statement that expands into a set of basic JCL statementsand is equivalent in itself to a complete step description.

file status Describes whether a file is catalogued, uncatalogued ortemporary.

file The basic unit of information maintained by the operatingsystem.

first in, first out (FIFO) Priority order whereby the first job to enter is treated first bythe system.

full path name The complete name of a file, which includes the name(s) ofthe directory(ies) where it is located.

GCL See GCOS 7 Command Language.

GCOS 7 Command LanguageThe set of commands used by IOF terminal users to managethe GCOS 7 functions on the DPS 7000.

GCOS 7 General Comprehensive Operating System - operatingsystem for the DPS 7000.

HJ See HOLD_JOB operator command.

HOLD_JOB operator commandAn operator command that puts a job in the HOLD state.

HOLD state The job state where a job is temporarily suspended by aHOLD command.

IDLE state Job state for the service jobs JCL Translator and WRITERwhen they are not active.

IN SCHEDULING state The job state where a job is ready for execution.

input enclosure The part of a job beginning with a $INPUT statement andending with a $ENDINPUT statement, that contains datarecords to be associated with one or more steps in the job.

input library A library used to read information from.

input reader The input reader is in charge of reading a stream of jobdescriptions, analyzing each job and translating the JCL to aformat recognizable by GCOS, and storing the correspondingdata and JCL statements separately for scheduling andexecuting the job later.

input stream The input stream is the work that is normally submitted to theoperating system, and which consists of one or more jobdescriptions.

Glossary

47 A2 11UJ Rev04 g-3

INTRODUCED state The first job state, when a new job is translated into JCL.

IOF Interactive Operation Facility - The GCOS 7 time-sharingapplication.

JCL Translator The service job that translates a newly-submitted job intointernal form.

JCL See Job Control Language.

job Work submitted to the system.

job class A group of jobs that perform related tasks.

Job Control Language The GCOS 7 language that is used to control the execution ofjobs.

job description A set of JCL statements which supplies information aboutjobs and directs how they are run.

job enclosure A complete set of JCL statements that make up a jobdescription, starting with a $JOB statement and finishing witha $ENDJOB statement.

Job Occurrence Report A printed report that contains all system informationconcerning the execution of any job step that producesoutput.

job run The entire life of a job.

Job Scheduler Controls the system load at job level and enables you toorganize the work.

job state One phase of the life of a job.

job step A segment of a job.

JOB_OUT A printed report that contains all system informationconcerning the execution of any job step that producesoutput.

JOR See Job Occurrence Report.

library maintenance utility The utility that contains the commands used to modify andmaintain libraries.

library A file organized into a series of subfiles (members).

load module A program known to the system at execution time.

main operator The operator who manages the daily functioning of a GCOS 7system.

mandatory parameter A parameter of a command that requires a value in order forthe command to be executed.


g-4 47 A2 11UJ Rev04

master directory The first directory level in a hierarchical tree structure.

media a disk, tape or cartridge.

member A library subfile.

Multiprogramming Class Limit (MCL)The maximum number of jobs that can be simultaneouslyexecuted or suspended in a job class.

multiprogramming The environment whereby more than one job is executing atany one time.

non-resident volume A volume that is loaded on a device only when it is needed.

non-standard tape A tape without a standard label.

output library A library used for read and write operations.

output priority The order in which jobs are printed by WRITER.

OUTPUT state The job state during which the outputs of a job are printed.

Output Writer The program that controls the selection and printing ofqueued outputs for the WRITER service job.

permanent file A file created for long-term use and stored on a volume.

private catalog A catalog that holds information on the files belonging to oneproject only.

processor A group of commands that performs a specific set offunctions in GCOS 7.

project A logical group of users.

protected string A string of characters enclosed in single quotes (').

RELEASE_JOB operator commandAn operator command that puts a job from a HOLD state intothe IN SCHEDULING state.

resident volume A volume that is permanently on-line (available) to thesystem.

RJ See RELEASE_JOB operator command.

RON See Run Occurrence Number.

root The basis of a hierarchical tree structure.

Run Occurrence Number The number assigned to a job after it is submitted to thesystem.

Scheduling Priority (SPR) The order in which jobs are queued while waiting to be run.

Glossary

47 A2 11UJ Rev04 g-5

simple name Each component of the full path name of a file.

site catalog The catalog that holds information on the SITE files and on allother directories and their contents.

SL library Source Language library - a library that holds any kind oftextual information.

spooling From Simultaneous Peripheral Operations On Line; spoolingrefers to printing a document or file while allowing users towork on something else.

step Specifies the loading and execution of a program, known atexecution time as a load module.

standard labelled tape A tape that can be read on the device on which it has beenmounted, with labels conforming to the ISO/ECMA standard(for cartridges, in EBCDIC format only).

standard length half-inch tapeA half-inch cartridge tape used on 18-track device (541 to807 feet long). It is also called short tape or thick tape. It canbe used on 36-track devices as well.

step enclosure Part of a job enclosure. A typical job enclosure is made up ofone or more step enclosures.

stream reader A load module in a specific job that reads input, assigns theinput device and waits for the first record.

SUSPENDED state The job state where a job is suspended while EXECUTING.

symbolic names A special set of names (LIB, INLIB1, INLIB2, and INLIB3) thatrepresents the working libraries.

SYS.OUT The standard system file for printing job outputs.

SYSIN mechanism Allows programs that read data from a unit record inputdevice to execute concurrently without having to deal withdevice assignment problems.

System Administrator The person responsible for the technical management of aGCOS 7 system.

system catalog The catalog that holds information on System (SYS.*) files.

temporary file A file created for the duration of a job step or log-on sessiononly.

Text Editor The GCOS 7 line editor used to create and modify librarymembers.

UFAS indexed sequential fileA disk file that contains indexes used to locate records.


g-6 47 A2 11UJ Rev04

volume A disk, tape or cartridge used to save information.

volset A set of disks, tapes or cartridges used to save information

working directory The directory that contains the user's working files.

working libraries The input and output libraries that are active in the currentsession.

WRITER The service job that manages the printing of job output.

18-track cartridge Cartridge on which the 18-track recording format is used. It isalways a standard length half-inch cartridge.

18-track device A device that uses the18-track recording format to write data.It can use standard length half-inch tapes only.

36-track cartridge Cartridge on which the 36-track recording format is used. Itcan be a standard length half-inch tape or an E-tape.

36-track device A device that uses the 36-track recording format to write data.It can use standard length half-inch tapes and E-tapes.

47 A2 11UJ Rev04 i-1

Index

#

# 2-4

$

$, see dollar sign 2-1$DATA 1-2, 2-1, 4-32

BILLING 4-34CKSTAT 4-36CONTCHAR 4-36END 4-35ENDCHAR 4-35FORMAT 4-35member-name 4-34output-library-description 4-34PRINT 4-36PROJECT 4-34RECSIZE 4-36REPLACE 4-36TYPE 4-35USER 4-34

$ENDDATA 1-2, 2-1, 4-53$ENDINPUT 1-2, 2-1, 4-54

input-enclosure-name 4-54$ENDJOB 1-1, 2-1, 4-55$INPUT 1-2, 2-1, 4-62

CKSTAT 4-64, 4-70COBOL 4-66CONTCHAR 4-65, 4-68CVALUES 4-70DATA 4-66DATASSF 4-66DOLLAR 4-67END 4-67ENDCHAR 4-65, 4-67ENDINPUT 4-67EOF 4-67FORMAT 4-65, 4-66

INFILE 4-70input-enclosure-name 4-65JVALUES 4-70MATCH 4-67MEDIA=(volume-name) 4-71MEDIA=* 4-71Parameterization 4-65PRINT 4-70string8 4-67TYPE 4-66

$JOB 1-1, 2-1BILLING 4-79CLASS 4-81EXPVAL 4-82HOLD 4-81HOLDOUT 4-81HOST 4-82JOBLANG 4-82JOR 4-80LIST 4-80NSTARTUP 4-79PRIORITY 4-81PROJECT 4-79RECSIZE 4-82REPEAT 4-82

$SWINPUT 2-1, 4-127CONSOLE 4-129input-library-description 4-128sequential-input-file-description 4-128

'

', see single quotes 3-8

-

-, see Single hyphen 2-8


i-2 47 A2 11UJ Rev04

.

. (see period) 3-4

=

=, see equal sign 2-6

A

AFTER journal 1-26ALLOCATE 4-3

CHECK 4-5INCRSIZE 4-5internal-file-name 4-5SIZE 4-5UNIT 4-5

ANSI tape files 3-6ASSIGN 4-7

* 4-15ABEND 4-24ACCESS 4-21ALLREAD 4-21CAT 4-15CATALOG 4-16CATNOW 4-16DEFER 4-18DENSITY 4-28DEVCLASS 4-18device-class-description 4-18device-identification-list 4-18DIR 4-21DUMMY 4-15DVIDLIST 4-18END 4-22EXPDATE 4-16external-file-name 4-14File Concatenation 4-11FILESTAT 4-15FIRST 4-25FIRSTVOL 4-26FREE 4-21FSN 4-27input-enclosure-name 4-14internal-file-name 4-14Internal-file-names 4-12LABEL 4-26LASTVOL 4-27MEDIA 4-19MONITOR 4-21MOUNT 4-25NBEFN 4-28NEXT 4-25

NORMAL 4-20NVOLWR 4-18ONEWRITE 4-20OPTIONAL 4-18POOL 4-25READ 4-21RECOVERY 4-21RESIDENT 4-18SHARE 4-20SPREAD 4-21SPWRITE 4-21SUBFILE 4-20temporary-file-name 4-14TEMPRY 4-15, 4-16UNCAT 4-15UNLOAD 4-23VOLSET 4-20VOLWR 4-17WRITE 4-21

Automatic prefixing 3-6

B

Basic JCL statements 1-4BEFORE journal 1-26

C

CAT 3-9Checkpoint Mechanism 1-25Class attributes 1-13class load 1-13Command Interpreter 1-16COMMENT 4-30

comment-string 4-30Components of JCL Statements 2-3CONSOLE 4-31

user-name 4-31CONTINUE 2-3

D

data enclosure 1-1, 1-2DEFINE 4-38

ABORT 4-44AFTER 4-42BEFORE 4-42BLKOFF 4-49BLKSIZE 4-48BOTH 4-42BPB 4-43BSN 4-49

Index

47 A2 11UJ Rev04 i-3

BUFPOOL 4-46CHi 4-51CIFSP 4-46CISIZE 4-46CKPTLIM 4-43COLLATE 4-49COMPACT 4-46CONVERT 4-49DATACODE 4-49digits8 4-43EOF 4-52EOV 4-43ERROPT 4-44EXCL 4-47FF1 4-51FF2 4-51FILEFORM 4-48FILEORG 4-46FORMHT 4-51FPARAM 4-46FUNCMASK 4-49HOF 4-51IGNORE 4-44internal-file-name 4-42JOURNAL 4-42KEYLOC 4-45KEYSIZE 4-46LOCKMARK 4-47LTRKSIZE 4-46MARGIN 4-50MSG 4-52NBBUF 4-43NBSN 4-49NCOMPACT 4-46NCONVERT 4-49NMSG 4-52NO 4-43NONE 4-42NORMAL 4-47NPROMPT 4-52NSLEW 4-50NSYSOUT 4-44NTRNCSSF 4-45PRDEN 4-50PROMPT 4-52READLOCK 4-47RECFORM 4-48RECSIZE 4-48RETCODE 4-44SKIP 4-44SLEW 4-50STAT 4-47SYSOUT 4-44TRUNCSSF 4-45WRCHECK 4-44

Define-parameters 3-24DEVCLASS 3-11

Device attributes 3-11Device class 3-11

cartridge tape devices 3-13magnetic tape devices 3-15printer 3-15

device identification 3-1, 3-11device name 3-11, 3-16Distributed Job Processing 1-5DJP, see Distributed Job Processing 1-5dollar sign 2-1DVIDLIST 3-11

E

ENDSTEP 1-2, 4-56equal sign 2-6EXDIR 4-57EXECUTE 1-4, 4-58

PRTDEF 4-60PRTFILE 4-60PRTOUT 4-60sequential-input-file-description 4-60SIZEOPT 4-60STEPOPT 4-61VALUES 4-60

EXECUTING state 1-5Execution Priority 1-13Extended JCL statements 1-4external-file-name 3-3

F

File identification 3-1file name 3-1, 3-3File names

component 3-3length of 3-8library 3-7non-standard 3-8permanent 3-3separators 3-3temporary 3-7uncataloged 3-6

file passing 1-25file sharing 1-25file status 3-1, 3-9File types 3-1

cataloged 3-2temporary 3-2uncataloged 3-2

FILESTAT 3-9


i-4 47 A2 11UJ Rev04

G

GSORTWRK 1-4

H

HJ, see HOLD_JOB operator command: 1-6HOLD state 1-5, 1-6HOLD_JOB operator command 1-6hyphen 3-6

I

IN SCHEDULING state 1-5input enclosure 1-1, 1-2Input enclosure names 3-7Input Reader 1-8input stream 1-1, 1-3, 1-9Input-file-description 3-20Input-library-description 3-22Interactive Operation Facility (IOF) 1-5INTRODUCED state 1-5INVOKE 4-73

input-enclosure-name1 4-74input-library-description 4-74LIST=ALL 4-76member-name 4-74SYS 4-75UPDATE 4-76VALUES 4-75

IOF, see Interactive Operation Facility 1-5

J

JCL parameter substitution 1-24JCL statements 1-1

components of 2-3JCL Translator 1-10job 1-1Job class 1-12job description 1-1job enclosure 1-1Job execution 1-16Job Occurrence Report 1-10, 1-22job run 1-5Job Scheduler 1-11Job Scheduling 1-11Job selection 1-16Job state 1-5Job submitting 1-5Job Termination 1-17JOR, see Job Occurrence Report 1-10

Journalization 1-26JUMP 4-83

CONTINUE 4-84IOF 4-86label-name 4-84SEV 4-85STATUS 4-85SWi 4-85

JUMP statement 1-17

K

Keyword parameters 2-6

L

label 2-1, 2-3LET 4-90

SEV 4-91SW 4-91SWi 4-91

LIB 4-92BIN 4-94CU 4-94input-library-description 4-94LM 4-94SL 4-94

Librarymember names 3-7

Library files 3-2load module 1-2

M

Master directory 3-4maximum class load 1-13MAXLOAD, see Multiprogramming Limit 1-14MDJ, see MODIFY_JOB command 1-13MDLD, see MODIFY_LOAD command 1-13Member names 3-7MESSAGE 4-96Mini-Editor 1-24MODIFY_JOB command 1-13MODIFY_LOAD command 1-13MODVL 4-97

keyword-value-i 4-98parameter-value-i 4-98

Multifile tapes 3-7Multiprogramming Limit 1-14

Index

47 A2 11UJ Rev04 i-5

N

Non-resident volume 3-10

O

operator commands 1-25OUTPUT state 1-5, 1-6Output Writer 1-22Output-file-description 3-21Output-library-description 3-23OUTVAL 4-100

P

Parameter substitution 2-2Parameters

default values 2-7keyword 2-6positional 2-4self-identifying 2-6

period 3-4, 3-6POOL 4-102

device-class 4-103device-name 4-103MAX 4-104

Positional parameters 2-4PREFIX 4-105Print-file-description 3-21Print-library-description 3-23PRIORITY, see Scheduling priority 1-13Protected string 2-8

Q

QASSIGN 4-107ACCESS 4-109external-queue1-name 4-108IN 4-109INOUT 4-109LIN 4-109OUT 4-109REPLY 4-109RR 4-109SITE 4-109symbolic-queue-name 4-108symbolic-subqueue-name 4-108

R

RBF, see Remote Batch Facility 1-5RELEASE 4-110

Job-name 4-111PASS 4-111SWITCHES 4-111SWITCHi 4-111

RELEASE_JOB operator command 1-6Remote Batch Facility 1-5REPORT 4-112residency parameters 3-2Resident volume 3-9Restart Mechanism 1-25RJ, see RELEASE JOB operator command 1-6RON, see Run Occurrence Number 1-5RUN 1-4, 4-113

CLASS 4-116DELETE 4-117HOLD 4-116HOLDOUT 4-116INDEF 4-115INDEFi 4-115INFILEi 4-115JOBS 4-116PASS 4-117PRIORITY 4-116SWITCHES 4-117SWITCHi 4-117VALUES 4-117

Run Occurrence Number 1-5

S

Scheduler Queue 1-11Scheduling Priority 1-13Self-identifying parameters 2-6Semicolon 2-1SEND 4-119

'string105' 4-120MAIN 4-120user-name 4-120

Sequential-input-file-description 3-19Sequential-output-file-description 3-20service job 1-19Single hyphen 2-8single quotes 3-8SIZE 4-121

CHPPAGE 4-122declared-working-set 4-122NBBUF 4-122POOLSIZE 4-122

Size-parameters 3-24SORTWORK 1-4Space 2-2


i-6 47 A2 11UJ Rev04

Spooling 1-20Standard parameter groups 3-17statement name 2-1, 2-3STEP 1-2, 4-123

CPTIME 4-125DEBUG 4-125DUMP 4-125ELAPTIME 4-125input-library-description 4-124LINES 4-125load-module-name 4-124MAXMEM 4-126MINMEM 4-126OPTIONS 4-126REPEAT 4-126XPRTY 4-124

step 1-2step enclosure 1-1, 1-2Step execution 1-16Step initiation 1-16Step Number 1-5step termination 1-17Step-parameters 3-24Stored JCL 1-24Stream Reader 1-8, 2-1SUSPENDED state 1-5, 1-6SYS.IN 1-21SYS.OUT 1-22SYSIN files 3-2SYSIN mechanism 1-21SYSIN system file 1-21SYSOUT 4-130

BANINF 4-135BANLEVEL 4-135BANNER 4-135CLASS 4-132COPIES 4-136DELETE 4-137DEST 4-136DEVCLASS 4-136HOLD 4-134internal-file-name 4-132JOB 4-133MEDIA 4-136NAME 4-135NBANNER 4-135NDELETE 4-137NHOLD 4-134NSLEW 4-137Permanent SYSOUT Files 4-131PRIORITY 4-133SLEW 4-136Standard SYSOUT Files 4-131STEP 4-134WHEN 4-133

SYSOUT file 1-22permanent 1-22

standard 1-22SYSOUT format 1-23SYSOUT mechanism 1-23Sysout-parameters 3-24

T

TEMPRY 3-9

U

UNCAT 3-9uncataloged file 3-6

V

VALUES 4-138keyword-value 4-139parameter-value 4-139

Volume identification 3-9volume name 3-1, 3-10volume name (non-standard) 3-10

W

Work-file-description 3-21WRITER 4-140

ALL 4-145ASA 4-144COPIES 4-144DATAFORM 4-144DOF 4-144FPARAM 4-145IMMED 4-144JOB 4-144NFPARAM 4-145NUMBER 4-145PART 4-143PRINTER 4-146printer-options 4-146REPORT 4-145SARF 4-144SELECT 4-144SSF 4-144SUBFILE 4-143WHEN 4-144

X

XPRTY, see Execution Priority 1-13

Technical publication remarks form

Title : DPS7000/XTA NOVASCALE 7000 JCL Reference Manual Job Control and IOF

Reference Nº : 47 A2 11UJ 04 Date : December 1997

ERRORS IN PUBLICATION

SUGGESTIONS FOR IMPROVEMENT TO PUBLICATION

Your comments will be promptly investigated by qualified technical personnel and action will be taken as required.If you require a written reply, please include your complete mailing address below.

NAME : Date :

COMPANY :

ADDRESS :

Please give this technical publication remarks form to your BULL representative or mail to:

Bull - Documentation Dept.

1 Rue de ProvenceBP 20838432 ECHIROLLES [email protected]

Technical publications ordering form

To order additional publications, please fill in a copy of this form and send it via mail to:

BULL CEDOC357 AVENUE PATTONB.P.2084549008 ANGERS CEDEX 01FRANCE

Phone: +33 (0) 2 41 73 72 66FAX: +33 (0) 2 41 73 70 66E-Mail: [email protected]

CEDOC Reference # Designation Qty

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

_ _ _ _ _ _ _ _ _ [ _ _ ]

[ _ _ ] : The latest revision will be provided if no revision number is given.

NAME: Date:

COMPANY:

ADDRESS:

PHONE: FAX:

E-MAIL:

For Bull Subsidiaries:

Identification:

For Bull Affiliated Customers:

Customer Code:

For Bull Internal Customers:

Budgetary Section:

For Others: Please ask your Bull representative.

BULL CEDOC

357 AVENUE PATTON

B.P.20845

49008 ANGERS CEDEX 01

FRANCE

47 A2 11UJ 04REFERENCE